Fix the boiler plate codes
[platform/framework/native/appfw.git] / inc / FIoDataSetEnumerator.h
index 2b80057..59a0373 100755 (executable)
@@ -1,5 +1,4 @@
 //\r
-// Open Service Platform\r
 // Copyright (c) 2013 Samsung Electronics Co., Ltd.\r
 //\r
 // Licensed under the Apache License, Version 2.0 (the License);\r
@@ -81,8 +80,8 @@ public:
        *                                                                               - An unexpected device failure has occurred as the media ejected suddenly. @n\r
        *                                                                               - %File corruption is detected.\r
        * @exception            E_SYSTEM                        The method cannot proceed due to a severe system error.\r
-       * @remarks              After getting this DataSetEnumerator instance,\r
-       *                               if MoveNext() is called at first, the cursor goes to the first position.\r
+       * @remarks              After getting this %DataSetEnumerator instance,\r
+       *                               if this method is called first, the cursor goes to the first position.\r
        * @see                  Tizen::Io::DataSetEnumerator::MovePrevious()\r
        * @see                  Tizen::Io::DataSetEnumerator::MoveFirst()\r
        * @see                  Tizen::Io::DataSetEnumerator::MoveLast()\r
@@ -211,13 +210,13 @@ public:
        virtual result GetDoubleAt(int columnIndex, double& value) const;\r
 \r
        /**\r
-       * Gets a @c String value from the column whose index is specified.\r
+       * Gets a Tizen::Base::String value from the column whose index is specified.\r
        *\r
        * @since                2.1\r
        *\r
        * @return               An error code\r
        * @param[in]            columnIndex                     The index of the column whose value is required\r
-       * @param[in,out]        value                           The String value obtained from the specified column\r
+       * @param[in,out]        value                           The Tizen::Base::String value obtained from the specified column\r
        * @exception            E_SUCCESS                       The method is successful.\r
        * @exception            E_INVALID_STATE         The DataSet instance associated with this instance is deleted.\r
        * @exception            E_INVALID_ARG           The specified @c columnIndex is out of range.\r
@@ -227,22 +226,21 @@ public:
        virtual result GetStringAt(int columnIndex, Tizen::Base::String& value) const;\r
 \r
        /**\r
-       * Gets a @c ByteBuffer value from the column whose index is specified.\r
+       * Gets a Tizen::Base::ByteBuffer value from the column whose index is specified.\r
        *\r
        * @since                2.1\r
        *\r
        * @return               An error code\r
        * @param[in]            columnIndex                     The index of the column whose value is required\r
-       * @param[in,out]        value                           The ByteBuffer value obtained from the specified column @n\r
-       *                                                                       The ByteBuffer will be filled from the current position and data copy\r
-       *                                                                               will be continued until ByteBuffer limitation is reached or no more\r
-       *                                                                               blob data remains. @n\r
+       * @param[in,out]        value                           The Tizen::Base::ByteBuffer value obtained from the specified column @n\r
+       *                                                                       The %Tizen::Base::ByteBuffer will be filled from the current position and data copy\r
+       *                                                                               will be continued until %Tizen::Base::ByteBuffer limitation is reached or no more\r
+       *                                                                               blob data remains.\r
        * @exception            E_SUCCESS                       The method is successful.\r
        * @exception            E_INVALID_STATE         The DataSet instance associated with this instance is deleted.\r
-\r
        * @exception            E_INVALID_ARG           The specified @c columnIndex is out of range.\r
        * @exception            E_TYPE_MISMATCH The operation has attempted to access columns of different types.\r
-       * @exception            E_OVERFLOW                      The specified ByteBuffer @c value is insufficient to save the data.\r
+       * @exception            E_OVERFLOW                      The specified Tizen::Base::ByteBuffer @c value is insufficient to save the data.\r
        * @see                  Tizen::Base::ByteBuffer\r
        */\r
        virtual result GetBlobAt(int columnIndex, Tizen::Base::ByteBuffer& value) const;\r
@@ -254,24 +252,24 @@ public:
        *\r
        * @return               An error code\r
        * @param[in]            columnIndex                     The index of the column whose value is required\r
-       * @param[in,out]        buffer                          The user-provided buffer used to receive the blob data @n\r
+       * @param[in,out]        buffer                          The user-provided buffer used to receive the blob data\r
        * @param[in]            size                                    The maximum buffer length in bytes\r
        * @exception            E_SUCCESS                       The method is successful.\r
        * @exception            E_INVALID_STATE         The DataSet instance associated with this instance is deleted.\r
