From: ikhwan.cho <ikhwan.cho@samsung.com>
Date: Fri, 12 Apr 2013 04:39:20 +0000 (+0900)
Subject: modify doxygen comments
X-Git-Tag: accepted/tizen_2.1/20130425.033135~10
X-Git-Url: http://review.tizen.org/git/?p=platform%2Fframework%2Fnative%2Fvision.git;a=commitdiff_plain;h=5b3aaf3d22275ce7786ff823299bde1f2770e0ba

modify doxygen comments

Change-Id: Ie2d1460a9603f6e6240b6e1b4b3146e357b3a713
Signed-off-by: ikhwan.cho <ikhwan.cho@samsung.com>
---

diff --git a/inc/FUixVisionImageFeatureManager.h b/inc/FUixVisionImageFeatureManager.h
index 0039e93..176996b 100644
--- a/inc/FUixVisionImageFeatureManager.h
+++ b/inc/FUixVisionImageFeatureManager.h
@@ -36,7 +36,7 @@ namespace Tizen { namespace Uix { namespace Vision
 
 /**
  * @class    ImageFeatureManager
- * @brief    This class provides methods to generate individual feature data from an individual image data.
+ * @brief    This class provides methods to generate individual feature data from an individual image data and collect to feature set file.
  *
  * @since    2.1
  *
@@ -49,6 +49,16 @@ namespace Tizen { namespace Uix { namespace Vision
  * {
  *     Tizen::Uix::Vision::ImageFeatureManager imageFeatureManager;
  *     imageFeatureManager.Construct();
+ *     imageFeatureManager.AddFeature("/opt/usr/media/Images/image1.jpg");
+ *     imageFeatureManager.AddFeature("/opt/usr/media/Images/image2.jpg");
+ *     imageFeatureManager.AddFeature("/opt/usr/media/Images/image3.jpg");
+ *     imageFeatureManager.Flush("/opt/usr/media/Images/testFeatureSet.xdb");
+ * }
+ *
+ * void AddImageFeatureSet()
+ * {
+ *     Tizen::Uix::Vision::ImageFeatureManager imageFeatureManager;
+ *     imageFeatureManager.Construct();
  *     imageFeatureManager.Load("/opt/usr/media/Images/testFeatureSet.xdb");
  *     imageFeatureManager.AddFeature("/opt/usr/media/Images/image1.jpg");
  *     imageFeatureManager.AddFeature("/opt/usr/media/Images/image2.jpg");
@@ -113,6 +123,7 @@ public:
      * @remarks     
      *              - If a feature set file exists, it is updated.
      *              - If a feature set file does not exist, it is newly created.
+     *              - It is not mandatory to call this method to create new feature set file, but Flush() must be called with valid feature set file path.
      */
     result Load(const Tizen::Base::String& featureSetFilePath);
 
@@ -225,11 +236,13 @@ public:
      * @exception   E_INVALID_ARG        The specified feature set path is invalid.
      *
      * @remarks     
-     *              - All changes in the feature set file by 'AddFeature' or 'DeleteFeature' or 'DeleteAllFeatures' are updated by calling this method.
+     *              - All changes in the feature set file by AddFeature() or DeleteFeature() or DeleteAllFeatures() are updated by calling this method.
      *              - If @c featureSetFilePath is not decided or is same as the file path used in Load(), the loaded feature set file is updated.
      *              - If @c featureSetFilePath is not same as the file path used in %Load(), the loaded feature set file remains as is and new feature set file is created.
      *              - If @c featureSetFilePath is @c null, the feature set file loaded by %Load() is overwritten.
-	 * 	         	- If @c featureSetFilePath is not decided or is same to file path used in Load() and the loaded feature set file is read-only E_INVALID_ARG exception will be  returned.
+     * 	 			- If @c featureSetFilePath is not decided or is same to file path used in %Load() and the loaded feature set file is read-only @c E_INVALID_ARG exception will be  returned.
+     * 	 			- If %Load() is not called to create new feature set file, this method must be called with valid @c featureSetFilePath.
+     *
      */
     result Flush(const Tizen::Base::String* featureSetFilePath = null);
 
diff --git a/inc/FUixVisionQrCodeGenerator.h b/inc/FUixVisionQrCodeGenerator.h
index 67a40c0..8ea9656 100644
--- a/inc/FUixVisionQrCodeGenerator.h
+++ b/inc/FUixVisionQrCodeGenerator.h
@@ -118,7 +118,7 @@ public:
      * @exception    E_FILE_NOT_FOUND       The specified file cannot be found or accessed.
      *
      * @remarks      QR code encoding for UTF-8 is not standardized as yet.
-     *               So we support UTF-8 encoding/decoding compatibility to zxing(http://http://code.google.com/p/zxing/) library.
+     *               So we support UTF-8 encoding/decoding compatibility to zxing(http://code.google.com/p/zxing/) library.
      */
     result EncodeToFile(const Tizen::Base::String& message, QrCodeMode mode, QrCodeErrorCorrectionLevel errorCorrectionLevel, bool compatibility, const Tizen::Base::String& imageFilePath, Tizen::Media::ImageFormat imageFormat, int& width, int& height);
 
@@ -138,7 +138,7 @@ public:
      * @exception    E_INVALID_ARG            A specified input parameter is invalid.
      *
      * @remarks      QR code encoding for UTF-8 is not standardized as yet.
-     *               So we support UTF-8 encoding/decoding compatibility to zxing(http://http://code.google.com/p/zxing/) library.
+     *               So we support UTF-8 encoding/decoding compatibility to zxing(http://code.google.com/p/zxing/) library.
      */
     Tizen::Base::ByteBuffer* EncodeToBufferN(const Tizen::Base::String& message, QrCodeMode mode, QrCodeErrorCorrectionLevel error_level, bool compatibility, int& width, int& height);
 
diff --git a/inc/FUixVisionQrCodeRecognizer.h b/inc/FUixVisionQrCodeRecognizer.h
index c4f96ac..877b0f1 100644
--- a/inc/FUixVisionQrCodeRecognizer.h
+++ b/inc/FUixVisionQrCodeRecognizer.h
@@ -33,7 +33,7 @@ namespace Tizen { namespace Uix { namespace Vision
 {
 /**
  * @class    QrCodeRecognizer
- * @brief    This class provides methods to generate a QR code image.
+ * @brief    This class provides methods to recognize a QR code image.
  *
  * @since    2.1
  *