update header for Doxygen
authorMinkyoung Kang <mklove.kang@samsung.com>
Wed, 17 Apr 2013 06:17:25 +0000 (15:17 +0900)
committerMinkyoung Kang <mklove.kang@samsung.com>
Wed, 17 Apr 2013 06:17:25 +0000 (15:17 +0900)
Change-Id: Ied82df2476c200779999e15e77219f28e60ea284

inc/FWebJson.h
inc/FWebJsonIJsonValue.h
inc/FWebJsonJsonArray.h
inc/FWebJsonJsonBool.h
inc/FWebJsonJsonNull.h
inc/FWebJsonJsonNumber.h
inc/FWebJsonJsonObject.h
inc/FWebJsonJsonParser.h
inc/FWebJsonJsonString.h
inc/FWebJsonJsonWriter.h

index 6288225..9701659 100644 (file)
@@ -42,7 +42,7 @@
  *                             @b Library : @b osp-web
  *
  * The %Json namespace contains interfaces to manipulate the JSON documents.
- * @n
+ * 
  * For more information on the %Json namespace features, see <a href="../org.tizen.native.appprogramming/html/guide/web/json_namespace.htm">JSON Guide</a>.
  *
  * The following diagram illustrates the relationships between the classes belonging to the %Json namespace. 
