Merge reviewed doxygen.

Change-Id: I6efee49cdb0c04c04620c0376f5a223a8c4b3163
Signed-off-by: eh1112.kim <eh1112.kim@samsung.com>

diff --git a/inc/FTelCallInfo.h b/inc/FTelCallInfo.h
index 81626ce..4a17ca4 100755 (executable)
--- a/inc/FTelCallInfo.h
+++ b/inc/FTelCallInfo.h
@@ -59,14 +59,14 @@ public:
        CallInfo(const CallInfo& rhs);
 
        /**
-     * This destructor overrides Tizen::Base::Object::~Object().        
+     * This destructor overrides Tizen::Base::Object::~Object().
      *
      * @since   2.0
      */
        virtual ~CallInfo(void);
 
        /**
-     * Gets the call type of a call.
+     * Gets the call type.
      *
      * @since   2.0
      *
@@ -92,7 +92,7 @@ public:
     * @return   @c true if the specified instance equals the current instance, @n
     *           else @c false
     * @param[in]    obj An instance of %CallInfo
-    * @remarks The method returns @c false if the specified object is not %CallInfo.
+    * @remarks This method returns @c false if the specified object is not %CallInfo.
     */
        virtual bool Equals(const Tizen::Base::Object& obj) const;
 
@@ -106,7 +106,7 @@ public:
        virtual int GetHashCode(void) const;
 
        /**
-     * Copying of objects using this copy assignment operator is allowed.       
+     * Copying of objects using this copy assignment operator is allowed.
      *
      * @since 2.0
      *

diff --git a/inc/FTelCallManager.h b/inc/FTelCallManager.h
index abf921f..5aff7bb 100755 (executable)
--- a/inc/FTelCallManager.h
+++ b/inc/FTelCallManager.h
@@ -155,7 +155,7 @@ public:
 
        /**
      * Requests call forwarding with the specified number. @n
-     * This method sends the request to the network, and receives the response asynchronously.
+     * The %RequestCallForward() method sends the request to the network, and receives the response asynchronously.
      *
      * @since   2.0
         *

diff --git a/inc/FTelISimStateManagerGetPinLockSettingResultListener.h b/inc/FTelISimStateManagerGetPinLockSettingResultListener.h
old mode 100644 (file)
new mode 100755 (executable)
index d54c9a5..1a8b7e4
--- a/inc/FTelISimStateManagerGetPinLockSettingResultListener.h
+++ b/inc/FTelISimStateManagerGetPinLockSettingResultListener.h
@@ -32,11 +32,11 @@ namespace Tizen { namespace Telephony
 {
 /**
  * @interface   ISimStateManagerGetPinLockSettingResultListener
- * @brief              This interface provides methods to receive the result of the %SimStateManager class asynchronous method.
+ * @brief              This interface provides methods to receive the result of the SimStateManager::GetPinLockSetting() asynchronous method.
  *
  * @since              2.1
  *
- * The %ISimStateManagerGetPinLockSettingResultListener interface provides methods to receive the result of the %SimStateManager class asynchronous method.
+ * The %ISimStateManagerGetPinLockSettingResultListener interface provides methods to receive the result of the SimStateManager::GetPinLockSetting() asynchronous method.
  *
  */
 class _OSP_EXPORT_ ISimStateManagerGetPinLockSettingResultListener
@@ -52,15 +52,15 @@ public:
 
 public:
        /**
-        * Called when a response of the PIN lock setting query is received.
+        * Called when a response to the PIN lock setting query is received.
         *
         * @since               2.1
         *
-        * @param[in]   isEnabled               PIN lock setting value
-        * @param[in]   r                               The result of the request. The following exception may be given through this parameter.
+        * @param[in]   isEnabled               The PIN lock setting value
+        * @param[in]   r                               The result of the request @n The following exceptions may be given through this parameter.
         *
         * @exception   E_SUCCESS               The method is successful.
-        * @exception   E_INVALID_STATE         The SIM is in invalid state.
+        * @exception   E_INVALID_STATE         The SIM is in an invalid state.
         */
        virtual void OnSimStateManagerGetPinLockSettingResultReceived(bool isEnabled, result r) = 0;
 

