doxygen code sample updated.

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

diff --git a/inc/FUixVisionQrCodeGenerator.h b/inc/FUixVisionQrCodeGenerator.h
index 8ea9656..fbde0f4 100644 (file)
--- a/inc/FUixVisionQrCodeGenerator.h
+++ b/inc/FUixVisionQrCodeGenerator.h
@@ -46,10 +46,44 @@ namespace Tizen { namespace Uix { namespace Vision
  * The following example demonstrates how to use the %QrCodeGenerator class.
  *
  * @code
- * Tizen::Uix::Vision::QrCodeGenerator qrGen;
- * qrGen.Construct();
- *
- * qrGen.EncodeToFile("test message", Tizen::Uix::Vision::QR_MODE_UTF8, Tizen::Uix::Vision::QR_ECL_Q, "/mnt/ums/Others/temp.bmp", Tizen::Media::IMG_FORMAT_PNG);
+ * #include <FBase.h>
+ * #include <FUix.h>
+ * #include <FGraphics.h>
+ * #include <FIo.h>
+ * #include <FMedia.h>
+ * 
+ * using namespace Tizen::Base;
+ * using namespace Tizen::Media;
+ * using namespace Tizen::Graphics;
+ * using namespace Tizen::Io;
+ * using namespace Tizen::Uix::Vision;
+ * 
+ * class MyClass
+ * {
+ * public:
+ *     MyClass();
+ *     ~MyClass();
+ *     result TestQrCodeGenerator(void);
+ * };
+ * 
+ * result
+ * MyClass::TestQrCodeGenerator(void)
+ * {
+ *     result r;
+ *     QrCodeGenerator qrGen;
+ *     qrGen.Construct();
+ * 
+ *     int width(0), height(0);
+ *     r = qrGen.EncodeToFile("Hello Tizen!",
+ *                     QR_CODE_MODE_UTF8,
+ *                     QR_CODE_ERROR_CORRECTION_LEVEL_Q,
+ *                     true,
+ *                     "/opt/usr/media/Images/temp.png",
+ *                     Tizen::Media::IMG_FORMAT_PNG,
+ *                     width,
+ *                     height);
+ *     return r;
+ * }
  * @endcode
  */
 class _OSP_EXPORT_ QrCodeGenerator
@@ -129,9 +163,9 @@ public:
      *
      * @return       A pointer to the Tizen::Base::ByteBuffer instance containing the generated QR code image
      * @param[in]    message                  The text to encode to QR code image
-     * @param[in]    mode                     The input text encoding format (QR_MODE_ALPHANUMERIC, QR_MODE_BYTE, QR_MODE_UTF8)
+     * @param[in]    mode                     The input text encoding format (QR_CODE_MODE_ALPHANUMERIC, QR_CODE_MODE_BYTE, QR_CODE_MODE_UTF8)
      * @param[in]    error_level              The QR code error correction level
-     * @param[in]    compatibility            The compatibility mode with zxing library for UTF-8 codes mode when mode is selected with QR_MODE_UTF8
+     * @param[in]    compatibility            The compatibility mode with zxing library for UTF-8 codes mode when mode is selected with QR_CODE_MODE_UTF8
      * @param[out]   width                    The width of the generated QR code image
      * @param[out]   height                   The height of the generated QR code image
      * @exception    E_SUCCESS                The method is successful.