-       * @exception            E_INVALID_ARG           The specified @c columnIndex is out of range, or the specified @c size is invalid.\r
+       * @exception            E_INVALID_ARG           Either the specified @c columnIndex is out of range or the specified @c size is invalid.\r
        * @exception            E_TYPE_MISMATCH The operation has attempted to access columns of different types.\r
        * @exception            E_OVERFLOW                      The specified @c buffer is insufficient to save the data.\r
        */\r
        virtual result GetBlobAt(int columnIndex, void* buffer, int size) const;\r
 \r
        /**\r
-       * Gets a @c DateTime value from the column whose index is specified.\r
+       * Gets a Tizen::Base::DateTime value from the column whose index is specified.\r
        *\r
        * @since                2.1\r
        *\r
        * @return               An error code\r
        * @param[in]            columnIndex                     The index of the column whose value is required\r
-       * @param[in,out]        value                           The DateTime value obtained from the specified column\r
+       * @param[in,out]        value                           The Tizen::Base::DateTime value obtained from the specified column\r
        * @exception            E_SUCCESS                       The method is successful.\r
        * @exception            E_INVALID_STATE         The DataSet instance associated with this instance is deleted.\r
        * @exception            E_INVALID_ARG           The specified @c columnIndex is out of range.\r
@@ -292,30 +290,30 @@ public:
        *                               else @c -1 if an exception occurs\r
        * @exception            E_SUCCESS                       The method is successful.\r
        * @exception            E_INVALID_STATE         The DataSet instance associated with this instance is deleted.\r
-       * @remarks              The method must be called after MoveNext(), MoveFirst(), or MoveLast(). @n\r
+       * @remarks              This method must be called after MoveNext(), MoveFirst(), or MoveLast(). @n\r
        *                               The specific error code can be accessed using the GetLastResult() method.\r
        */\r
        virtual int GetColumnCount(void) const;\r
 \r
        /**\r
-       * Gets the type of the column indicated by the specified index.\r
+       * Gets the type of the column indicated by a specified index.\r
        *\r
        * @since                2.1\r
        *\r
        * @return               The type of column, @n\r
-       *                               else DB_COLUMNTYPE_UNDEFINED if an exception occurs\r
+       *                               else @c DB_COLUMNTYPE_UNDEFINED if an exception occurs\r
        * @param[in]            columnIndex                     The index of the destination column\r
        * @exception            E_SUCCESS                       The method is successful.\r
        * @exception            E_INVALID_STATE         The DataSet instance associated with this instance is deleted.\r
        * @exception            E_INVALID_ARG           The specified @c columnIndex is out of range.\r
-       * @remarks              The method must be called after MoveNext(), MoveFirst(), or MoveLast(). @n\r
-       *                               Currently, DB_COLUMNTYPE_INT is returned for a 64-bit integer. @n\r
+       * @remarks              This method must be called after MoveNext(), MoveFirst(), or MoveLast(). @n\r
+       *                               Currently, @c DB_COLUMNTYPE_INT is returned for a 64-bit integer. @n\r
        *                               The specific error code can be accessed using the GetLastResult() method.\r
        */\r
        virtual DbColumnType GetColumnType(int columnIndex) const;\r
 \r
        /**\r
-       * Gets the name of the column indicated by the specified index.\r
+       * Gets the name of the column indicated by a specified index.\r
        *\r
        * @since                2.1\r
        *\r
@@ -326,7 +324,7 @@ public:
        * @exception            E_INVALID_STATE         The DataSet instance associated with this instance is deleted.\r
        * @exception            E_INVALID_ARG           The specified @c columnIndex is out of range.\r
        * @exception            E_INVALID_ENCODING_RANGE        The string conversion has failed due to invalid encoding range.\r
-       * @remarks              The method must be called after MoveNext(), MoveFirst(), or MoveLast(). @n\r
+       * @remarks              This method must be called after MoveNext(), MoveFirst(), or MoveLast(). @n\r
        *                               The specific error code can be accessed using the GetLastResult() method.\r
        */\r
        virtual Tizen::Base::String GetColumnName(int columnIndex) const;\r
@@ -342,7 +340,7 @@ public:
        * @exception            E_SUCCESS                       The method is successful.\r
        * @exception            E_INVALID_STATE         The DataSet instance associated with this instance is deleted.\r
        * @exception            E_INVALID_ARG           The specified @c columnIndex is out of range.\r
-       * @remarks              The method must be called after MoveNext(), MoveFirst(), or MoveLast(). @n\r
+       * @remarks              This method must be called after MoveNext(), MoveFirst(), or MoveLast(). @n\r
        *                               If the destination column is of type String, this method returns the @c byte length excluding\r
        *                                       the @c null terminator character. @n\r
        *                               The specific error code can be accessed using the GetLastResult() method.\r