Init Tizen 2.2.1

[framework/osp/vision.git] / inc / FUixVisionQrCodeRecognizer.h

diff --git a/inc/FUixVisionQrCodeRecognizer.h b/inc/FUixVisionQrCodeRecognizer.h
index d92badf..f0545ea 100644 (file)
--- a/inc/FUixVisionQrCodeRecognizer.h
+++ b/inc/FUixVisionQrCodeRecognizer.h
@@ -132,22 +132,21 @@ public:
 
     /**
      * Initializes this instance of %QrCodeRecognizer. @n
-     * Every application must call %Construct() before calling any other methods of %QrCodeRecognizer.
+     * Every application must call the %Construct() method before calling any other method of %QrCodeRecognizer.
      *
      * @since        2.1
      *
      * @feature      %http://tizen.org/feature/vision.qrcode_recognition
      *
-     * @exception    E_SUCCESS          The method is successful.
+     * @exception    E_SUCCESS                    The method is successful.
      * @exception    E_UNSUPPORTED_OPERATION   The Emulator or target device does not support the required feature. 
-     * For more information, see <a href="../org.tizen.gettingstarted/html/tizen_overview/application_filtering.htm">Application Filtering</a>.
-     * @remarks      Before calling this method, check whether the feature is supported by 
-        *                      Tizen::System::SystemInfo::GetValue(const Tizen::Base::String&, bool&).
+     *                                                                                    For more information, see <a href="../org.tizen.gettingstarted/html/tizen_overview/application_filtering.htm">Application Filtering</a>.
+     * @remarks      Before calling this method, check whether the feature is supported by Tizen::System::SystemInfo::GetValue(const Tizen::Base::String&, bool&).
      */
     result Construct(void);
 
     /**
-     * Sets the width and height of an input image.
+     * Sets the width and the height of the input image.
      *
      * @since        2.1
      *
@@ -157,21 +156,23 @@ public:
      * @param[in]    height              The height of the frame in pixels
      * @exception    E_SUCCESS           The method is successful.
      * @exception    E_INVALID_ARG       A specified input parameter is invalid.
-     * @remarks      This method must be called once before calling ProcessImage().
+     * @remarks      This method must be called once before calling the ProcessImage() method.
      */
     result SetImageSize(int width, int height);
 
     /**
-     * Processes an input image for recognition.
+     * Processes the input image for recognition.
      *
      * @since        2.1
      *
      * @return       An error code
      *
      * @param[in]    imageBuffer        The input image buffer @n
-     *                                  It must be allocated outside and have size of (width*height) set by SetImageSize().
+     *                                  It must be allocated externally and have a size of (width*height) set by SetImageSize().
      * @exception    E_SUCCESS          The method is successful.
-     * @exception    E_INVALID_ARG      The specified @c imageBuffer is not allocated or the size of @c imageBuffer is not equal to the input image size set by SetImageSize().
+     * @exception    E_INVALID_ARG      Either of the following conditions has occurred;
+        *                                                                      - The specified @c imageBuffer is not allocated 
+        *                                                                      - The size of the specified @c imageBuffer is not equal to the input image size set by SetImageSize().
      * @exception    E_OUT_OF_MEMORY    The memory is insufficient.
      */
     result ProcessImage(const Tizen::Base::ByteBuffer& imageBuffer);
@@ -186,30 +187,30 @@ public:
      * @exception    E_SUCCESS           The method is successful.
      * @exception    E_INVALID_ARG       The specified input parameter is invalid.
      *
-     * @remarks      The ROI is used to reset camera focus to get better image and it can be obtained after calling ProcessImage() at least once.
+     * @remarks      The ROI is used to reset the camera focus to get a better image and it can be obtained after calling the ProcessImage() method at least once.
      */
     result GetFocusRoi(Tizen::Graphics::Rectangle& roi);
 
     /**
-     * Gets a count of the recognized QR code object.
+     * Gets the count of the recognized QR code object.
      *
      * @since        2.1
      *
-     * @return       A count of the recognized QR code object
+     * @return       The count of the recognized QR code object
      *
-     * @remarks      The recognized QR code object has index value from @c 0 to (count of the recognized QR code objects - 1)
-     * @see          GetRecognizedObject(int)
+     * @remarks      The recognized QR code object has an index value that ranges from @c 0 to (count of the recognized QR code objects) @c - 1.
+     * @see          GetRecognizedObject()
      */
     int GetRecognizedObjectCount(void);
 
     /**
-     * Gets the recognized QR code object to get information.
+     * Gets the recognized QR code object that contains the information.
      *
      * @since        2.1
      *
-     * @return       A pointer to QrCodeObject that includes all information about the recognized QR code object
+     * @return       A pointer to the QrCodeObject that includes all the information about the recognized QR code object
      * @param[in]    index          The index of the recognized QR code object @n
-     *                              Valid range of this parameter is @c 0 to (count of the recognized QR code objects - 1).
+     *                              The valid range for this parameter is @c 0 to (count of the recognized QR code objects) @c - 1.
      * @exception    E_SUCCESS      The method is successful.
      *
      * @see          GetRecognizedObjectCount()