Modify Scanner class

[platform/framework/native/appfw.git] / inc / FBaseUtilScanner.h

diff --git a/inc/FBaseUtilScanner.h b/inc/FBaseUtilScanner.h
index fa45525..11b25f4 100644 (file)
--- a/inc/FBaseUtilScanner.h
+++ b/inc/FBaseUtilScanner.h
@@ -52,20 +52,20 @@ namespace Tizen { namespace Base { namespace Utility
  *
  *     ret = scan.IsNextTokenConvertibleToSignedChar();        //ret true
  *     signed char val;
- *  scan.GetNextSignedChar(val);       //val 1
+ *     scan.GetNextSignedChar(val);    //val 1
  *
  *     ret = scan.IsNextTokenConvertibleToShort(10);   //ret true
  *     short shortVal;
- *  scan.GetNextShort(shortVal);       //shortVal 12
+ *     scan.GetNextShort(shortVal);    //shortVal 12
  *
  *     ret = scan.IsNextTokenConvertibleToInt(10);     //ret false
  *     ret = scan.IsNextTokenConvertibleToFloat();     //ret true
  *     float floatVal;
- *  scan.GetNextFloat(floatVal);       //floatVal 34.5
+ *     scan.GetNextFloat(floatVal);    //floatVal 34.5
  *
  *     ret = scan.IsNextTokenConvertibleToInt(16);     //ret true
  *     int intVal;
- *  scan.GetNextInt(intVal, 16);       //intVal 88
+ *     scan.GetNextInt(intVal, 16);    //intVal 88
  *
  *     ret = scan.IsNextTokenConvertibleToBool();      //ret true
  *     scan.GetNextBool(ret);  //ret false
@@ -112,7 +112,7 @@ public:
        * @param[in]    encodingScheme The encoding type of the file
        * @exception    E_SUCCESS        The method is successful.
        * @exception    E_FILE_NOT_FOUND        The input file does not exist.
-       * @exception    E_IO     Invalid file operation
+       * @exception    E_IO      The file operation is invalid.
        * @exception    E_INVALID_ARG  The specified encoding scheme does not exist.
        * @remarks      The supported encoding schemes are ASCII, GSM, UCS-2, UCS-2LE, UCS-2BE, UCS-4, UCS-4LE, UCS-4BE, UTF-8, UTF-16, UTF-16LE, UTF-16BE, UTF-32, UTF-32LE, UTF-32BE, ISO-8859-1~16 (except ISO-8859-12), Windows-874, Windows-1250 ~ Windows-1258, KSC5601, BIG5, GB2312, Shift_JIS, and ISO-2022-jp.
        */
@@ -370,7 +370,8 @@ public:
        * @since 2.1
        * @return       An error code
        * @param[in]    pattern  The string to construct the pattern
-       * @param[out]   nextTok  The next token as an instance of String, or empty string if not matched
+       * @param[out]   nextTok  The next token as an instance of String, @n
+       *                        else an empty string if not matched
        * @exception    E_SUCCESS        The method is successful.
        * @exception    E_DATA_NOT_FOUND        The next token does not match to the pattern.
        * @exception    E_DATA_NOT_ENOUGH          There are no remaining tokens for the current instance of %Scanner.
@@ -383,7 +384,8 @@ public:
        * @since 2.1
        * @return       An error code
        * @param[in]    pattern  The pattern to find.
-       * @param[out]   nextTok  The next token as an instance of String, or empty string if not matched.
+       * @param[out]   nextTok  The next token as an instance of String, @n
+       *                        else an empty string if not matched
        * @exception    E_SUCCESS        The method is successful.
        * @exception    E_DATA_NOT_FOUND        The next token does not match to the pattern.
        * @exception    E_DATA_NOT_ENOUGH          There are no remaining tokens for the current instance of %Scanner.
@@ -548,7 +550,7 @@ public:
        bool HasNextLine(void) const;
 
        /**
-       * Sets the radix of the current instance of %Scanner to the specified @c radix
+       * Sets the radix of the current instance of %Scanner to the specified @c radix.
        *
        * @since 2.1
        * @param[in]    radix     The radix to use for conversion