diff --git a/inc/FTelITelephonySimEventListener.h b/inc/FTelITelephonySimEventListener.h
old mode 100644 (file)
new mode 100755 (executable)
index 63abd36..d720f36
--- a/inc/FTelITelephonySimEventListener.h
+++ b/inc/FTelITelephonySimEventListener.h
@@ -36,7 +36,7 @@ namespace Tizen { namespace Telephony
  *
  * @since       2.1
  *
- * The %ITelephonySimEventListener interface checks for the change in state in the SIM card.
+ * The %ITelephonySimEventListener interface checks for the change in state of the SIM card.
  *
  */
 class _OSP_EXPORT_ ITelephonySimEventListener

diff --git a/inc/FTelNetworkManager.h b/inc/FTelNetworkManager.h
index c08a98c..057d8fd 100755 (executable)
--- a/inc/FTelNetworkManager.h
+++ b/inc/FTelNetworkManager.h
@@ -216,7 +216,7 @@ public:
      *
      * @since 2.0
      *
-     * @privleve       platform
+     * @privlevel      platform
      * @privilege   %http://tizen.org/privilege/telephonymanager
      *
      * @return  An error code

diff --git a/inc/FTelSimInfo.h b/inc/FTelSimInfo.h
index 7be54a7..49d67ba 100755 (executable)
--- a/inc/FTelSimInfo.h
+++ b/inc/FTelSimInfo.h
@@ -115,7 +115,7 @@ public:
         * Initializes this instance of %SimInfo.
         *
         * @brief   <i> [Deprecated] </i>
-        * @deprecated  This method is deprecated. Instead of using this method, it is recommended to use the SimStateManager::GetSimInfo() method to get the initialized SimInfo instance.
+        * @deprecated  This method is deprecated. Instead of using this method, it is recommended to use the SimStateManager::GetSimInfo() method to get the initialized %SimInfo instance.
         *
         * @since               2.0
         *
@@ -181,7 +181,7 @@ public:
        /**
         * Gets the Integrated Circuit Card Identifier (ICCID) of the SIM card. @n
         * One useful case to detect the change of SIM cards is to store this value and compare it with the most recent value.
-        * This method provides a unique identification number for the SIM card.
+        * The %GetIccId() method provides a unique identification number for the SIM card.
         *
         * @since       2.0
         *
@@ -302,7 +302,7 @@ public:
         *
         * @return              @c true if the values match, @n
         *                              else @c false
-        * @param[in]   rhs     The other Object to be compared
+        * @param[in]   rhs     The other Tizen::Base::Object to compare
         * @see                 Tizen::Base::Object::Equals()
         */
        virtual bool Equals(const Tizen::Base::Object& rhs) const;
@@ -312,7 +312,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/FTelSimStateManager.h b/inc/FTelSimStateManager.h
old mode 100644 (file)
new mode 100755 (executable)
index d2b891a..c733184
--- a/inc/FTelSimStateManager.h
+++ b/inc/FTelSimStateManager.h
@@ -62,7 +62,7 @@ public:
        virtual ~SimStateManager(void);
 
        /**
-        * Initializes a new instance of this class.
+        * Initializes this instance of %SimStateManager.
         *
         * @since       2.1
         *
@@ -75,7 +75,7 @@ public:
        result Construct(void);
 
        /**
-        * Sets the listener for receiving SIM related events.
+        * Sets the listener for receiving SIM-related events.
         *
         * @since   2.1
         *
@@ -95,8 +95,8 @@ public:
        result SetSimEventListener(ITelephonySimEventListener* pListener);
 
        /**
-        * Requests the PIN lock setting information. @n
-        * This method is asynchronous.
+        * Requests for the PIN lock setting information. @n
+        * The %GetPinLockSetting() method is asynchronous.
         *
         * @since   2.1
         *
@@ -106,7 +106,6 @@ public:
         * @return  An error code
         *
         * @param[in]   pListener                               An ISimStateManagerGetPinLockSettingResultListener instance
-        *
         * @exception   E_SUCCESS                               The method is successful.
         * @exception   E_INVALID_ARG                   The specified @c pListener must not be @c null.
         * @exception   E_IN_PROGRESS                   The previous request is in progress.
@@ -126,7 +125,7 @@ public:
         * @privilege   %http://tizen.org/privilege/telephony
         *
         * @return      The state of SIM card, @n
-        *                              else SIM_STATE_UNKNOWN if the method fails
+        *                              else @c SIM_STATE_UNKNOWN if the method fails
         *
         * @exception   E_SUCCESS                               The method is successful.
         * @exception   E_PRIVILEGE_DENIED              The application does not have the privilege to call this method.
@@ -144,7 +143,6 @@ public:
         * @return  An error code
         *
         * @param[out]  simInfo                                 The SIM card information
-        *
         * @exception   E_SUCCESS                               The method is successful.
         * @exception   E_PRIVILEGE_DENIED              The application does not have the privilege to call this method.
         * @exception   E_DEVICE_UNAVAILABLE    The operation has failed due to a missing SIM card.

diff --git a/inc/FTelTypes.h b/inc/FTelTypes.h
old mode 100644 (file)
new mode 100755 (executable)
index 077f78f..d99ad7f
--- a/inc/FTelTypes.h
+++ b/inc/FTelTypes.h
@@ -16,9 +16,9 @@
 //
 /**
  * @file    FTelTypes.h
- * @brief   This is the header file for the enumerations of the Tizen::Telephony namespace.
+ * @brief   This is the header file for the enumerations of the Telephony namespace.
  *
- * This header file contains the definitions of the enumerations of the Tizen::Telephony namespace.
+ * This header file contains the definitions of the enumerations of the Telephony namespace.
  */
 #ifndef _FTEL_ENUM_H_
 #define _FTEL_ENUM_H_
@@ -76,7 +76,7 @@ enum SimType
 /**
  * @enum       SimState
  *
- * Defines the current state of SIM card.
+ * Defines the current state of the SIM card.
  *
  * @since      2.1
  */
@@ -84,12 +84,12 @@ enum SimState
 {
        SIM_STATE_UNKNOWN,                      /**< Unknown state */
        SIM_STATE_ABSENT,                       /**< SIM is not present */
-       SIM_STATE_INITIALIZING,         /**< SIM is on initializing */
-       SIM_STATE_READY,                        /**< SIM is ready*/
+       SIM_STATE_INITIALIZING,         /**< SIM is in initializing state */
+       SIM_STATE_READY,                        /**< SIM is in ready state */
        SIM_STATE_PIN_REQUIRED,         /**< PIN required */
        SIM_STATE_PUK_REQUIRED,         /**< PUK required */
-       SIM_STATE_NETWORK_LOCKED,       /**< Network locked */
-       SIM_STATE_SIM_LOCKED            /**< PH-SIM (phone-SIM) locked */
+       SIM_STATE_NETWORK_LOCKED,       /**< Network locked state */
+       SIM_STATE_SIM_LOCKED            /**< PH-SIM (phone-SIM) locked state */
 };
 
 }} // Tizen::Telephony