Fix the doxygen

[framework/osp/social.git] / inc / FSclPhoneNumber.h

diff --git a/inc/FSclPhoneNumber.h b/inc/FSclPhoneNumber.h
index 6273627..65723e2 100644 (file)
--- a/inc/FSclPhoneNumber.h
+++ b/inc/FSclPhoneNumber.h
@@ -45,7 +45,7 @@ namespace Tizen { namespace Social
 using namespace Tizen::Base;
 using namespace Tizen::Social::Services;
 
-void
+result
 MyClass::SomeMethod(void)
 {
        result r = E_SUCCESS;
@@ -93,7 +93,7 @@ public:
         *
         * @since       2.0
         *
-        * @param[in]   rhs             An instance of %PhoneNumber
+        * @param[in]   rhs             An instance of %PhoneNumber to copy
         */
        PhoneNumber(const PhoneNumber& rhs);
 
@@ -120,7 +120,7 @@ public:
         *
         * @since       2.0
         *
-        * @return      An integer value indicating the hash value of the current instance of Tizen::Base::Object
+        * @return      The integer value that indicates the hash value of the current instance of Tizen::Base::Object
         */
        virtual int GetHashCode(void) const;
 
@@ -144,11 +144,11 @@ public:
         * @if OSPCOMPAT
      * @page                CompPhoneNumberGetTypePage         Compatibility for GetType()
      * @section             CompPhoneNumberGetTypePageIssueSection             Issues
-        * Implementing this method in OSP compatible applications has the following issue: @n
-     * -# PHONENUMBER_TYPE_CUSTOM is not supported. If the type of the phone number is PHONENUMBER_TYPE_CUSTOM, PHONENUMBER_TYPE_OTHER is returned instead.
+        *                                              Implementing this method in OSP compatible applications has the following issue: @n
+     *                                                 -# PHONENUMBER_TYPE_CUSTOM is not supported. If the type of the phone number is PHONENUMBER_TYPE_CUSTOM, PHONENUMBER_TYPE_OTHER is returned instead.
      *
      * @section             CompPhoneNumberGetTypePageSolutionSection          Resolutions
-        * The issue mentioned above has been resolved in Tizen.
+        *                                              The issue mentioned above has been resolved in Tizen.
         * @endif
      */
 
@@ -182,10 +182,10 @@ public:
         *                            For more information, see @ref CompPhoneNumberSetPhoneNumberPage "here".
         * @endif
         *
-        * @return      An error code
-        * @param[in]   number          The phone number to set
-        * @exception   E_SUCCESS       The method is successful.
-        * @exception   E_INVALID_ARG   The specified number is an empty string.
+        * @return          An error code
+        * @param[in]   number                  The phone number to set
+        * @exception   E_SUCCESS               The method is successful.
+        * @exception   E_INVALID_ARG   The specified @c number is an empty string.
         */
        result SetPhoneNumber(const Tizen::Base::String& number);
 
@@ -193,12 +193,12 @@ public:
         * @if OSPCOMPAT
         * @page                CompPhoneNumberSetPhoneNumberPage               Compatibility for SetPhoneNumber()
         * @section             CompPhoneNumberSetPhoneNumberPageIssueSection           Issues
-        * Implementing this method in OSP compatible applications has the following issue: @n
-        * -# If the length of the phone number to be set is greater than 50 characters, E_INVALID_ARG is returned.
-        * -# Only alphabets (a~z, A~Z), numbers, plus (+), asterisk (*), pound (#), and comma (,) are allowed.
+        *                              Implementing this method in OSP compatible applications has the following issue: @n
+        *                              -# If the length of the phone number to be set is greater than 50 characters, @c E_INVALID_ARG is returned.
+        *                              -# Only alphabets (a~z, A~Z), numbers, plus (+), asterisk (*), pound (#), and comma (,) are allowed.
         *
         * @section             CompPhoneNumberSetPhoneNumberPageSolutionSection                Resolutions
-        * The issue mentioned above has been resolved in Tizen.
+        *                              The issue mentioned above has been resolved in Tizen.
         * @endif
         */
 
@@ -227,7 +227,7 @@ public:
         *
         * @since       2.0
         *
-        * @param[in]   rhs     An instance of %PhoneNumber
+        * @param[in]   rhs     An instance of %PhoneNumber to copy
         */
        PhoneNumber& operator =(const PhoneNumber& rhs);