From e216a49c55e269b35cf816c8d717d0c4f45ac217 Mon Sep 17 00:00:00 2001 From: Minkyoung Kang Date: Wed, 12 Jun 2013 19:11:49 +0900 Subject: [PATCH] update header for Doxygen Change-Id: I36272b645451b2ad92754fa8aebd684e22ade5c1 --- inc/FUixVisionImageFeatureManager.h | 1 - inc/FUixVisionImageObject.h | 2 +- inc/FUixVisionQrCodeGenerator.h | 8 ++++---- inc/FUixVisionQrCodeObject.h | 2 +- inc/FUixVisionQrCodeRecognizer.h | 1 - 5 files changed, 6 insertions(+), 8 deletions(-) diff --git a/inc/FUixVisionImageFeatureManager.h b/inc/FUixVisionImageFeatureManager.h index 4f0e2a6..bb975c8 100644 --- a/inc/FUixVisionImageFeatureManager.h +++ b/inc/FUixVisionImageFeatureManager.h @@ -187,7 +187,6 @@ public: * - Calling this method actually means 'Mark As Add Feature'. * And the marked feature data will be added to a feature set file after calling Flush(). * @see GetSupportedImageFileFormatsListN() - * Flush(const Tizen::Base::String*) */ int AddFeature(const Tizen::Base::String& imagePath); diff --git a/inc/FUixVisionImageObject.h b/inc/FUixVisionImageObject.h index e735ac1..32ef8b2 100644 --- a/inc/FUixVisionImageObject.h +++ b/inc/FUixVisionImageObject.h @@ -33,7 +33,7 @@ namespace Tizen { namespace Uix { namespace Vision { /** * @class ImageObject - * @brief This class represents a single image object recognized by ImageRecognizer and provides methods to access information of a recognized image object. + * @brief This class represents a single image object recognized by %ImageRecognizer and provides methods to access information of a recognized image object. * * @since 2.1 * diff --git a/inc/FUixVisionQrCodeGenerator.h b/inc/FUixVisionQrCodeGenerator.h index fe705dc..3564ee9 100644 --- a/inc/FUixVisionQrCodeGenerator.h +++ b/inc/FUixVisionQrCodeGenerator.h @@ -141,9 +141,9 @@ public: * * @return An error code * @param[in] message The text to encode to QR code image - * @param[in] mode The input text encoding format (QR_CODE_MODE_ALPHANUMERIC, QR_CODE_MODE_BYTE, QR_CODE_MODE_UTF8) + * @param[in] mode The input text encoding format (@c QR_CODE_MODE_ALPHANUMERIC, @c QR_CODE_MODE_BYTE, @c QR_CODE_MODE_UTF8) * @param[in] errorCorrectionLevel 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 @c QR_MODE_UTF8 * @param[in] imageFilePath The file path of the generated QR code image * @param[in] imageFormat The image file format of the generated QR code image * @param[out] width The width of the generated QR code image @@ -164,9 +164,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_CODE_MODE_ALPHANUMERIC, QR_CODE_MODE_BYTE, QR_CODE_MODE_UTF8) + * @param[in] mode The input text encoding format (@c QR_CODE_MODE_ALPHANUMERIC, @c QR_CODE_MODE_BYTE, @c 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_CODE_MODE_UTF8 + * @param[in] compatibility The compatibility mode with zxing library for UTF-8 codes mode when mode is selected with @c 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. diff --git a/inc/FUixVisionQrCodeObject.h b/inc/FUixVisionQrCodeObject.h index 653ba62..a0b4b96 100644 --- a/inc/FUixVisionQrCodeObject.h +++ b/inc/FUixVisionQrCodeObject.h @@ -36,7 +36,7 @@ namespace Tizen { namespace Uix { namespace Vision /** * @class QrCodeObject - * @brief This class represents a single QR code object recognized by QrCodeRecognizer and provides the method to access information of the recognized QR code object. + * @brief This class represents a single QR code object recognized by %QrCodeRecognizer and provides the method to access information of the recognized QR code object. * * @since 2.1 * diff --git a/inc/FUixVisionQrCodeRecognizer.h b/inc/FUixVisionQrCodeRecognizer.h index 79ee363..d92badf 100644 --- a/inc/FUixVisionQrCodeRecognizer.h +++ b/inc/FUixVisionQrCodeRecognizer.h @@ -173,7 +173,6 @@ public: * @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_OUT_OF_MEMORY The memory is insufficient. - * @see SetImageSize(int, int) */ result ProcessImage(const Tizen::Base::ByteBuffer& imageBuffer); -- 2.7.4