From 11873c01d51c950ae41886a8300ec5422e9c00d5 Mon Sep 17 00:00:00 2001 From: Jaemin Ahn Date: Wed, 20 Mar 2013 13:07:34 +0900 Subject: [PATCH] [Doxygen] Merge LB's review comment. Change-Id: Ic49c285b73eaffbb4ee3284e740d9822801fd475 Signed-off-by: Jaemin Ahn --- inc/FNetDhcpClientInfo.h | 4 ++-- inc/FNetDns.h | 6 +++--- inc/FNetHttpHttpMessage.h | 6 +++--- inc/FNetHttpHttpMultipartEntity.h | 2 +- inc/FNetHttpHttpTransaction.h | 4 ++-- inc/FNetHttpHttpTypes.h | 8 ++++---- inc/FNetHttpIHttpProgressEventListener.h | 2 +- inc/FNetHttpIHttpTransactionEventListener.h | 6 +++--- inc/FNetILocalDhcpServerEventListener.h | 2 +- inc/FNetIManagedNetConnectionEventListener.h | 2 +- inc/FNetINetConnectionEventListener.h | 2 +- inc/FNetIp4Address.h | 8 ++++---- inc/FNetIpAddress.h | 10 +++++----- inc/FNetIpHostEntry.h | 2 +- inc/FNetManagedNetConnection.h | 4 ++-- inc/FNetNetAccountInfo.h | 8 ++++---- inc/FNetNetAccountManager.h | 4 ++-- inc/FNetNetConnection.h | 4 ++-- inc/FNetNetConnectionInfo.h | 6 +++--- inc/FNetNetConnectionManager.h | 2 +- inc/FNetNetEndPoint.h | 4 ++-- inc/FNetNetTypes.h | 4 ++-- inc/FNetSockISocketEventListener.h | 2 +- inc/FNetSockSecureSocket.h | 8 ++++---- inc/FNetSockSocket.h | 10 +++++----- inc/FNetSockSocketIpMulticastRequestOption.h | 4 ++-- inc/FNetSockSocketLingerOption.h | 4 ++-- inc/FNetSockSocketUtility.h | 8 ++++---- 28 files changed, 68 insertions(+), 68 deletions(-) mode change 100755 => 100644 inc/FNetDns.h mode change 100755 => 100644 inc/FNetHttpHttpMessage.h mode change 100755 => 100644 inc/FNetHttpHttpMultipartEntity.h mode change 100755 => 100644 inc/FNetHttpHttpTransaction.h mode change 100755 => 100644 inc/FNetHttpHttpTypes.h mode change 100755 => 100644 inc/FNetHttpIHttpProgressEventListener.h mode change 100755 => 100644 inc/FNetHttpIHttpTransactionEventListener.h mode change 100755 => 100644 inc/FNetIp4Address.h mode change 100755 => 100644 inc/FNetNetAccountInfo.h mode change 100755 => 100644 inc/FNetNetAccountManager.h mode change 100755 => 100644 inc/FNetNetConnection.h mode change 100755 => 100644 inc/FNetNetConnectionManager.h mode change 100755 => 100644 inc/FNetSockSecureSocket.h mode change 100755 => 100644 inc/FNetSockSocket.h mode change 100755 => 100644 inc/FNetSockSocketUtility.h diff --git a/inc/FNetDhcpClientInfo.h b/inc/FNetDhcpClientInfo.h index 1d4423a..c2454fb 100644 --- a/inc/FNetDhcpClientInfo.h +++ b/inc/FNetDhcpClientInfo.h @@ -93,8 +93,8 @@ public: * * @return @c true if the values match, @n * else @c false - * @param[in] rhs The other Object to compare - * @see Object::Equals() + * @param[in] rhs The other Tizen::Base::Object to compare + * @see Tizen::Base::Object::Equals() */ virtual bool Equals(const Tizen::Base::Object& rhs) const; diff --git a/inc/FNetDns.h b/inc/FNetDns.h old mode 100755 new mode 100644 index b78a524..b90b996 --- a/inc/FNetDns.h +++ b/inc/FNetDns.h @@ -84,7 +84,7 @@ public: result Construct(const NetConnection& netConnection, IDnsEventListener& listener); /** - * Initializes this instance of %Dns with the specified listener. + * Initializes this instance of %Dns with the specified @c listener. * * @since 2.0 * @@ -102,7 +102,7 @@ public: public: /** * Requests a DNS lookup by host name. @n - * This method is asynchronous. + * The %GetHostByName() method is asynchronous. * * @since 2.0 * @@ -128,7 +128,7 @@ public: /** * Requests a DNS lookup by IP address. @n - * This method is asynchronous. + * The %GetHostByAddress() method is asynchronous. * * @since 2.0 * diff --git a/inc/FNetHttpHttpMessage.h b/inc/FNetHttpHttpMessage.h old mode 100755 new mode 100644 index ada299a..04cd729 --- a/inc/FNetHttpHttpMessage.h +++ b/inc/FNetHttpHttpMessage.h @@ -67,7 +67,7 @@ protected: protected: /** * Writes the message body. @n - * This method can be called several times consecutively. All the message bodies are stored in the queue. + * The %WriteBody() method can be called several times consecutively. All the message bodies are stored in the queue. * * @since 2.0 * @@ -90,7 +90,7 @@ protected: protected: /** * Gets the header. @n - * This method is used to access the headers associated with a transaction request or response. + * The %GetHeader() method is used to access the headers associated with a transaction request or response. * The handle is obtained from either the HttpRequest or the HttpResponse objects associated with the transaction. Adding, modifying, or removing a * header field is done using this header handle. * @@ -162,7 +162,7 @@ protected: // // This variable is for internal use only. Using this variable can cause behavioral, security-related, and consistency-related issues in the application. // - // The header of message + // The header of the message // // @since 2.0 // diff --git a/inc/FNetHttpHttpMultipartEntity.h b/inc/FNetHttpHttpMultipartEntity.h old mode 100755 new mode 100644 index 4a42fbb..a3fa1c7 --- a/inc/FNetHttpHttpMultipartEntity.h +++ b/inc/FNetHttpHttpMultipartEntity.h @@ -231,7 +231,7 @@ public: result AddStringPart(const Tizen::Base::String& name, const Tizen::Base::String& text); /** - * Adds the string part to the %HttpMultipartEntity. + * Adds the string part to %HttpMultipartEntity. * * @since 2.0 * diff --git a/inc/FNetHttpHttpTransaction.h b/inc/FNetHttpHttpTransaction.h old mode 100755 new mode 100644 index 4f6c4b6..273536a --- a/inc/FNetHttpHttpTransaction.h +++ b/inc/FNetHttpHttpTransaction.h @@ -309,12 +309,12 @@ public: result SetTimeout(int timeout); /** - * Sets the flag to verify server certificate. (the flag is @c HTTP_CV_FLAG_AUTOMATIC by default) + * Sets the flag to verify server certificate. (By default, the flag is @c HTTP_CV_FLAG_AUTOMATIC.) * * @since 2.1 * * @return An error code - * @param[in] flag Set the flag for certificate verification. + * @param[in] flag Set the flag for certificate verification * @exception E_SUCCESS The method is successful. * @exception E_INVALID_STATE The method invoked is invalid. * @exception E_SYSTEM A system error has occurred. diff --git a/inc/FNetHttpHttpTypes.h b/inc/FNetHttpHttpTypes.h old mode 100755 new mode 100644 index 212a9a4..101a5aa --- a/inc/FNetHttpHttpTypes.h +++ b/inc/FNetHttpHttpTypes.h @@ -70,7 +70,7 @@ enum NetHttpSessionMode /** * @enum HttpVersion * - * Defines the HTTP version + * Defines the HTTP version. * * @since 2.0 */ @@ -429,9 +429,9 @@ enum NetHttpCookieFlag */ enum NetHttpCertificateVerificationFlag { - HTTP_CV_FLAG_AUTOMATIC, /**< The certificate will be verified by system. If server certificate is invalid, the IHttpTransactionEventListener::OnTransactionCertVerificationRequiredN() listener is received. */ - HTTP_CV_FLAG_MANUAL, /**< The certificate verification will be handled by user action when the IHttpTransactionEventListener::OnTransactionCertVerificationRequestedN() listener is received. */ - HTTP_CV_FLAG_IGNORED, /**< The certificate verification will be ignored. */ + HTTP_CV_FLAG_AUTOMATIC, /**< The certificate is verified by the system @n If server certificate is invalid, the IHttpTransactionEventListener::OnTransactionCertVerificationRequiredN() listener is received. */ + HTTP_CV_FLAG_MANUAL, /**< The certificate verification is handled by user action when the IHttpTransactionEventListener::OnTransactionCertVerificationRequestedN() listener is received */ + HTTP_CV_FLAG_IGNORED, /**< The certificate verification is ignored */ }; } } } //Tizen::Net::Http diff --git a/inc/FNetHttpIHttpProgressEventListener.h b/inc/FNetHttpIHttpProgressEventListener.h old mode 100755 new mode 100644 index 8bdc683..65e62e1 --- a/inc/FNetHttpIHttpProgressEventListener.h +++ b/inc/FNetHttpIHttpProgressEventListener.h @@ -39,7 +39,7 @@ class HttpTransaction; * @since 2.0 * * The %IHttpProgressEventListener interface is the listener for the HTTP progress events, when the HTTP message is uploaded or downloaded. In order to use this listener, - * the listener must be set to the HttpTransaction instance using the SetHttpProgressListener() method. + * the listener must be set to the HttpTransaction instance using the HttpTransaction::SetHttpProgressListener() method. */ class _OSP_EXPORT_ IHttpProgressEventListener diff --git a/inc/FNetHttpIHttpTransactionEventListener.h b/inc/FNetHttpIHttpTransactionEventListener.h old mode 100755 new mode 100644 index d485fb2..d6f93f7 --- a/inc/FNetHttpIHttpTransactionEventListener.h +++ b/inc/FNetHttpIHttpTransactionEventListener.h @@ -160,13 +160,13 @@ public: * Called to notify when the server certificate verification has been requested. * * @since 2.1 - * @return The result for certificate verification. * + * @return The result for certificate verification * @param[in] httpSession The session information of the %Http transaction event * @param[in] httpTransaction The transaction information of the %Http transaction event - * @param[in] pCertList The server certificate chain. An IList whose element is of the type Tizen::Security::Cert::X509Certificate *. + * @param[in] pCertList The server certificate chain @n A Tizen::Base::Collection::IList whose element is of the type Tizen::Security::Cert::X509Certificate *. * - * @remarks Do not delete instance of @c httpSession or @c httpTransaction in this listener before the IHttpTransactionEventListener::OnTransactionCompleted() or IHttpTransactionEventListener::OnTransactionAborted() method is called. + * @remarks Do not delete the instance of @c httpSession or @c httpTransaction in this listener before the IHttpTransactionEventListener::OnTransactionCompleted() or IHttpTransactionEventListener::OnTransactionAborted() method is called. * @see HttpTransaction::SetServerCertificateVerification() */ virtual bool OnTransactionCertVerificationRequestedN(HttpSession& httpSession, HttpTransaction& httpTransaction, Tizen::Base::Collection::IList* pCertList) diff --git a/inc/FNetILocalDhcpServerEventListener.h b/inc/FNetILocalDhcpServerEventListener.h index e91d23a..1c4d16e 100644 --- a/inc/FNetILocalDhcpServerEventListener.h +++ b/inc/FNetILocalDhcpServerEventListener.h @@ -19,7 +19,7 @@ * @file FNetILocalDhcpServerEventListener.h * @brief This is the header file for the %ILocalDhcpServerEventListener interface. * - * This is the header file for the %ILocalDhcpServerEventListener interface. + * This header file contains the declarations of the %ILocalDhcpServerEventListener interface. * */ #ifndef _FNET_ILOCAL_DHCP_SERVER_EVENT_LISTENER_H_ diff --git a/inc/FNetIManagedNetConnectionEventListener.h b/inc/FNetIManagedNetConnectionEventListener.h index ccca860..9775325 100644 --- a/inc/FNetIManagedNetConnectionEventListener.h +++ b/inc/FNetIManagedNetConnectionEventListener.h @@ -39,7 +39,7 @@ class ManagedNetConnection; * * The %IManagedNetConnectionEventListener interface specifies the methods used to create the notifications about the different kinds of network * connection events. These events are sent only when %IManagedNetConnectionEventListener is added to the ManagedNetConnection instance, and - * this is done by invoking the SetManagedNetConnectionEventListener() method. A method of this interface is called when a network connection + * this is done by invoking the ManagedNetConnection::SetManagedNetConnectionEventListener() method. A method of this interface is called when a network connection * event is generated. * * For more information on the class features, see Managing Network Connections. diff --git a/inc/FNetINetConnectionEventListener.h b/inc/FNetINetConnectionEventListener.h index d1d2540..a8b4fe4 100644 --- a/inc/FNetINetConnectionEventListener.h +++ b/inc/FNetINetConnectionEventListener.h @@ -39,7 +39,7 @@ class NetConnection; * * The %INetConnectionEventListener interface specifies the methods for creating the notifications about the different kinds of network * connection events. These events are only sent when %INetConnectionEventListener is added to a NetConnection instance, by invoking the - * AddNetConnectionListener() method. When a network connection event is generated, a method of this class is called. + * NetConnection::AddNetConnectionListener() method. When a network connection event is generated, a method of this class is called. * * For more information on the class features, see Managing Network Connections. * diff --git a/inc/FNetIp4Address.h b/inc/FNetIp4Address.h old mode 100755 new mode 100644 index 7f1b156..617b85d --- a/inc/FNetIp4Address.h +++ b/inc/FNetIp4Address.h @@ -134,7 +134,7 @@ public: * @since 2.0 * * @return An error code - * @param[out] ipAddr A ByteBuffer object containing the raw IP address + * @param[out] ipAddr A Tizen::Base::ByteBuffer object containing the raw IP address * @exception E_SUCCESS The method is successful. * @exception E_OVERFLOW The length of the remaining bytes of @c ipAddr is less than @c 4. * @remarks This method returns the raw IP address of the %Ip4Address object. The result is in host byte order. This method writes the raw address @@ -197,8 +197,8 @@ public: * * @return @c true if the values match, @n * else @c false - * @param[in] rhs The other Object to be compared - * @see Object::Equals() + * @param[in] rhs The other Tizen::Base::Object to compare + * @see Tizen::Base::Object::Equals() */ virtual bool Equals(const Tizen::Base::Object& rhs) const; @@ -207,7 +207,7 @@ public: * * @since 2.0 * - * @return The current instance's hash value + * @return The hash value of the current instance */ virtual int GetHashCode(void) const; diff --git a/inc/FNetIpAddress.h b/inc/FNetIpAddress.h index 76effab..dc023b6 100644 --- a/inc/FNetIpAddress.h +++ b/inc/FNetIpAddress.h @@ -65,7 +65,7 @@ public: * @since 2.0 * * @return The address as an unsigned @c short value, in the network @c byte order - * @param[in] host The IP address to be converted, expressed in host @c byte order + * @param[in] host The IP address to convert, expressed in host @c byte order * * @see NetworkToHostOrder() */ @@ -77,7 +77,7 @@ public: * @since 2.0 * * @return The address as an unsigned @c long value, in the network @c byte order - * @param[in] host The IP address to be converted, expressed in host @c byte order + * @param[in] host The IP address to convert, expressed in the host @c byte order * * @see NetworkToHostOrder() */ @@ -89,7 +89,7 @@ public: * @since 2.0 * * @return The address as an unsigned @c short value, in the host @c byte order - * @param[in] network The IP address to be converted, expressed in the network @c byte order + * @param[in] network The IP address to convert, expressed in the network @c byte order * * @see HostToNetworkOrder() */ @@ -101,7 +101,7 @@ public: * @since 2.0 * * @return The address as an unsigned @c long value, in the host @c byte order - * @param[in] network The IP address to be converted, expressed in the network @c byte order + * @param[in] network The IP address to convert, expressed in the network @c byte order * * @see HostToNetworkOrder() */ @@ -123,7 +123,7 @@ public: * @since 2.0 * * @return An error code - * @param[out] ipAddr A ByteBuffer object for getting the raw IP address + * @param[out] ipAddr A Tizen::Base::ByteBuffer object for getting the raw IP address * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG The specified @c ipAddr is invalid. * @exception E_OVERFLOW This operation has caused the memory to overflow. diff --git a/inc/FNetIpHostEntry.h b/inc/FNetIpHostEntry.h index 9495329..b131155 100644 --- a/inc/FNetIpHostEntry.h +++ b/inc/FNetIpHostEntry.h @@ -41,7 +41,7 @@ class _IpHostEntryImpl; * @since 2.0 * * The %IpHostEntry class associates a Domain Name %System (DNS) host name with a list of aliases and matching IP addresses. If the specified host has - * multiple entries in the DNS database, %IpHostEntry contains multiple IP addresses and aliases. The %IpHostEntry class is used as a helper class + * multiple entries in the DNS database, %IpHostEntry contains multiple IP addresses and aliases. This class is used as a helper class * with the Dns class. * * For more information on the class features, see Domain Name System Access. diff --git a/inc/FNetManagedNetConnection.h b/inc/FNetManagedNetConnection.h index 019cd76..89a0afc 100644 --- a/inc/FNetManagedNetConnection.h +++ b/inc/FNetManagedNetConnection.h @@ -102,10 +102,10 @@ public: * @return A pointer to an instance of NetConnectionInfo specifying the information about this network connection * @exception E_SUCCESS The method is successful. * @exception E_INVALID_STATE The network connection is inactive. - * @remarks This method requires a %NetConnectionInfo instance reference. + * @remarks This method requires a NetConnectionInfo instance reference. * %NetConnectionInfo is only available when the network connection managed by the system is active. In other states, this returns null. * The specific error code can be accessed using the GetLastResult() method. - * @warning Do not delete the returned %NetConnectionInfo instance. This instance is directly referencing the internal connectionInfo of + * @warning Do not delete the returned NetConnectionInfo instance. This instance is directly referencing the internal connectionInfo of * %ManagedNetConnection. */ const NetConnectionInfo* GetNetConnectionInfo(void) const; diff --git a/inc/FNetNetAccountInfo.h b/inc/FNetNetAccountInfo.h old mode 100755 new mode 100644 index 904127f..3be46d9 --- a/inc/FNetNetAccountInfo.h +++ b/inc/FNetNetAccountInfo.h @@ -249,9 +249,9 @@ public: * else @c null if an error occurs or the dynamic address scheme is being used * @exception E_SUCCESS The method is successful. * @exception E_INVALID_OPERATION This operation is not allowed in the dynamic address scheme. - * @remarks When this instance is got by @ref NetAccountManager::GetNetAccountInfoN, + * @remarks When this instance is got by NetAccountManager::GetNetAccountInfoN(), * - this method returns a statically assigned primary DNS address pointer if the DNS address scheme is NET_ADDRESS_SCHEME_STATIC - * - this method returns @n null if the DNS address scheme is NET_ADDRESS_SCHEME_DYNAMIC @n + * - this method returns @n null if the DNS address scheme is @c NET_ADDRESS_SCHEME_DYNAMIC @n * The specific error code can be accessed using the GetLastResult() method. * @see GetSecondaryDnsAddress() */ @@ -429,8 +429,8 @@ public: * * @return @c true if the values match, @n * else @c false - * @param[in] rhs The other Object to compare - * @see Object::Equals() + * @param[in] rhs The other Tizen::Base::Object to compare + * @see Tizen::Base::Object::Equals() */ virtual bool Equals(const Tizen::Base::Object& rhs) const; diff --git a/inc/FNetNetAccountManager.h b/inc/FNetNetAccountManager.h old mode 100755 new mode 100644 index 45f5865..544bba1 --- a/inc/FNetNetAccountManager.h +++ b/inc/FNetNetAccountManager.h @@ -215,7 +215,7 @@ public: * * @since 2.0 * - * @return An IList with NetAccoundIds, which are in the registry + * @return A Tizen::Base::Collection::IList with NetAccoundIds, which are in the registry * @exception E_SUCCESS The method is successful. * @exception E_OBJ_NOT_FOUND The NetAccountInfo is not found in the registry. * @exception E_SYSTEM An internal error has occurred. @@ -228,7 +228,7 @@ public: * * @since 2.0 * - * @return An IList containing the indexes to the NetAccountInfos in the registry + * @return A Tizen::Base::Collection::IList containing the indexes to the NetAccountInfos in the registry * @exception E_SUCCESS The method is successful. * @exception E_OBJ_NOT_FOUND The NetAccountInfo is not found in the registry. * @exception E_OUT_OF_MEMORY The memory is insufficient. diff --git a/inc/FNetNetConnection.h b/inc/FNetNetConnection.h old mode 100755 new mode 100644 index d933b57..7873ea6 --- a/inc/FNetNetConnection.h +++ b/inc/FNetNetConnection.h @@ -169,7 +169,7 @@ public: * @exception E_SERVICE_LIMITED A connection is already active. Therefore, cannot setup a co-existing network connection. * @exception E_SYSTEM An internal error has occurred. * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. - * @remarks When the network is available, after calling this method, the OnNetConnectionStarted() method of the registered + * @remarks When the network is available, after calling this method, the INetConnectionEventListener::OnNetConnectionStarted() method of the registered * INetConnectionEventListener instance is called. * @see Stop() */ @@ -287,7 +287,7 @@ public: * @deprecated This method is deprecated because it is moved to the NetConnectionManager class. * @since 2.0 * - * @return An IList containing indexes to NetConnectionInfo in the network, @n + * @return A Tizen::Base::Collection::IList containing indexes to NetConnectionInfo in the network, @n * else @c null in case of an error or if an active connection is not found * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. diff --git a/inc/FNetNetConnectionInfo.h b/inc/FNetNetConnectionInfo.h index e9f9802..388b2b3 100644 --- a/inc/FNetNetConnectionInfo.h +++ b/inc/FNetNetConnectionInfo.h @@ -157,7 +157,7 @@ public: * @since 2.0 * * @return A pointer to the IpAddress instance representing the subnet mask address of the network connection - * @remarks In any case, check whether the %IpAddress pointer is @c null or not, because the subnet mask address field is not mandatory. + * @remarks In any case, check whether the IpAddress pointer is @c null or not, because the subnet mask address field is not mandatory. */ const IpAddress* GetSubnetMaskAddress(void) const; @@ -199,8 +199,8 @@ public: * * @return @c true if the values match, @n * else @c false - * @param[in] rhs The other Object to compare - * @see Object::Equals() + * @param[in] rhs The other Tizen::Base::Object to compare + * @see Tizen::Base::Object::Equals() */ virtual bool Equals(const Tizen::Base::Object& rhs) const; diff --git a/inc/FNetNetConnectionManager.h b/inc/FNetNetConnectionManager.h old mode 100755 new mode 100644 index 967bce8..ed2c00e --- a/inc/FNetNetConnectionManager.h +++ b/inc/FNetNetConnectionManager.h @@ -157,7 +157,7 @@ public: * * @since 2.0 * - * @return An IList containing indexes to the active %NetConnectionInfo in the network, @n + * @return A Tizen::Base::Collection::IList containing indexes to the active %NetConnectionInfo in the network, @n * else @c null if there is an error or if there is no active connection in the system * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. diff --git a/inc/FNetNetEndPoint.h b/inc/FNetNetEndPoint.h index 61fdf9b..c283e86 100644 --- a/inc/FNetNetEndPoint.h +++ b/inc/FNetNetEndPoint.h @@ -153,8 +153,8 @@ public: * * @return @c true if the values match, @n * else @c false - * @param[in] rhs The other Object to compare - * @see Object::Equals() + * @param[in] rhs The other Tizen::Base::Object to compare + * @see Tizen::Base::Object::Equals() */ virtual bool Equals(const Tizen::Base::Object& rhs) const; diff --git a/inc/FNetNetTypes.h b/inc/FNetNetTypes.h index e395bac..cd91611 100644 --- a/inc/FNetNetTypes.h +++ b/inc/FNetNetTypes.h @@ -198,13 +198,13 @@ enum NetNapAuthType /** * @enum NetProxyType * - * Defines the proxy type of the network + * Defines the proxy type of the network. * * @since 2.0 */ enum NetProxyType { - NET_PROXY_TYPE_NONE = 0, /**< Not use a proxy */ + NET_PROXY_TYPE_NONE = 0, /**< No use of proxy */ NET_PROXY_TYPE_MANUAL /**< Manual configuration */ }; diff --git a/inc/FNetSockISocketEventListener.h b/inc/FNetSockISocketEventListener.h index 5467624..b4f821f 100644 --- a/inc/FNetSockISocketEventListener.h +++ b/inc/FNetSockISocketEventListener.h @@ -41,7 +41,7 @@ class Socket; * @since 2.0 * * The %ISocketEventListener interface specifies methods used for creating notifications about the different kinds of socket events. -* These events are only sent out when using the socket in a non-blocking mode. A listener is registered by calling the AddSocketListener() +* These events are only sent out when using the socket in a non-blocking mode. A listener is registered by calling the Socket::AddSocketListener() * method. One of these methods is called when a socket event is generated. * * For more information on the class features, see Sockets Guide. diff --git a/inc/FNetSockSecureSocket.h b/inc/FNetSockSecureSocket.h old mode 100755 new mode 100644 index 73510e3..bbcab5e --- a/inc/FNetSockSecureSocket.h +++ b/inc/FNetSockSecureSocket.h @@ -331,7 +331,7 @@ public: * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. * * @remarks Starts connection to a remote peer including SSL handshaking. - * After this method is called, OnSecureSocketConnected() is called. The data is sent to and received from the remote + * After this method is called, ISecureSocketEventListener::OnSecureSocketConnected() is called. The data is sent to and received from the remote * device using Send() and Receive() respectively. If the Bind() method is not called before calling this * method, the underlying service provider assigns the local network address and port number. */ @@ -355,7 +355,7 @@ public: * @since 2.0 * * @return An error code - * @param[in] buffer An instance of ByteBuffer that contains the data to send + * @param[in] buffer An instance of Tizen::Base::ByteBuffer that contains the data to send * @exception E_SUCCESS The method is successful. * @exception E_INVALID_SOCKET The secure socket is invalid. * @exception E_INVALID_STATE The secure socket is not in a valid state. @@ -425,7 +425,7 @@ public: * @since 2.0 * * @return An error code - * @param[out] buffer An instance of ByteBuffer that is the storage location for the received data + * @param[out] buffer An instance of Tizen::Base::ByteBuffer that is the storage location for the received data * @exception E_SUCCESS The method is successful. * @exception E_INVALID_SOCKET The secure socket is invalid. * @exception E_INVALID_STATE The secure socket is not in a valid state. @@ -530,7 +530,7 @@ public: /** * Accepts an incoming connection. @n - * This method extracts the first connection from the queue of pending connections, and + * The %AcceptN() method extracts the first connection from the queue of pending connections, and * creates a new secure socket with the same socket type, protocol type, and protocol family * as the listening secure socket. * diff --git a/inc/FNetSockSocket.h b/inc/FNetSockSocket.h old mode 100755 new mode 100644 index 8969e22..14ccc0b --- a/inc/FNetSockSocket.h +++ b/inc/FNetSockSocket.h @@ -226,7 +226,7 @@ public: * @exception E_SYSTEM A system error has occurred. * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. * @remarks If the socket is a connectionless socket (that is, of the type NET_SOCKET_TYPE_DATAGRAM), this method fails. - * After this method is called, OnSocketConnected() is called. the data can be sent to and received from the remote device using Send() and Receive() respectively. + * After this method is called, ISocketEventListener::OnSocketConnected() is called. the data can be sent to and received from the remote device using Send() and Receive() respectively. * If a connection-oriented protocol is used and Bind() is not called before calling this method, the underlying service provider * assigns the local network address and port number. */ @@ -250,7 +250,7 @@ public: * @since 2.0 * * @return An error code - * @param[in] buffer An instance of ByteBuffer that contains the data to be sent + * @param[in] buffer An instance of Tizen::Base::ByteBuffer that contains the data to send * @exception E_SUCCESS The method is successful. * @exception E_INVALID_SOCKET The socket is invalid. * @exception E_INVALID_STATE The socket is not in a valid state. @@ -331,7 +331,7 @@ public: * @endif * * @return An error code - * @param[in] buffer An instance of ByteBuffer containing the data to send + * @param[in] buffer An instance of Tizen::Base::ByteBuffer containing the data to send * @param[in] remoteEndPoint An instance of NetEndPoint representing the destination for the data * @exception E_SUCCESS The method is successful. * @exception E_INVALID_SOCKET The socket is invalid. @@ -421,7 +421,7 @@ public: * @since 2.0 * * @return An error code - * @param[out] buffer An instance of ByteBuffer that is the storage location for the received data + * @param[out] buffer An instance of Tizen::Base::ByteBuffer that is the storage location for the received data * @exception E_SUCCESS The method is successful. * @exception E_INVALID_SOCKET The socket is invalid. * @exception E_INVALID_STATE The socket is not in a valid state. @@ -485,7 +485,7 @@ public: * @endif * * @return An error code - * @param[out] buffer An instance of ByteBuffer that is the storage location for the received data + * @param[out] buffer An instance of Tizen::Base::ByteBuffer that is the storage location for the received data * @param[out] remoteEndPoint The NetEndPoint of the remote server * @exception E_SUCCESS The method is successful. * @exception E_INVALID_SOCKET The socket is invalid. diff --git a/inc/FNetSockSocketIpMulticastRequestOption.h b/inc/FNetSockSocketIpMulticastRequestOption.h index 7c54e1c..79a805c 100644 --- a/inc/FNetSockSocketIpMulticastRequestOption.h +++ b/inc/FNetSockSocketIpMulticastRequestOption.h @@ -230,8 +230,8 @@ public: * @since 2.0 * @return @c true if the values match, @n * else @c false - * @param[in] obj The other Object to be compared - * @see Object::Equals() + * @param[in] obj The other Tizen::Base::Object to compare + * @see Tizen::Base::Object::Equals() */ virtual bool Equals(const Tizen::Base::Object& obj) const; diff --git a/inc/FNetSockSocketLingerOption.h b/inc/FNetSockSocketLingerOption.h index ccad7f3..84b793c 100644 --- a/inc/FNetSockSocketLingerOption.h +++ b/inc/FNetSockSocketLingerOption.h @@ -124,8 +124,8 @@ public: * * @return @c true if the values match, @n * else @c false - * @param[in] obj The other Object to be compared - * @see Object::Equals() + * @param[in] obj The other Tizen::Base::Object to compare + * @see Tizen::Base::Object::Equals() */ virtual bool Equals(const Tizen::Base::Object& obj) const; diff --git a/inc/FNetSockSocketUtility.h b/inc/FNetSockSocketUtility.h old mode 100755 new mode 100644 index 660deb5..9d464c7 --- a/inc/FNetSockSocketUtility.h +++ b/inc/FNetSockSocketUtility.h @@ -84,9 +84,9 @@ public: * @privilege http://tizen.org/privilege/socket * * @return An error code - * @param[in,out] pCheckRead An IList of Socket instances to check for readability - * @param[in,out] pCheckWrite An IList of Socket instances to check for writability - * @param[in,out] pCheckError An IList of Socket instances to check for errors + * @param[in,out] pCheckRead A Tizen::Base::Collection::IList of Socket instances to check for readability + * @param[in,out] pCheckWrite A Tizen::Base::Collection::IList of Socket instances to check for writability + * @param[in,out] pCheckError A Tizen::Base::Collection::IList of Socket instances to check for errors * @param[in] microSeconds The time to wait for a response, in microseconds * @exception E_SUCCESS The method is successful. * @exception E_INVALID_SOCKET The socket is invalid. @@ -99,7 +99,7 @@ public: * @exception E_SYSTEM A system error has occurred. * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. * @remarks This method determines the status of one or more - * Socket instances. There must be at least one socket in an IList + * Socket instances. There must be at least one socket in an Tizen::Base::Collection::IList * before this method is used. * To check sockets for readability and writability use @c pCheckRead and @c pCheckWrite of type * %IList respectively by calling this method. -- 2.7.4