update the header for Doxygen
authorMinkyoung Kang <mklove.kang@samsung.com>
Thu, 28 Mar 2013 08:16:10 +0000 (17:16 +0900)
committerMinkyoung Kang <mklove.kang@samsung.com>
Thu, 28 Mar 2013 08:18:51 +0000 (17:18 +0900)
Change-Id: I13bbf3a512fa5cbe92950b02e26d0cc1c6596877

inc/FWebJsonJsonArray.h
inc/FWebJsonJsonNull.h
inc/FWebJsonJsonObject.h
inc/FWebJsonJsonParser.h
inc/FWebJsonJsonWriter.h

index 9c32547..e0e7c5e 100755 (executable)
@@ -121,7 +121,8 @@ class _OSP_EXPORT_ JsonArray
 {
 public:
        /**
-        * The object is not fully constructed after this constructor is called. For full construction, the Construct() method must be called right after calling this constructor.
+        * The object is not fully constructed after this constructor is called. @n
+        * For full construction, the Construct() method must be called right after calling this constructor.
         *
         * @since       2.0
         */
@@ -184,7 +185,7 @@ public:
        virtual result IndexOf(IJsonValue* const& pJsonValue, int& index) const;
 
        /**
-        * Searches for an element starting from the specified index. @n
+        * Searches for an element starting from the specified @c index. @n
         * Gets the index of the element if it is found.
         *
         * @since           2.0
@@ -256,7 +257,7 @@ public:
         * @return              @c true if value of the current instance equals to value of the specified instance, @n
         *                              else @c false @n
         * @param[in]   obj                     The element to be compared with the current instance of %JsonArray @n
-        *                                              If the specified @c obj is not %JsonArray, this method returns @c false.
+        *                                              If the specified object is not %JsonArray, this method returns @c false.
         *  @see                Tizen::Base::Object::Equals()
         */
        virtual bool Equals(const Object& obj) const;
index e2220a4..627e883 100755 (executable)
@@ -88,7 +88,7 @@ public:
         *      @return                              @c true if the value of the current instance equals the value of the specified instance, @n
         *                                else @c false
         *      @param[in]      obj                  The object to compare with the current instance of %JsonNull @n
-        *                                                      The method returns @c false if the specified @c obj is not %JsonNull.
+        *                                                      If the specified object is not %JsonNull, this method returns @c false.
         *  @see                Tizen::Base::Object::Equals()
         */
        virtual bool Equals(const Object& obj) const;
index a425664..11bc6c2 100755 (executable)
@@ -119,7 +119,8 @@ class _OSP_EXPORT_ JsonObject
 {
 public:
        /**
-        * The object is not fully constructed after this constructor is called. For full construction, the Construct() method must be called right after calling this constructor.
+        * The object is not fully constructed after this constructor is called. @n
+        * For full construction, the Construct() method must be called right after calling this constructor.
         *
         * @since       2.0
         */
@@ -204,7 +205,7 @@ public:
                        else @c false
         *      @param[in]      obj     The object to compare @n
         *                      This object is compared with the current instance of %JsonObject. @n
-        *                              This method returns @c false if the specified @c obj is not of type JSON object.
+        *                              If the specified object is not of type JSON object, this method returns @c false.
         *  @see                Tizen::Base::Object::Equals()
         */
        virtual bool Equals(const Object& obj) const;
index cd1a0b7..81aaec5 100755 (executable)
@@ -167,9 +167,9 @@ public:
         * @param[in] pBuffer              A JSON-encoded buffer
         * @param[in]   bufferLength       A JSON-encoded buffer length
         * @exception   E_SUCCESS                               The method is successful.
-        * @exception   E_INVALID_ARG                   Either of the following conditions has occurred: @n
-        *                                                                      - The specified @c pBuffer is @c null. @n
-        *                                                                      - The specified bufferLength is zero or negative.
+        * @exception   E_INVALID_ARG                   Either of the following conditions has occurred:
+        *                                                                      - The specified @c pBuffer is @c null.
+        *                                                                      - The specified @c bufferLength is zero or negative.
         * @exception   E_INVALID_DATA                  The input JSON data is invalid, or the buffer is empty.
         * @exception   E_MAX_EXCEEDED                  The input JSON data exceeds the maximum length.
         *
index 38835be..e25e69a 100755 (executable)
@@ -126,8 +126,8 @@ public:
         * @param[out]          pBuffer                 The buffer with JSON encoded data.
         * @return              An error code
         * @exception           E_SUCCESS               The method is successful.
-        * @exception           E_INVALID_ARG   Either of the following conditions has occurred: @n
-        *                                                              - The specified @c pBuffer is @c null. @n
+        * @exception           E_INVALID_ARG   Either of the following conditions has occurred:
+        *                                                              - The specified @c pBuffer is @c null.
         *                                                              - The specified bufferLength is negative.
         * @exception           E_INVALID_DATA          The specified @c pValue is @c null.
         */
@@ -140,7 +140,7 @@ public:
         *
         * @param[in]           pValue                  JSON value to be encoded.
         * @param[out]          buffer                  The buffer with JSON-encoded data @n
-        *                                                                      The specified @c buffer has to be constructed with a non-zero capacity before calling this method.
+        *                                                                      The specified buffer has to be constructed with a non-zero capacity before calling this method.
         * @return              An error code
         * @exception           E_SUCCESS               The method is successful.
         * @exception           E_INVALID_DATA          The specified @c pValue is @c null.