From: chleun.moon Date: Mon, 21 Aug 2017 01:51:51 +0000 (+0900) Subject: [Connection] Review Connection API cs files X-Git-Tag: submit/trunk/20170823.075128~25^2 X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=f08982c624ec87aa7cc91c983b69b9a29f0f5e32;p=platform%2Fcore%2Fcsapi%2Ftizenfx.git [Connection] Review Connection API cs files PS1: Edited mismatched indentaion in doxygen tag. PS5: Restored unchanged files. PS6: Remove \r Change-Id: I05dc28b9f9f33f9d4e86bb35a511169745ca3d0a --- diff --git a/src/Tizen.Network.Connection/Tizen.Network.Connection/CellularProfile.cs b/src/Tizen.Network.Connection/Tizen.Network.Connection/CellularProfile.cs index 86658a2e3..a9bff16d2 100755 --- a/src/Tizen.Network.Connection/Tizen.Network.Connection/CellularProfile.cs +++ b/src/Tizen.Network.Connection/Tizen.Network.Connection/CellularProfile.cs @@ -23,7 +23,7 @@ using System.Runtime.InteropServices; namespace Tizen.Network.Connection { /// - /// This Class is CellularProfile. It provides functions to manage the cellular profile. + /// This is the CellularProfile class. It provides functions to manage the cellular profile. /// /// 3 public class CellularProfile : ConnectionProfile @@ -43,11 +43,11 @@ namespace Tizen.Network.Connection /// /// 3 /// Cellular access point name. - /// Thrown during set when feature is not supported. - /// Thrown during set when value is invalid parameter. - /// Thrown during set when value is null. - /// Thrown during set when profile instance is invalid or when method failed due to invalid operation. - /// Thrown when operation is performed on a disposed object. + /// Thrown during set when a feature is not supported. + /// Thrown during set when a value is an invalid parameter. + /// Thrown during set when a value is null. + /// Thrown during set when a profile instance is invalid or when a method fails due to an invalid operation. + /// Thrown when an operation is performed on a disposed object. public string Apn { get @@ -92,11 +92,11 @@ namespace Tizen.Network.Connection /// /// 3 /// Cellular home URL. - /// Thrown during set when feature is not supported. - /// Thrown during set when value is invalid parameter. - /// Thrown during set when value is null. - /// Thrown during set when profile instance is invalid or when method failed due to invalid operation. - /// Thrown when operation is performed on a disposed object. + /// Thrown during set when a feature is not supported. + /// Thrown during set when a value is an invalid parameter. + /// Thrown during set when a value is null. + /// Thrown during set when a profile instance is invalid or when a method fails due to an invalid operation. + /// Thrown when an operation is performed on a disposed object. public string HomeUri { get @@ -141,10 +141,10 @@ namespace Tizen.Network.Connection /// /// 3 /// Cellular service type. - /// Thrown during set when feature is not supported. - /// Thrown during set when value is invalid parameter. - /// Thrown during set when profile instance is invalid or when method failed due to invalid operation. - /// Thrown when operation is performed on a disposed object. + /// Thrown during set when a feature is not supported. + /// Thrown during set when a value is an invalid parameter. + /// Thrown during set when a profile instance is invalid or when a method fails due to an invalid operation. + /// Thrown when an operation is performed on a disposed object. public CellularServiceType ServiceType { get @@ -179,10 +179,10 @@ namespace Tizen.Network.Connection /// /// 3 /// Cellular pdn type. - /// Thrown during set when feature is not supported. - /// Thrown during set when value is invalid parameter. - /// Thrown during set when profile instance is invalid or when method failed due to invalid operation. - /// Thrown when operation is performed on a disposed object. + /// Thrown during set when a feature is not supported. + /// Thrown during set when a value is an invalid parameter. + /// Thrown during set when a profile instance is invalid or when a method fails due to an invalid operation. + /// Thrown when an operation is performed on a disposed object. public CellularPdnType PdnType { get @@ -217,10 +217,10 @@ namespace Tizen.Network.Connection /// /// 3 /// Cellular roaming pdn type. - /// Thrown during set when feature is not supported. - /// Thrown during set when value is invalid parameter. - /// Thrown during set when profile instance is invalid or when method failed due to invalid operation. - /// Thrown when operation is performed on a disposed object. + /// Thrown during set when a feature is not supported. + /// Thrown during set when a value is an invalid parameter. + /// Thrown during set when a profile instance is invalid or when a method fails due to an invalid operation. + /// Thrown when a operation is performed on a disposed object. public CellularPdnType RoamingPdnType { get @@ -251,15 +251,15 @@ namespace Tizen.Network.Connection } /// - /// Cellular Authentication Information. + /// The cellular authentication information. /// /// 3 /// Instance of CellularAuthInformation. - /// Thrown during set when feature is not supported. - /// Thrown during set when value is invalid parameter. - /// Thrown during set when value is null. - /// Thrown during set when profile instance is invalid or when method failed due to invalid operation. - /// Thrown when operation is performed on a disposed object. + /// Thrown during set when a feature is not supported. + /// Thrown during set when a value is an invalid parameter. + /// Thrown during set when a value is null. + /// Thrown during set when a profile instance is invalid or when a method fails due to an invalid operation. + /// Thrown when an operation is performed on a disposed object. public CellularAuthInformation CellularAuthInfo { get @@ -367,13 +367,13 @@ namespace Tizen.Network.Connection } /// - /// This Class is CellularAuthInformation. It provides the properties to get and set the cellular authentication information. + /// This is the CellularAuthInformation class. It provides the properties to get and set the cellular authentication information. /// /// 3 public class CellularAuthInformation { /// - /// Default Constructor.Initializes an object of CellularAuthInformation. + /// Default constructor. Initializes an object of the CellularAuthInformation. /// public CellularAuthInformation() { @@ -381,19 +381,19 @@ namespace Tizen.Network.Connection /// /// The user name. - /// 3 /// + /// 3 /// Cellular user name. public string UserName { get; set;} /// - /// The password + /// The password. /// /// 3 /// Cellular password. public string Password { get; set; } /// - /// The authentication type + /// The authentication type. /// /// 3 /// Cellular authentication type. diff --git a/src/Tizen.Network.Connection/Tizen.Network.Connection/ConnectionManager.cs b/src/Tizen.Network.Connection/Tizen.Network.Connection/ConnectionManager.cs index 0b574b54b..2d37dab69 100755 --- a/src/Tizen.Network.Connection/Tizen.Network.Connection/ConnectionManager.cs +++ b/src/Tizen.Network.Connection/Tizen.Network.Connection/ConnectionManager.cs @@ -23,7 +23,7 @@ using System.Threading.Tasks; using System.Runtime.InteropServices; /// -/// The Connection API provides functions, enumerations to get the status of network and current profile and manage profiles. +/// The Connection API provides functions and enumerations to get the status of network and current profile and manages profiles. /// namespace Tizen.Network.Connection { @@ -61,7 +61,7 @@ namespace Tizen.Network.Connection } /// - /// This class is ConnectionManager. It provides functions to manage data connections. + /// This is the ConnectionManager class. It provides functions to manage data connections. /// /// 3 public static class ConnectionManager @@ -69,7 +69,7 @@ namespace Tizen.Network.Connection private static ConnectionItem _currentConnection = null; /// - /// Event that is called when the type of the current connection is changed. + /// An event is called when the type of the current connection is changed. /// /// 3 /// http://tizen.org/privilege/network.get @@ -91,7 +91,7 @@ namespace Tizen.Network.Connection } /// - /// Event for ethernet cable is plugged [in/out] event. + /// An event for the ethernet cable is plugged [in/out] event. /// /// 3 /// http://tizen.org/privilege/network.get @@ -110,7 +110,7 @@ namespace Tizen.Network.Connection } /// - /// Event that is called when the IP address is changed. + /// An event is called when the IP address is changed. /// /// 3 /// http://tizen.org/privilege/network.get @@ -132,7 +132,7 @@ namespace Tizen.Network.Connection } /// - /// Event that is called when the proxy address is changed. + /// An event is called when the proxy address is changed. /// /// 3 /// http://tizen.org/privilege/network.get @@ -157,7 +157,7 @@ namespace Tizen.Network.Connection /// Gets the connection handle. /// /// 3 - /// Instance of SafeConnectionHandle + /// Instance of SafeConnectionHandle. [EditorBrowsable(EditorBrowsableState.Never)] public static SafeConnectionHandle GetConnectionHandle() { @@ -169,39 +169,39 @@ namespace Tizen.Network.Connection /// Gets the IP address of the current connection. /// /// 3 - /// The address family + /// The address family. /// IP address of the connection (global address in case of IPv6). /// http://tizen.org/privilege/network.get /// http://tizen.org/feature/network.ethernet /// http://tizen.org/feature/network.telephony /// http://tizen.org/feature/network.tethering.bluetooth /// http://tizen.org/feature/network.wifi - /// Thrown when feature is not supported. - /// Thrown when permission is denied. - /// Thrown when value is invalid parameter. + /// Thrown when a feature is not supported. + /// Thrown when a permission is denied. + /// Thrown when a value is an invalid parameter. /// Thrown when memory is not enough to continue execution. - /// Thrown when connection instance is invalid or when method failed due to invalid operation. + /// Thrown when a connection instance is invalid or when a method fails due to an invalid operation. public static System.Net.IPAddress GetIPAddress(AddressFamily family) { return ConnectionInternalManager.Instance.GetIPAddress(family); } /// - /// Gets the all IPv6 addresses of the current connection. + /// Gets all the IPv6 addresses of the current connection. /// /// 3 - /// The type of current network connection + /// The type of current network connection. /// A list of IPv6 addresses of the connection. /// http://tizen.org/privilege/network.get /// http://tizen.org/feature/network.ethernet /// http://tizen.org/feature/network.telephony /// http://tizen.org/feature/network.tethering.bluetooth /// http://tizen.org/feature/network.wifi - /// Thrown when feature is not supported. - /// Thrown when permission is denied. - /// Thrown when value is invalid parameter. + /// Thrown when a feature is not supported. + /// Thrown when a permission is denied. + /// Thrown when a value is an invalid parameter. /// Thrown when memory is not enough to continue execution. - /// Thrown when connection instance is invalid or when method failed due to invalid operation. + /// Thrown when a connection instance is invalid or when a method fails due to an invalid operation. public static IEnumerable GetAllIPv6Addresses(ConnectionType type) { return ConnectionInternalManager.Instance.GetAllIPv6Addresses(type); @@ -211,18 +211,18 @@ namespace Tizen.Network.Connection /// Gets the proxy address of the current connection. /// /// 3 - /// The address family + /// The address family. /// Proxy address of the connection. /// http://tizen.org/privilege/network.get /// http://tizen.org/feature/network.ethernet /// http://tizen.org/feature/network.telephony /// http://tizen.org/feature/network.tethering.bluetooth /// http://tizen.org/feature/network.wifi - /// Thrown when feature is not supported. - /// Thrown when permission is denied. - /// Thrown when value is invalid parameter. + /// Thrown when a feature is not supported. + /// Thrown when a permission is denied. + /// Thrown when a value is an invalid parameter. /// Thrown when memory is not enough to continue execution. - /// Thrown when connection instance is invalid or when method failed due to invalid operation. + /// Thrown when a connection instance is invalid or when a method fails due to an invalid operation. public static string GetProxy(AddressFamily family) { return ConnectionInternalManager.Instance.GetProxy(family); @@ -232,18 +232,18 @@ namespace Tizen.Network.Connection /// Gets the MAC address of the Wi-Fi or ethernet. /// /// 3 - /// The type of current network connection + /// The type of current network connection. /// MAC address of the Wi-Fi or ethernet. /// http://tizen.org/privilege/network.get /// http://tizen.org/feature/network.ethernet /// http://tizen.org/feature/network.telephony /// http://tizen.org/feature/network.tethering.bluetooth /// http://tizen.org/feature/network.wifi - /// Thrown when feature is not supported. - /// Thrown when permission is denied. - /// Thrown when value is invalid parameter. + /// Thrown when a feature is not supported. + /// Thrown when a permission is denied. + /// Thrown when value is an invalid parameter. /// Thrown when memory is not enough to continue execution. - /// Thrown when connection instance is invalid or when method failed due to invalid operation. + /// Thrown when a connection instance is invalid or when a method fails due to an invalid operation. public static string GetMacAddress(ConnectionType type) { return ConnectionInternalManager.Instance.GetMacAddress(type); @@ -253,19 +253,19 @@ namespace Tizen.Network.Connection /// Gets the statistics information. /// /// 3 - /// The type of connection (only WiFi and Cellular are supported) - /// The type of statistics - /// The statistics information associated with statisticsType + /// The type of connection (only WiFi and Cellular are supported). + /// The type of statistics. + /// The statistics information associated with statisticsType. /// http://tizen.org/privilege/network.get /// http://tizen.org/feature/network.ethernet /// http://tizen.org/feature/network.telephony /// http://tizen.org/feature/network.tethering.bluetooth /// http://tizen.org/feature/network.wifi - /// Thrown when feature is not supported. - /// Thrown when permission is denied. - /// Thrown when value is invalid parameter. + /// Thrown when a feature is not supported. + /// Thrown when a permission is denied. + /// Thrown when value is an invalid parameter. /// Thrown when memory is not enough to continue execution. - /// Thrown when connection instance is invalid or when method failed due to invalid operation. + /// Thrown when a connection instance is invalid or when a method fails due to invalid operation. public static long GetStatistics(ConnectionType connectionType, StatisticsType statisticsType) { return ConnectionInternalManager.Instance.GetStatistics(connectionType, statisticsType); @@ -275,19 +275,19 @@ namespace Tizen.Network.Connection /// Resets the statistics information. /// /// 3 - /// The type of connection (only WiFi and Cellular are supported) - /// The type of statistics + /// The type of connection (only WiFi and Cellular are supported). + /// The type of statistics. /// http://tizen.org/privilege/network.get /// http://tizen.org/privilege/network.set /// http://tizen.org/feature/network.ethernet /// http://tizen.org/feature/network.telephony /// http://tizen.org/feature/network.tethering.bluetooth /// http://tizen.org/feature/network.wifi - /// Thrown when feature is not supported. - /// Thrown when permission is denied. - /// Thrown when value is invalid parameter. + /// Thrown when a feature is not supported. + /// Thrown when a permission is denied. + /// Thrown when a value is an invalid parameter. /// Thrown when memory is not enough to continue execution. - /// Thrown when connection instance is invalid or when method failed due to invalid operation. + /// Thrown when a connection instance is invalid or when a method fails due to an invalid operation. public static void ResetStatistics(ConnectionType connectionType, StatisticsType statisticsType) { ConnectionInternalManager.Instance.ResetStatistics(connectionType, statisticsType); @@ -296,22 +296,22 @@ namespace Tizen.Network.Connection /// /// Adds a route to the routing table. /// - /// The address family - /// The name of network interface - /// The IP address of the host - /// The gateway address + /// The address family. + /// The name of the network interface. + /// The IP address of the host. + /// The gateway address. /// http://tizen.org/privilege/network.get /// http://tizen.org/privilege/network.set /// http://tizen.org/feature/network.telephony /// http://tizen.org/feature/network.wifi /// http://tizen.org/feature/network.tethering.bluetooth /// http://tizen.org/feature/network.ethernet - /// Thrown when feature is not supported. - /// Thrown when permission is denied. - /// Thrown when value is invalid parameter. - /// Thrown when interfaceName or hostAddress or gateway is null. + /// Thrown when a feature is not supported. + /// Thrown when a permission is denied. + /// Thrown when a value is an invalid parameter. + /// Thrown when an interfaceName or a hostAddress or a gateway is null. /// Thrown when memory is not enough to continue execution. - /// Thrown when connection instance is invalid or when method failed due to invalid operation. + /// Thrown when a connection instance is invalid or when a method fails due to an invalid operation. public static void AddRoute(AddressFamily family, string interfaceName, System.Net.IPAddress hostAddress, System.Net.IPAddress gateway) { ConnectionInternalManager.Instance.AddRoute(family, interfaceName, hostAddress, gateway); @@ -320,32 +320,32 @@ namespace Tizen.Network.Connection /// /// Removes a route from the routing table. /// - /// The address family - /// The name of network interface - /// The IP address of the host - /// The gateway address + /// The address family. + /// The name of network interface. + /// The IP address of the host. + /// The gateway address. /// http://tizen.org/privilege/network.get /// http://tizen.org/privilege/network.set /// http://tizen.org/feature/network.telephony /// http://tizen.org/feature/network.wifi /// http://tizen.org/feature/network.tethering.bluetooth /// http://tizen.org/feature/network.ethernet - /// Thrown when feature is not supported. - /// Thrown when permission is denied. - /// Thrown when value is invalid parameter. - /// Thrown when interfaceName or hostAddress or gateway is null. + /// Thrown when a feature is not supported. + /// Thrown when a permission is denied. + /// Thrown when a value is an invalid parameter. + /// Thrown when an interfaceName or a hostAddress or a gateway is null. /// Thrown when memory is not enough to continue execution. - /// Thrown when connection instance is invalid or when method failed due to invalid operation. + /// Thrown when a connection instance is invalid or when a method fails due to an invalid operation. public static void RemoveRoute(AddressFamily family, string interfaceName, System.Net.IPAddress hostAddress, System.Net.IPAddress gateway) { ConnectionInternalManager.Instance.RemoveRoute(family, interfaceName, hostAddress, gateway); } /// - /// Type and state of the current profile for data connection + /// The type and state of the current profile for data connection. /// /// 3 - /// Instance of ConnectionItem + /// Instance of ConnectionItem. public static ConnectionItem CurrentConnection { get @@ -365,15 +365,15 @@ namespace Tizen.Network.Connection /// 3 /// The type of profile. Cellular profile type is supported. /// The keyword included in profile name. - /// CellularProfile object + /// CellularProfile object. /// http://tizen.org/privilege/network.get /// http://tizen.org/feature/network.telephony /// http://tizen.org/feature/network.wifi - /// Thrown when feature is not supported. - /// Thrown when permission is denied. - /// Thrown when value is invalid parameter. - /// Thrown when keyword value is null. - /// Thrown when method failed due to invalid operation. + /// Thrown when a feature is not supported. + /// Thrown when a permission is denied. + /// Thrown when a value is an invalid parameter. + /// Thrown when a keyword value is null. + /// Thrown when a method fails due to invalid operation. public static CellularProfile CreateCellularProfile(ConnectionProfileType type, string keyword) { IntPtr profileHandle = IntPtr.Zero; @@ -392,7 +392,7 @@ namespace Tizen.Network.Connection } /// - /// The state of cellular connection. + /// The state of the cellular connection. /// /// 3 /// Cellular network state. @@ -406,7 +406,7 @@ namespace Tizen.Network.Connection } /// - /// The state of the Wi-Fi. + /// The state of the Wi-Fi connection. /// /// 3 /// WiFi connection state. @@ -420,7 +420,7 @@ namespace Tizen.Network.Connection } /// - /// The state of the Bluetooth. + /// The state of the Bluetooth connection. /// /// 3 /// Bluetooth connection state. @@ -448,7 +448,7 @@ namespace Tizen.Network.Connection } /// - /// Checks for ethernet cable is attached or not. + /// Checks if the ethernet cable is attached or not. /// /// 3 /// Ethernet cable state. @@ -464,7 +464,7 @@ namespace Tizen.Network.Connection } // class ConnectionManager /// - /// This class contains connection information such as connection type and state. + /// This class contains connection information, such as connection type and state. /// /// 3 public class ConnectionItem @@ -531,7 +531,7 @@ namespace Tizen.Network.Connection } // class ConnectionItem /// - /// An extended EventArgs class which contains changed connection type. + /// An extended EventArgs class, which contains changed connection type. /// /// 3 public class ConnectionTypeEventArgs : EventArgs @@ -558,7 +558,7 @@ namespace Tizen.Network.Connection } /// - /// An extended EventArgs class which contains changed ethernet cable state. + /// An extended EventArgs class, which contains changed ethernet cable state. /// /// 3 public class EthernetCableStateEventArgs : EventArgs @@ -585,7 +585,7 @@ namespace Tizen.Network.Connection } /// - /// An extended EventArgs class which contains changed address. + /// An extended EventArgs class, which contains changed address. /// /// 3 public class AddressEventArgs : EventArgs @@ -600,10 +600,10 @@ namespace Tizen.Network.Connection } /// - /// The IPV4 address. + /// The IPV4 address. /// /// 3 - /// IP address in the format of IPV4 syntax. + /// IP address in the format of the IPV4 syntax. public string IPv4Address { get @@ -613,10 +613,10 @@ namespace Tizen.Network.Connection } /// - /// The IPV6 address. + /// The IPV6 address. /// /// 3 - /// IP address in the format of IPV6 syntax. + /// IP address in the format of the IPV6 syntax. public string IPv6Address { get diff --git a/src/Tizen.Network.Connection/Tizen.Network.Connection/ConnectionProfile.cs b/src/Tizen.Network.Connection/Tizen.Network.Connection/ConnectionProfile.cs index 87fc8a201..e7ceabd95 100755 --- a/src/Tizen.Network.Connection/Tizen.Network.Connection/ConnectionProfile.cs +++ b/src/Tizen.Network.Connection/Tizen.Network.Connection/ConnectionProfile.cs @@ -23,7 +23,7 @@ using System.Runtime.InteropServices; namespace Tizen.Network.Connection { /// - /// This Class is ConnectionProfile. It provides event and propeties of the connection profile. + /// This is the ConnectionProfile class. It provides event and propeties of the connection profile. /// /// 3 public class ConnectionProfile : IDisposable @@ -42,7 +42,7 @@ namespace Tizen.Network.Connection } /// - /// The event that is called when the state of profile is changed. + /// The event is called when the state of profile is changed. /// /// 3 /// http://tizen.org/feature/network.ethernet @@ -223,7 +223,7 @@ namespace Tizen.Network.Connection /// The name of the network interface. /// /// 3 - /// Network interface name, e.g. eth0 and pdp0. + /// Network interface name, for example, eth0 and pdp0. public string InterfaceName { get @@ -249,11 +249,11 @@ namespace Tizen.Network.Connection /// http://tizen.org/feature/network.telephony /// http://tizen.org/feature/network.tethering.bluetooth /// http://tizen.org/feature/network.wifi - /// Thrown when feature is not supported. - /// Thrown when permission is denied. - /// Thrown when value is invalid parameter. - /// Thrown when profile instance is invalid or when method failed due to invalid operation - /// Thrown when operation is performed on a disposed object. + /// Thrown when a feature is not supported. + /// Thrown when a permission is denied. + /// Thrown when a value is an invalid parameter. + /// Thrown when a profile instance is invalid or when a method fails due to an invalid operation. + /// Thrown when an operation is performed on a disposed object. public void Refresh() { CheckDisposed(); @@ -269,19 +269,19 @@ namespace Tizen.Network.Connection } /// - /// Get the network state. + /// Gets the network state. /// /// 3 - /// The address family + /// The address family. /// The network state. /// http://tizen.org/feature/network.ethernet /// http://tizen.org/feature/network.telephony /// http://tizen.org/feature/network.tethering.bluetooth /// http://tizen.org/feature/network.wifi - /// Thrown when feature is not supported. - /// Thrown when value is invalid parameter. - /// Thrown when profile instance is invalid or when method failed due to invalid operation - /// Thrown when operation is performed on a disposed object. + /// Thrown when a feature is not supported. + /// Thrown when a value is an invalid parameter. + /// Thrown when a profile instance is invalid or when a method fails due to an invalid operation. + /// Thrown when an operation is performed on a disposed object. public ProfileState GetState(AddressFamily family) { CheckDisposed(); @@ -313,10 +313,10 @@ namespace Tizen.Network.Connection /// /// 3 /// Proxy type of the connection. - /// Thrown during set when feature is not supported. - /// Thrown during set when value is invalid parameter. - /// Thrown during set when profile instance is invalid or when method failed due to invalid operation. - /// Thrown during set when operation is performed on a disposed object. + /// Thrown during set when a feature is not supported. + /// Thrown during set when a value is an invalid parameter. + /// Thrown during set when a profile instance is invalid or when a method fails due to an invalid operation. + /// Thrown during set when a operation is performed on a disposed object. public ProxyType ProxyType { get @@ -350,11 +350,11 @@ namespace Tizen.Network.Connection /// /// 3 /// Proxy address of the connection. - /// Thrown during set when feature is not supported. - /// Thrown during set when value is invalid parameter. - /// Thrown during set when value is null. - /// Thrown during set when profile instance is invalid or when method failed due to invalid operation. - /// Thrown when operation is performed on a disposed object. + /// Thrown during set when a feature is not supported. + /// Thrown during set when a value is an invalid parameter. + /// Thrown during set when a value is null. + /// Thrown during set when a profile instance is invalid or when a method fails due to an invalid operation. + /// Thrown when an operation is performed on a disposed object. public string ProxyAddress { get @@ -394,7 +394,7 @@ namespace Tizen.Network.Connection } /// - /// The address information (IPv4) + /// The address information (IPv4). /// /// 3 /// Instance of IAddressInformation with IPV4 address. @@ -408,7 +408,7 @@ namespace Tizen.Network.Connection } /// - /// The address information (IPv6) + /// The address information (IPv6). /// /// 3 /// Instance of IAddressInformation with IPV6 address. @@ -422,7 +422,7 @@ namespace Tizen.Network.Connection } /// - /// An extended EventArgs class which contains changed profile state. + /// An extended EventArgs class, which contains changed profile state. /// /// 3 public class ProfileStateEventArgs : EventArgs diff --git a/src/Tizen.Network.Connection/Tizen.Network.Connection/ConnectionProfileManager.cs b/src/Tizen.Network.Connection/Tizen.Network.Connection/ConnectionProfileManager.cs index 5049686fd..e205c4875 100755 --- a/src/Tizen.Network.Connection/Tizen.Network.Connection/ConnectionProfileManager.cs +++ b/src/Tizen.Network.Connection/Tizen.Network.Connection/ConnectionProfileManager.cs @@ -24,28 +24,28 @@ using System.Collections; namespace Tizen.Network.Connection { /// - /// This class is ConnectionProfileManager. It provides functions to add, get, connect or modify the connection profile. + /// This is the ConnectionProfileManager class. It provides functions to add, get, connect, or modify the connection profile. /// /// 3 public static class ConnectionProfileManager { /// - /// Adds a new profile + /// Adds a new profile. /// /// 3 - /// The cellular profile object + /// The cellular profile object. /// http://tizen.org/privilege/network.profile /// http://tizen.org/privilege/network.get /// http://tizen.org/feature/network.telephony /// http://tizen.org/feature/network.wifi /// http://tizen.org/feature/network.tethering.bluetooth /// http://tizen.org/feature/network.ethernet - /// Thrown when feature is not supported. - /// Thrown when permission is denied. - /// Thrown when value is invalid parameter. - /// Thrown when value is null. + /// Thrown when a feature is not supported. + /// Thrown when a permission is denied. + /// Thrown when a value is an invalid parameter. + /// Thrown when a value is null. /// Thrown when memory is not enough to continue execution. - /// Thrown when connection or profile instance is invalid or when method failed due to invalid operation + /// Thrown when connection or profile instance is invalid or when a method fails due to an invalid operation. public static void AddCellularProfile(CellularProfile profile) { Log.Debug(Globals.LogTag, "AddCellularProfile"); @@ -53,21 +53,21 @@ namespace Tizen.Network.Connection } /// - /// Gets the list of profile with profile list type + /// Gets the list of the profile with the profile list type. /// /// 3 - /// The type of profile + /// The type of profile. /// List of connection profile objects. /// http://tizen.org/privilege/network.get /// http://tizen.org/feature/network.telephony /// http://tizen.org/feature/network.wifi /// http://tizen.org/feature/network.tethering.bluetooth /// http://tizen.org/feature/network.ethernet - /// Thrown when feature is not supported. - /// Thrown when permission is denied. - /// Thrown when value is invalid parameter. + /// Thrown when a feature is not supported. + /// Thrown when a permission is denied. + /// Thrown when value is an invalid parameter. /// Thrown when memory is not enough to continue execution. - /// Thrown when connection instance has been disposed. + /// Thrown when a connection instance has been disposed. public static Task> GetProfileListAsync(ProfileListType type) { Log.Debug(Globals.LogTag, "GetProfileListAsync"); @@ -75,10 +75,10 @@ namespace Tizen.Network.Connection } /// - /// Opens a connection of profile, asynchronously. + /// Opens a connection of profile asynchronously. /// /// 3 - /// The connection profile object + /// The connection profile object. /// A task indicates whether the ConnectProfileAsync method is done successfully or not. /// http://tizen.org/privilege/network.get /// http://tizen.org/privilege/network.set @@ -86,12 +86,12 @@ namespace Tizen.Network.Connection /// http://tizen.org/feature/network.wifi /// http://tizen.org/feature/network.tethering.bluetooth /// http://tizen.org/feature/network.ethernet - /// Thrown when feature is not supported. - /// Thrown when permission is denied. - /// Thrown when value is invalid parameter. - /// Thrown when value is null. + /// Thrown when a feature is not supported. + /// Thrown when a permission is denied. + /// Thrown when value is an invalid parameter. + /// Thrown when a value is null. /// Thrown when memory is not enough to continue execution. - /// Thrown when connection or profile instance is invalid or when method failed due to invalid operation + /// Thrown when a connection or a profile instance is invalid or when a method fails due to an invalid operation. public static Task ConnectProfileAsync(ConnectionProfile profile) { Log.Debug(Globals.LogTag, "ConnectProfile"); @@ -102,7 +102,7 @@ namespace Tizen.Network.Connection /// Closes a connection of profile. /// /// 3 - /// The connection profile object + /// The connection profile object. /// A task indicates whether the DisconnectProfileAsync method is done successfully or not. /// http://tizen.org/privilege/network.get /// http://tizen.org/privilege/network.set @@ -110,12 +110,12 @@ namespace Tizen.Network.Connection /// http://tizen.org/feature/network.wifi /// http://tizen.org/feature/network.tethering.bluetooth /// http://tizen.org/feature/network.ethernet - /// Thrown when feature is not supported. - /// Thrown when permission is denied. - /// Thrown when value is invalid parameter. - /// Thrown when value is null. + /// Thrown when a feature is not supported. + /// Thrown when a permission is denied. + /// Thrown when a value is an invalid parameter. + /// Thrown when a value is null. /// Thrown when memory is not enough to continue execution. - /// Thrown when connection or profile instance is invalid or when method failed due to invalid operation + /// Thrown when a connection or a profile instance is invalid or when a method fails due to invalid operation. public static Task DisconnectProfileAsync(ConnectionProfile profile) { Log.Debug(Globals.LogTag, "DisconnectProfileAsync"); @@ -126,19 +126,19 @@ namespace Tizen.Network.Connection /// Removes an existing profile. /// /// 3 - /// The connection profile object + /// The connection profile object. /// http://tizen.org/privilege/network.get /// http://tizen.org/privilege/network.profile /// http://tizen.org/feature/network.telephony /// http://tizen.org/feature/network.wifi /// http://tizen.org/feature/network.tethering.bluetooth /// http://tizen.org/feature/network.ethernet - /// Thrown when feature is not supported. - /// Thrown when permission is denied. - /// Thrown when value is invalid parameter. - /// Thrown when value is null. + /// Thrown when a feature is not supported. + /// Thrown when a permission is denied. + /// Thrown when value is an invalid parameter. + /// Thrown when a value is null. /// Thrown when memory is not enough to continue execution. - /// Thrown when connection or profile instance is invalid or when method failed due to invalid operation + /// Thrown when a connection or a profile instance is invalid or when a method fails due to invalid operation. public static void RemoveProfile(ConnectionProfile profile) { Log.Debug(Globals.LogTag, "RemoveProfile. Id: " + profile.Id + ", Name: " + profile.Name + ", Type: " + profile.Type); @@ -151,19 +151,19 @@ namespace Tizen.Network.Connection /// When you call this function, your changes affect the ConnectionProfileManager and the existing profile is updated. /// /// 3 - /// The connection profile object + /// The connection profile object. /// http://tizen.org/privilege/network.get /// http://tizen.org/privilege/network.profile /// http://tizen.org/feature/network.telephony /// http://tizen.org/feature/network.wifi /// http://tizen.org/feature/network.tethering.bluetooth /// http://tizen.org/feature/network.ethernet - /// Thrown when feature is not supported. - /// Thrown when permission is denied. - /// Thrown when value is invalid parameter. - /// Thrown when value is null. + /// Thrown when a feature is not supported. + /// Thrown when a permission is denied. + /// Thrown when a value is an invalid parameter. + /// Thrown when a value is null. /// Thrown when memory is not enough to continue execution. - /// Thrown when connection or profile instance is invalid or when method failed due to invalid operation + /// Thrown when a connection or a profile instance is invalid or when a method fails due to an invalid operation. public static void UpdateProfile(ConnectionProfile profile) { Log.Debug(Globals.LogTag, "UpdateProfile"); @@ -180,11 +180,11 @@ namespace Tizen.Network.Connection /// http://tizen.org/feature/network.wifi /// http://tizen.org/feature/network.tethering.bluetooth /// http://tizen.org/feature/network.ethernet - /// Thrown when feature is not supported. - /// Thrown when permission is denied. - /// Thrown when value is invalid parameter. + /// Thrown when a feature is not supported. + /// Thrown when a permission is denied. + /// Thrown when a value is an invalid parameter. /// Thrown when memory is not enough to continue execution. - /// Thrown when connection instance is invalid or when method failed due to invalid operation + /// Thrown when a connection instance is invalid or when a method fails due to an invalid operation. public static ConnectionProfile GetCurrentProfile() { Log.Debug(Globals.LogTag, "GetCurrentProfile"); @@ -192,21 +192,21 @@ namespace Tizen.Network.Connection } /// - /// Gets the default profile which provides the given cellular service. + /// Gets the default profile, which provides the given cellular service. /// /// 3 - /// The cellular service type + /// The cellular service type. /// Connection profile object. /// http://tizen.org/privilege/network.get /// http://tizen.org/feature/network.telephony /// http://tizen.org/feature/network.wifi /// http://tizen.org/feature/network.tethering.bluetooth /// http://tizen.org/feature/network.ethernet - /// Thrown when feature is not supported. - /// Thrown when permission is denied. - /// Thrown when value is invalid parameter. + /// Thrown when a feature is not supported. + /// Thrown when a permission is denied. + /// Thrown when a value is an invalid parameter. /// Thrown when memory is not enough to continue execution. - /// Thrown when connection instance is invalid or when method failed due to invalid operation + /// Thrown when a connection instance is invalid or when a method fails due to an invalid operation. public static ConnectionProfile GetDefaultCellularProfile(CellularServiceType type) { Log.Debug(Globals.LogTag, "GetDefaultCurrentProfile"); @@ -214,11 +214,11 @@ namespace Tizen.Network.Connection } /// - /// Sets the default profile which provides the given cellular service. + /// Sets the default profile, which provides the given cellular service. /// /// 3 - /// The cellular service type - /// The connection profile object + /// The cellular service type. + /// The connection profile object. /// A task indicates whether the SetDefaultCellularProfile method is done successfully or not. /// http://tizen.org/privilege/network.get /// http://tizen.org/privilege/network.profile @@ -226,12 +226,12 @@ namespace Tizen.Network.Connection /// http://tizen.org/feature/network.wifi /// http://tizen.org/feature/network.tethering.bluetooth /// http://tizen.org/feature/network.ethernet - /// Thrown when feature is not supported. - /// Thrown when permission is denied. - /// Thrown when value is invalid parameter. - /// Thrown when value is null. + /// Thrown when a feature is not supported. + /// Thrown when a permission is denied. + /// Thrown when a value is an invalid parameter. + /// Thrown when a value is null. /// Thrown when memory is not enough to continue execution. - /// Thrown when connection or profile instance is invalid or when method failed due to invalid operation + /// Thrown when a connection or a profile instance is invalid or when a method fails due to invalid operation. public static Task SetDefaultCellularProfile(CellularServiceType type, ConnectionProfile profile) { Log.Debug(Globals.LogTag, "SetDefaultCellularProfile"); @@ -240,7 +240,7 @@ namespace Tizen.Network.Connection } /// - /// An extended EventArgs class which contains the state of changed connection profile. + /// An extended EventArgs class, which contains the state of changed connection profile. /// /// 3 public class ConnectionProfileStateEventArgs : EventArgs diff --git a/src/Tizen.Network.Connection/Tizen.Network.Connection/ConnectionTypes.cs b/src/Tizen.Network.Connection/Tizen.Network.Connection/ConnectionTypes.cs index 6c206ffe3..51c613ee7 100755 --- a/src/Tizen.Network.Connection/Tizen.Network.Connection/ConnectionTypes.cs +++ b/src/Tizen.Network.Connection/Tizen.Network.Connection/ConnectionTypes.cs @@ -24,7 +24,7 @@ using Tizen.Internals.Errors; namespace Tizen.Network.Connection { /// - /// Enumeration for connection type. + /// Enumeration for the connection type. /// /// 3 public enum ConnectionType @@ -38,7 +38,7 @@ namespace Tizen.Network.Connection } /// - /// Enumeration for address family. + /// Enumeration for the address family. /// /// 3 public enum AddressFamily @@ -48,7 +48,7 @@ namespace Tizen.Network.Connection } /// - /// Enumeration for cellular network state. + /// Enumeration for the cellular network state. /// /// 3 public enum CellularState @@ -62,7 +62,7 @@ namespace Tizen.Network.Connection } /// - /// Enumeration for connection state. + /// Enumeration for the connection state. /// /// 3 public enum ConnectionState @@ -73,7 +73,7 @@ namespace Tizen.Network.Connection } /// - /// This enumeration defines the attached or detached state of ethernet cable. + /// Enumeration for the attached or detached state of the ethernet cable. /// /// 3 public enum EthernetCableState @@ -83,7 +83,7 @@ namespace Tizen.Network.Connection } /// - /// Enumeration for statistics type. + /// Enumeration for the statistics type. /// /// 3 public enum StatisticsType @@ -95,7 +95,7 @@ namespace Tizen.Network.Connection } /// - /// Enumeration for network connection type. + /// Enumeration for the network connection type. /// /// 3 public enum ConnectionProfileType @@ -107,7 +107,7 @@ namespace Tizen.Network.Connection } /// - /// Enumeration for profile state type. + /// Enumeration for the profile state type. /// /// 3 public enum ProfileState @@ -119,7 +119,7 @@ namespace Tizen.Network.Connection } /// - /// Enumeration for proxy method type. + /// Enumeration for the proxy method type. /// /// 3 public enum ProxyType @@ -130,7 +130,7 @@ namespace Tizen.Network.Connection } /// - /// Enumeration for IP configuration type. + /// Enumeration for the IP configuration type. /// /// 3 public enum IPConfigType @@ -143,7 +143,7 @@ namespace Tizen.Network.Connection } /// - /// Enumeration for cellular service type. + /// Enumeration for the cellular service type. /// /// 3 public enum CellularServiceType @@ -158,7 +158,7 @@ namespace Tizen.Network.Connection } /// - /// Enumeration for cellular pdn type. + /// Enumeration for the cellular pdn type. /// /// 3 public enum CellularPdnType @@ -170,7 +170,7 @@ namespace Tizen.Network.Connection } /// - /// Enumeration for DNS configuration type. + /// Enumeration for the DNS configuration type. /// /// 3 public enum DnsConfigType @@ -187,7 +187,7 @@ namespace Tizen.Network.Connection /// - /// Enumeration for connection errors. + /// Enumeration for the connection errors. /// /// 3 // To do : have to assign valid error code @@ -212,7 +212,7 @@ namespace Tizen.Network.Connection } /// - /// Enumeration for profile list type. + /// Enumeration for the profile list type. /// /// 3 public enum ProfileListType @@ -223,7 +223,7 @@ namespace Tizen.Network.Connection } /// - /// Enumeration for security type of Wi-Fi. + /// Enumeration for the security type of Wi-Fi. /// /// 3 public enum WiFiSecurityType @@ -236,7 +236,7 @@ namespace Tizen.Network.Connection } /// - /// Enumeration for encryption modes. + /// Enumeration for the encryption modes. /// /// 3 public enum WiFiEncryptionType @@ -249,7 +249,7 @@ namespace Tizen.Network.Connection } /// - /// Enumeration for connection profile state. + /// Enumeration for the connection profile state. /// /// 3 public enum ConnectionProfileState @@ -261,7 +261,7 @@ namespace Tizen.Network.Connection } /// - /// Enumeration for cellular authentication type. + /// Enumeration for the cellular authentication type. /// /// 3 public enum CellularAuthType diff --git a/src/Tizen.Network.Connection/Tizen.Network.Connection/IAddressInformation.cs b/src/Tizen.Network.Connection/Tizen.Network.Connection/IAddressInformation.cs index 5185186cf..fa8ab4688 100755 --- a/src/Tizen.Network.Connection/Tizen.Network.Connection/IAddressInformation.cs +++ b/src/Tizen.Network.Connection/Tizen.Network.Connection/IAddressInformation.cs @@ -35,9 +35,9 @@ namespace Tizen.Network.Connection /// /// 3 /// First DNS address of the connection. - /// Thrown during set when feature is not supported. - /// Thrown during set when value is invalid parameter. - /// Thrown during set when profile instance is invalid or when method failed due to invalid operation. + /// Thrown during set when a feature is not supported. + /// Thrown during set when a value is an invalid parameter. + /// Thrown during set when a profile instance is invalid or when a method fails due to an invalid operation. System.Net.IPAddress Dns1 { get; set; } /// @@ -45,9 +45,9 @@ namespace Tizen.Network.Connection /// /// 3 /// Second DNS address of the connection. - /// Thrown during set when feature is not supported. - /// Thrown during set when value is invalid parameter. - /// Thrown during set when profile instance is invalid or when method failed due to invalid operation. + /// Thrown during set when a feature is not supported. + /// Thrown during set when a value is an invalid parameter. + /// Thrown during set when a profile instance is invalid or when a method fails due to an invalid operation. System.Net.IPAddress Dns2 { get; set; } /// @@ -55,9 +55,9 @@ namespace Tizen.Network.Connection /// /// 3 /// Gateway address of the connection. - /// Thrown during set when feature is not supported. - /// Thrown during set when value is invalid parameter. - /// Thrown during set when profile instance is invalid or when method failed due to invalid operation. + /// Thrown during set when a feature is not supported. + /// Thrown during set when a value is an invalid parameter. + /// Thrown during set when a profile instance is invalid or when a method fails due to an invalid operation. System.Net.IPAddress Gateway { get; set; } /// @@ -65,9 +65,9 @@ namespace Tizen.Network.Connection /// /// 3 /// Subnet mask of the connection. - /// Thrown during set when feature is not supported. - /// Thrown during set when value is invalid parameter. - /// Thrown during set when profile instance is invalid or when method failed due to invalid operation. + /// Thrown during set when a feature is not supported. + /// Thrown during set when a value is an invalid parameter. + /// Thrown during set when a profile instance is invalid or when a method fails due to an invalid operation. System.Net.IPAddress SubnetMask { get; set; } /// @@ -75,9 +75,9 @@ namespace Tizen.Network.Connection /// /// 3 /// IP address of the connection. - /// Thrown during set when feature is not supported. - /// Thrown during set when value is invalid parameter. - /// Thrown during set when profile instance is invalid or when method failed due to invalid operation. + /// Thrown during set when a feature is not supported. + /// Thrown during set when a value is an invalid parameter. + /// Thrown during set when a profile instance is invalid or when a method fails due to an invalid operation. System.Net.IPAddress IP { get; set; } /// @@ -85,9 +85,9 @@ namespace Tizen.Network.Connection /// /// 3 /// IP config type of the connection. - /// Thrown during set when feature is not supported. - /// Thrown during set when value is invalid parameter. - /// Thrown during set when profile instance is invalid or when method failed due to invalid operation. + /// Thrown during set when a feature is not supported. + /// Thrown during set when a value is an invalid parameter. + /// Thrown during set when a profile instance is invalid or when a method fails due to an invalid operation. IPConfigType IPConfigType { get; set; } /// @@ -95,9 +95,9 @@ namespace Tizen.Network.Connection /// /// 3 /// Prefix length of the connection. - /// Thrown during set when feature is not supported. - /// Thrown during set when value is invalid parameter. - /// Thrown during set when profile instance is invalid or when method failed due to invalid operation. + /// Thrown during set when a feature is not supported. + /// Thrown during set when a value is an invalid parameter. + /// Thrown during set when a profile instance is invalid or when a method fails due to an invalid operation. int PrefixLength { get; set; } /// @@ -105,13 +105,13 @@ namespace Tizen.Network.Connection /// /// 3 /// Config type of the DNS. - /// Thrown during set when feature is not supported. - /// Thrown during set when value is invalid parameter. - /// Thrown during set when profile instance is invalid or when method failed due to invalid operation. + /// Thrown during set when a feature is not supported. + /// Thrown during set when a value is an invalid parameter. + /// Thrown during set when a profile instance is invalid or when a method fails due to an invalid operation. DnsConfigType DnsConfigType { get; set; } /// - /// The DHCP server address. It is only supported for IPV4 address family. + /// The DHCP server address. It is only supported for the IPV4 address family. /// /// Server address of the DHCP. System.Net.IPAddress DhcpServerAddress { get; } diff --git a/src/Tizen.Network.Connection/Tizen.Network.Connection/WiFiProfile.cs b/src/Tizen.Network.Connection/Tizen.Network.Connection/WiFiProfile.cs index 8ac62348b..21f925809 100755 --- a/src/Tizen.Network.Connection/Tizen.Network.Connection/WiFiProfile.cs +++ b/src/Tizen.Network.Connection/Tizen.Network.Connection/WiFiProfile.cs @@ -23,7 +23,7 @@ using System.Runtime.InteropServices; namespace Tizen.Network.Connection { /// - /// This Class is WiFiProfile. It provides functions to manage the WiFi profile. + /// This is the WiFiProfile class. It provides functions to manage the WiFi profile. /// /// 3 public class WiFiProfile : ConnectionProfile @@ -216,13 +216,13 @@ namespace Tizen.Network.Connection /// Sets the passphrase of the Wi-Fi WPA. /// /// 3 - /// The passphrase of Wi-Fi security + /// The passphrase of Wi-Fi security. /// http://tizen.org/feature/network.wifi - /// Thrown when feature is not supported. - /// Thrown when value is invalid parameter. - /// Thrown when passphrase is null. - /// Thrown when profile instance is invalid or when method failed due to invalid operation. - /// Thrown when operation is performed on a disposed object. + /// Thrown when a feature is not supported. + /// Thrown when a value is an invalid parameter. + /// Thrown when a passphrase is null. + /// Thrown when a profile instance is invalid or when a method fails due to an invalid operation. + /// Thrown when an operation is performed on a disposed object. public void SetPassphrase(string passphrase) { CheckDisposed();