index 81ae0d9..a94252d 100644 (file)
@@ -49,19 +49,20 @@ enum JsonType
 
 /**
  * @interface  IJsonValue
- * @brief      This interface represents a Json value.
+ * @brief      This interface represents a JSON value.
  *
  * @since      2.0
  *
- * The %IJsonValue interface abstracts a Json value class of a %Json value type (string, bool, number, array, object, and null type).
- * @n
+ * The %IJsonValue interface abstracts a JSON value class of a JSON value type (string, bool, number, array, object, and null type).
+ * 
  * For more information on the class features, see <a href="../org.tizen.native.appprogramming/html/guide/web/json_namespace.htm">JSON Guide</a>.
  */
 class _OSP_EXPORT_ IJsonValue
 {
 public:
        /**
-        * This polymorphic destructor should be overridden if required. This way, the destructors of the derived classes are called when the destructor of this interface is called.
+        * This polymorphic destructor should be overridden if required. @n
+        * This way, the destructors of the derived classes are called when the destructor of this interface is called.
         *
         * @since       2.0
         */
index e33d82f..7997810 100644 (file)
@@ -50,7 +50,7 @@ namespace Tizen { namespace Web { namespace Json
  * @final      This class is not intended for extension.
  *
  * The %JsonArray class represents the JSON value of type array.
- * @n
+ * 
  * For more information on the class features, see <a href="../org.tizen.native.appprogramming/html/guide/web/json_namespace.htm">JSON Guide</a>.
  *
  * The following example demonstrates how to create and initialize a %JsonArray instance and how to use its methods.
@@ -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
         */
@@ -213,9 +214,9 @@ public:
         * @param[in]   count                           The number of elements to read
         * @param[out]  index                           The index of the element
         * @exception   E_SUCCESS                       The method is successful.
-        * @exception   E_OUT_OF_RANGE          Either of the following conditions has occurred: @n
-        *                                                                      - The specified @c index is outside the bounds of the data structure. @n
-        *                                                                      - The specified @c startIndex is either greater than or equal to the number of elements or less than @c 0. @n
+        * @exception   E_OUT_OF_RANGE          Either of the following conditions has occurred:
+        *                                                                      - The specified @c index is outside the bounds of the data structure.
+        *                                                                      - The specified @c startIndex is either greater than or equal to the number of elements or less than @c 0.
         *                                                                      - The specified @c count is either greater than the number of elements starting from @c startIndex or less than @c 0.
         * @exception   E_OBJ_NOT_FOUND         The specified @c pJsonValue is not found.
         * @see                 LastIndexOf()
@@ -333,8 +334,8 @@ public:
         *                                      else @c false
         * @exception   E_SUCCESS                               The method is successful.
         * @exception   E_OUT_OF_RANGE                  Either of the following conditions has occurred:
-        *                                                                              - The specified index is outside the bounds of the list.
-        *                                                                              - The specified @c startIndex is either greater than or equal to the number of elements or less than @c 0. @n
+        *                                                                              - The specified @c startIndex is outside the bounds of the list.
+        *                                                                              - The specified @c startIndex is either greater than or equal to the number of elements or less than @c 0.
         *                                                                              - The specified @c count is either greater than the number of elements starting from @c startIndex or less than @c 0.
         */
        virtual result RemoveItems(int startIndex, int count, bool deallocate = false);
index 1d2bc96..5d9d2a7 100644 (file)
@@ -46,7 +46,7 @@ namespace Tizen { namespace Web { namespace Json
  * @final      This class is not intended for extension.
  *
  * The %JsonBool class represents the JSON value of type @c bool.
- * @n
+ * 
  * For more information on the class features, see <a href="../org.tizen.native.appprogramming/html/guide/web/json_namespace.htm">JSON Guide</a>.
  *
  *
index cd564e5..55a974a 100644 (file)
@@ -46,9 +46,8 @@ namespace Tizen { namespace Web { namespace Json
  * @final      This class is not intended for extension.
  *
  * The %JsonNull class represents the JSON value of type @c null.
- * @n
+ * 
  * For more information on the class features, see <a href="../org.tizen.native.appprogramming/html/guide/web/json_namespace.htm">JSON Guide</a>.
-
  *
  */
 class _OSP_EXPORT_ JsonNull
index 3378114..71d6d29 100644 (file)
@@ -46,7 +46,7 @@ namespace Tizen { namespace Web { namespace Json
  * @final      This class is not intended for extension.
  *
  * The %JsonNumber class represents the type of the JSON number.
- * @n
+ * 
  * For more information on the class features, see <a href="../org.tizen.native.appprogramming/html/guide/web/json_namespace.htm">JSON Guide</a>.
 
  *
index 9294b20..b9e607b 100644 (file)
@@ -53,7 +53,7 @@ namespace Tizen { namespace Web { namespace Json
  * @final      This class is not intended for extension.
  *
  * The %JsonObject class represents the JSON value of type object.
- * @n
+ * 
  * For more information on the class features, see <a href="../org.tizen.native.appprogramming/html/guide/web/json_namespace.htm">JSON Guide</a>.
  *
  * The following example demonstrates how to create and initialize a %JsonObject instance and how to use its methods.
@@ -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
         */
index ab20926..02a834a 100644 (file)
@@ -42,7 +42,7 @@ namespace Tizen { namespace Web { namespace Json
  * @since      2.0
  *
  * The %JsonParser class contains the declarations of the JSON functionalities for parsing the JSON-encoded files.
- * @n
+ * 
  * For more information on the class features, see <a href="../org.tizen.native.appprogramming/html/guide/web/json_namespace.htm">JSON Guide</a>.
  *
  * The following example demonstrates how to use the %JsonParser methods.
index 57dc497..7c9bf2a 100644 (file)
@@ -45,7 +45,7 @@ namespace Tizen { namespace Web { namespace Json
  * @final      This class is not intended for extension.
  *
  * The %JsonString class represents the JSON value of type string.
- * @n
+ * 
  * For more information on the class features, see <a href="../org.tizen.native.appprogramming/html/guide/web/json_namespace.htm">JSON Guide</a>.
 
  *
index aea77b1..a6ee8fb 100755 (executable)
@@ -43,7 +43,7 @@ namespace Tizen { namespace Web { namespace Json
  * @since      2.0
  *
  * The %JsonWriter class contains the declarations of the JSON functionalities for composing JSON-encoded files.
- * @n
+ * 
  * For more information on the class features, see <a href="../org.tizen.native.appprogramming/html/guide/web/json_namespace.htm">JSON Guide</a>.
  *
  * The following example demonstrates how to use the %JsonWriter methods.