From caca7f1c77ecd1328611a26e310cd861674ad1ec Mon Sep 17 00:00:00 2001 From: Kyusung Cho Date: Wed, 10 Apr 2013 20:50:34 +0900 Subject: [PATCH] reviewed inc Change-Id: I3cb048bd52fbdde446db6ac0682d0492f1cc0c80 Signed-off-by: Kyusung Cho --- inc/FUixVisionImageFeatureInfo.h | 27 ++++--- inc/FUixVisionImageFeatureManager.h | 140 ++++++++++++++++++------------------ inc/FUixVisionImageObject.h | 37 +++++----- inc/FUixVisionImageRecognizer.h | 101 +++++++++++++------------- inc/FUixVisionQrCodeGenerator.h | 68 +++++++++--------- inc/FUixVisionQrCodeObject.h | 47 ++++++------ inc/FUixVisionQrCodeRecognizer.h | 75 +++++++++---------- inc/FUixVisionQrCodeTypes.h | 8 +-- 8 files changed, 242 insertions(+), 261 deletions(-) diff --git a/inc/FUixVisionImageFeatureInfo.h b/inc/FUixVisionImageFeatureInfo.h index 407075e..8dee917 100644 --- a/inc/FUixVisionImageFeatureInfo.h +++ b/inc/FUixVisionImageFeatureInfo.h @@ -18,7 +18,9 @@ /** * @file FUixVisionImageFeatureInfo.h - * @brief This is the header file for the %Tizen::Uix::Vision::ImageFeatureInfo class. + * @brief This is the header file for the %ImageFeatureInfo class. + * + * This header file contains the declarations of the %ImageFeatureInfo class. */ #ifndef _FUIX_VISION_IMAGE_FEATURE_INFO_H_ @@ -31,12 +33,13 @@ namespace Tizen { namespace Uix { namespace Vision { /** * @class ImageFeatureInfo - * @brief This class holds information of individual image feature data in image feature set. + * @brief This class holds information of individual image feature data in an image feature set. * * @since 2.1 * - * @see Tizen::Uix::Vision::ImageFeatureManager + * The %ImageFeatureInfo class holds information of individual image feature data in an image feature set. * + * @see Tizen::Uix::Vision::ImageFeatureManager */ class _OSP_EXPORT_ ImageFeatureInfo : public Tizen::Base::Object @@ -75,37 +78,31 @@ public: int GetThumbnailHeight(void) const; /** - * Extracts thumbnail image. + * Gets the thumbnail image by extracting it. * * @since 2.1 * - * @return A pointer to the ByteBuffer instance containing the thumbnail image. - * - * @param[out] thumbnailBuffer Buffer to store corresponding grayscale thumbnail image. - * It must be allocated outside and have size 'width*height'. - * - * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG thumbnailBuffer is not allocated or width and height is not same to real thumbnail width and height. + * @return A pointer to the Tizen::Base::ByteBuffer instance containing the thumbnail image */ Tizen::Base::ByteBuffer* GetThumbnailN(void) const; /** - * Compares the calling instance with the specified instance. + * Compares the calling instance with a specified instance. * * @since 2.1 * - * @return true if the specified instance of Object is equal to the calling ImageFeatureInfo instance, + * @return @c true if the specified instance of Tizen::Base::Object is equal to the calling %ImageFeatureInfo instance, @n * else @c false * @param[in] obj The object to compare */ virtual bool Equals(const Tizen::Base::Object& obj) const; /** - * Gets the hash value of the current instance. + * Gets the hash value of a current instance. * * @since 2.1 * - * @return The address of the current instance pointer + * @return The hash value of the current instance */ virtual int GetHashCode(void) const; diff --git a/inc/FUixVisionImageFeatureManager.h b/inc/FUixVisionImageFeatureManager.h index 6c92083..90bee8f 100644 --- a/inc/FUixVisionImageFeatureManager.h +++ b/inc/FUixVisionImageFeatureManager.h @@ -18,7 +18,9 @@ /** * @file FUixVisionImageFeatureManager.h - * @brief This is the header file for the %Tizen::Uix::Vision::ImageFeatureManager class. + * @brief This is the header file for the %ImageFeatureManager class. + * + * This header file contains the declarations of the %ImageFeatureManager class. */ #ifndef _FUIX_VISION_IMAGE_FEATURE_MANAGER_H_ @@ -34,12 +36,11 @@ namespace Tizen { namespace Uix { namespace Vision /** * @class ImageFeatureManager - * @brief This class provides methods to generate individual feature data from individual image data. - * And this class also provides method to manage image feature set which is the collection of individual feature data. + * @brief This class provides methods to generate individual feature data from an individual image data. * * @since 2.1 * - * The %ImageFeatureManager class provides the ability to generate individual image feature data and manage image feature set. + * The %ImageFeatureManager class provides methods to generate individual feature data from an individual image data. This class also provides methods to manage image feature set which is a collection of individual feature data. * * The following example demonstrates how to use the %ImageFeatureManager class. * @@ -62,8 +63,8 @@ class _OSP_EXPORT_ ImageFeatureManager public: /** - * This is the default constructor for this class. - * The object is not fully constructed after this constructor is called. + * This is the default constructor for this class. @n + * The object is not fully constructed after this constructor is called. @n * For full construction, the Construct() method must be called right after calling this constructor. * * @since 2.1 @@ -80,169 +81,166 @@ public: ~ImageFeatureManager(void); /** - * Initialize this instance of ImageFeatureManager and create image feature set. - * Every application must call Construct() before calling any other method of ImageFeatureManager. + * Initializes this instance of %ImageFeatureManager and create image feature set. @n + * Every application must call %Construct() before calling any other methods of %ImageFeatureManager. * * @since 2.1 * * @feature %http://tizen.org/feature/vision.image_recognition * - * @return An error code. + * @return An error code * * @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 Application Filtering. * @remarks Before calling this method, check whether the feature is supported by %Tizen::System::SystemInfo::GetValue() methods. - * @see */ result Construct(void); /** - * Loads feature set file + * Loads a feature set file. * * @since 2.1 * - * @return An error code. + * @return An error code * - * @param[in] featureSetFilePath Feature set file path + * @param[in] featureSetFilePath The feature set file path * * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG A specified feature set file path is invalid. + * @exception E_INVALID_ARG The specified feature set file path is invalid. * @exception E_OUT_OF_MEMORY The memory is insufficient. * - * @remarks if feature set file exists, it will be updated. - * if feature set file does not exist, it will return E_INVALID_ARG exception. - * @see + * @remarks + * - If a feature set file exists, it is updated. + * - If a feature set file does not exist, it is newly created. */ result Load(const Tizen::Base::String& featureSetFilePath); /** - * Returns list of supported image file formats for adding feature. + * Gets a list of supported image file formats for adding a feature. * * @since 2.1 - * @return list of supported image file formats - * - * @see + * + * @return A list of supported image file formats */ static Tizen::Base::Collection::IListT* GetSupportedImageFileFormatsListN(void); /** - * Adds a feature to feature set + * Adds a feature to a feature set. * * @since 2.1 * - * @return Feature index of newly created feature on success, otherwise returns -1. + * @return A feature index of newly and successfully created feature, otherwise returns -1. * - * @param[in] imagePath Input image file path + * @param[in] imagePath The input image file path * - * @exception E_INVALID_ARG A specified input parameter is invalid. + * @exception E_INVALID_ARG The specified input parameter is invalid. * - * @remarks The specific error code can be accessed using the GetLastResult() method. - * Input image file must be one of the supported image file formats. - * Calling this method actually means 'Mark As Add Feature'. - * And the marked feature data will be added to feature set file after calling Flush(); - * @see GetSupportedImageFileFormatsListN(void) - * Flush(const Tizen::Base::String* featureSetFilePath = 0); + * @remarks + * - The specific error code can be accessed using the GetLastResult() method. + * - Input image file must be one of the supported image file formats. + * - 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); /** - * Adds a feature to feature set + * Adds a feature to a feature set. * * @since 2.1 * - * @return Feature index of newly created feature on success, otherwise returns -1. + * @return A feature index of newly and successfully created feature, otherwise returns -1. * - * @param[in] imageBuffer Image buffer of grayscale image data of specified width and height - * @param[in] width Width of input image - * @param[in] height Height of input image - * @param[in] description Description of the feature + * @param[in] imageBuffer The image buffer of grayscale image data of specified width and height + * @param[in] width The width of the input image + * @param[in] height The height of the input image + * @param[in] description The description of the feature * * @exception E_INVALID_ARG A specified input parameter is invalid. * - * @remarks The specific error code can be accessed using the GetLastResult() method. - * Calling this method actually means 'Mark As Add Feature'. - * And the marked feature data will be added to feature set file after calling Flush(); - * @see Flush(const Tizen::Base::String* featureSetFilePath = 0); + * @remarks + * - The specific error code can be accessed using the GetLastResult() method. + * - 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 Flush(const Tizen::Base::String*) */ int AddFeature(const Tizen::Base::ByteBuffer& imageBuffer, int width, int height, const Tizen::Base::String& description); /** - * Gets total number of features in feature set. + * Gets the total number of features in a feature set. * * @since 2.1 * - * @return Total number of features in the feature set. - * @see + * @return The total number of features in a feature set */ int GetTotalNumberOfFeatures(void); /** - * Deletes a feature of specified index in the feature set + * Deletes a feature with a specified index in a feature set. * * @since 2.1 * - * @return An error code. + * @return An error code * - * @param[in] featureIndex Feature index in feature set + * @param[in] featureIndex The feature index in a feature set * * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG A specified input parameter is invalid. + * @exception E_INVALID_ARG The specified input parameter is invalid. * @exception E_OUT_OF_MEMORY The memory is insufficient. * * @remarks Calling this method actually means 'Mark As Delete Feature'. - * And the marked feature data will be deleted after calling Flush(); - * @see Flush(const Tizen::Base::String* featureSetFilePath = 0); + * And the marked feature data is deleted after calling Flush(). + * @see Flush(const Tizen::Base::String*) */ result DeleteFeature(int featureIndex); /** - * Deletes all features in feature set + * Deletes all features in a feature set. * * @since 2.1 * - * @return An error code. + * @return An error code * * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. * * @remarks Calling this method actually means 'Mark As Delete All Features'. - * And all feature data will be deleted after calling Flush(); - * @see Flush(const Tizen::Base::String* featureSetFilePath = 0); + * And all feature data is deleted after calling Flush(). + * @see Flush(const Tizen::Base::String*) */ result DeleteAllFeatures(void); /** - * Saves features into feature set file and update all changes as marked. + * Flushes features into a feature set file and updates all changes as marked. * * * @since 2.1 * - * @return An error code. + * @return An error code * - * @param[in] featureSetFilePath Feature set file path + * @param[in] featureSetFilePath The feature set file path * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG A specified Feature set path is invalid. - * - * @remarks All changes in feature set file by 'AddFeature' or 'DeleteFeature' or 'DeleteAllFeatures' are updated by calling this Flush() method. - * If featureSetFilePath is not decided or is same to file path used in Load(), the loaded feature set file will be updated. - * If featureSetFilePath is not same to file path used in Load(), the loaded feature set file is remained and new feature set file will be created. - * If featureSetFilePath is null, the feature set file loaded by Load() method will be overwritten. - * If 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. - * - * @see + * @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. + * - 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. */ result Flush(const Tizen::Base::String* featureSetFilePath = null); /** - * Gets information of the individual feature + * Gets information of the individual feature. * * @since 2.1 * - * @return pointer to ImageFeatureInfo + * @return A pointer to ImageFeatureInfo * - * @param[in] featureIndex Feature index in feature set. - * @see + * @param[in] index The feature index in a feature set */ const Tizen::Uix::Vision::ImageFeatureInfo* GetImageFeatureInfo(int featureIndex) const; @@ -259,7 +257,7 @@ private: ImageFeatureManager& operator=(const ImageFeatureManager&); private: - class _ImageFeatureManagerImpl* __pImageFeatureManagerImpl; + class _ImageFeatureManagerImpl* __pImageFeatureManagerImpl; friend class _ImageFeatureManagerImpl; }; diff --git a/inc/FUixVisionImageObject.h b/inc/FUixVisionImageObject.h index f9aeaad..e735ac1 100644 --- a/inc/FUixVisionImageObject.h +++ b/inc/FUixVisionImageObject.h @@ -18,7 +18,9 @@ /** * @file FUixVisionImageObject.h - * @brief This is the header file for the %Tizen::Uix::Vision::ImageObject class. + * @brief This is the header file for the %ImageObject class. + * + * This header file contains the declarations of the %ImageObject class. */ #ifndef _FUIX_VISION_IMAGE_OBJECT_H_ @@ -31,11 +33,11 @@ namespace Tizen { namespace Uix { namespace Vision { /** * @class ImageObject - * @brief This class represents single image object recognized by ImageRecognizer and provide the method to access information of the 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 * - * The %ImageObject class holds information about object tracking. + * The %ImageObject class represents a single image object recognized by ImageRecognizer and provides methods to access information of a recognized image object. * */ class _OSP_EXPORT_ ImageObject @@ -43,65 +45,58 @@ class _OSP_EXPORT_ ImageObject { public: /** - * Gets unique identifier of the recognized image object in a scene + * Gets a unique identifier of the recognized image object in a scene. * * @since 2.1 * - * @return Unique identifier of the recognized image object in a scene - * - * @see + * @return A unique identifier of the recognized image object in a scene */ int GetId(void) const; /** - * Gets feature index of the recognized image object in feature set + * Gets a feature index of the recognized image object in feature set. * * @since 2.1 * - * @return feature index of the recognized image object in feature set - * - * @see + * @return A feature index of the recognized image object in feature set */ int GetFeatureId(void) const; /** - * Gets transformation matrix 4x4 for 3D pose of the recognized image object + * Gets a transformation matrix 4x4 for 3D pose of the recognized image object. * * @since 2.1 * - * @return Pointer to transformation matrix 4x4 for object position - * @see + * @return A pointer to transformation matrix 4x4 for object position */ const Tizen::Graphics::FloatMatrix4* GetTransformMatrix(void) const; /** - * Get the transformed quadrilateral of the recognized image object + * Gets a transformed quadrilateral of the recognized image object. * * @since 2.1 * * @return The array list of 4 points of the quadrilateral of the recognized image object - * - * @see */ const Tizen::Base::Collection::IListT* GetRectangle(void) const; /** - * Compares the calling instance with the specified instance. + * Compares the calling instance with a specified instance. * * @since 2.1 * - * @return true if the specified instance of Object is equal to the calling ImageObject instance, + * @return @c true if the specified instance of Tizen::Base::Object is equal to the calling %ImageObject instance, @n * else @c false * @param[in] obj The object to compare */ virtual bool Equals(const Tizen::Base::Object& obj) const; /** - * Gets the hash value of the current instance. + * Gets the hash value of a current instance. * * @since 2.1 * - * @return The address of the current instance pointer + * @return The hash value of the current instance */ virtual int GetHashCode(void) const; diff --git a/inc/FUixVisionImageRecognizer.h b/inc/FUixVisionImageRecognizer.h index f51f92d..49fdc45 100644 --- a/inc/FUixVisionImageRecognizer.h +++ b/inc/FUixVisionImageRecognizer.h @@ -18,7 +18,9 @@ /** * @file FUixVisionImageRecognizer.h - * @brief This is the header file for the %Tizen::Uix::Vision::ImageRecognizer class. + * @brief This is the header file for the %ImageRecognizer class. + * + * This header file contains the declarations of the %ImageRecognizer class. */ #ifndef _FUIX_VISION_IMAGE_RECOGNIZER_H_ @@ -32,46 +34,48 @@ namespace Tizen { namespace Uix { namespace Vision class ImageFeatureManager; /** * @class ImageRecognizer - * @brief This class provides methods to find same image objects to input image in the feature set which stores features of the reference images. - * And this class also provide methods to calculate 2D position and 3D pose transform matrix of the recognized image objects. + * @brief This class provides methods to find same image objects to input image in the feature set that stores features of the reference images. * * @since 2.1 * - * The following example demonstrates how to use the ImageRecognizer class. + * The %ImageRecognizer class provides methods to find same image objects to input image in the feature set that stores features of the reference images. + * This class also provide methods to calculate the 2D position and 3D pose transform matrix of the recognized image objects. + * + * The following example demonstrates how to use the %ImageRecognizer class. * * @code * - * //Process of initalization follows + * // Process of initialization follows * void * Tracker::Initialize() * { - * //Creating and initializing recognition engine + * // Creates and initializes recognition engine * __pImageRecognizer = new Tizen::Uix::Vision::ImageRecognizer(); * __pImageRecognizer->Construct(); * - * //Creating an initialized ImageFeatureManager + * // Creates an initialized ImageFeatureManager * __pFeatureManager = new Tizen::Uix::Vision::ImageFeatureManager(); * __pFeatureManager->Construct(); * - * //Loading feature set + * // Loads feature set * __pFeatureManager->Load("/mnt/ums/Images/sharks/testFeatureSet.xdb"); * - * //Configuring recognition engine + * // Configures recognition engine * __pImageRecognizer->SetFeatureManager(__pFeatureManager); * __pImageRecognizer->SetImageSize(CAMERA_WIDTH, CAMERA_HEIGHT); * * __pImageRecognizer->SetMultiTracking(true); * } * - * //We suppose camera to be initialized with Tizen::Graphics::PIXEL_FORMAT_YCbCr420_PLANAR format + * // We suppose camera to be initialized with Tizen::Graphics::PIXEL_FORMAT_YCbCr420_PLANAR format * * void * Tracker::OnCameraPreviewed(Tizen::Base::ByteBuffer& previewedData, result r) * { - * //Processing of the camera image follows + * // Processing of the camera image follows * __pImageRecognizer->ProcessImage(previewedData); * - * //Loop through all recognized images + * // Loops through all recognized images * for (int i = 0; i < __pImageRecognizer->GetRecognizedObjectCount(); i++) * { * const Tizen::Uix::Vision::ImageObject *o = __pImageRecognizer->GetRecognizedObject(i); @@ -89,8 +93,8 @@ class _OSP_EXPORT_ ImageRecognizer public: /** - * This is the default constructor for this class. - * The object is not fully constructed after this constructor is called. + * This is the default constructor for this class. @n + * The object is not fully constructed after this constructor is called. @n * For full construction, the Construct() method must be called right after calling this constructor. * * @since 2.1 @@ -107,8 +111,8 @@ public: ~ImageRecognizer(void); /** - * Initializes this instance of ImageRecognizer. - * Every application must call Construct() before calling any other method of ImageRecognizer. + * Initializes this instance of %ImageRecognizer. @n + * Every application must call %Construct() before calling any other methods of %ImageRecognizer. * * @since 2.1 * @@ -118,96 +122,91 @@ public: * @exception E_UNSUPPORTED_OPERATION The Emulator or target device does not support the required feature. * For more information, see Application Filtering. * @remarks Before calling this method, check whether the feature is supported by %Tizen::System::SystemInfo::GetValue() methods. - * @see */ result Construct(void); /** - * Enables single or multiple tracking mode - * + * Enables single or multiple tracking mode. * * @since 2.1 - * @param[in] enable Enable multiple tracking mode on true, default is single tracking mode. + * + * @param[in] enable Enable multiple tracking mode on @c true, default is single tracking mode * - * @remarks In single tracking mode, only one image will be recognized in the screen at once. - * In multiple tracking mode, multiple images can be recognized and tracked simultaneously. - * (Max : 3 images simultaneously) - * @exception - * @see + * @remarks + * - In single tracking mode, only one image is recognized in the screen at once. + * - In multiple tracking mode, multiple images (maximum 3) can be recognized and tracked simultaneously. */ void SetMultiTrackingEnabled(bool enable); /** - * Sets width and height of input image + * Sets the width and height of an input image. * * @since 2.1 * - * @return An error code. + * @return An error code * - * @param[in] width Input image width - * @param[in] height Input image height + * @param[in] width The width of the input image + * @param[in] height The height of the input image * * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG A specified input parameter is invalid. - * @see */ result SetImageSize(int width, int height); /** - * Sets ImageFeatureManager instance for initialization + * Sets the ImageFeatureManager instance for initialization. * * @since 2.1 - * @pre ImageFeatureManager should be initialized by loading feature set file using call Load() method. + * @pre ImageFeatureManager should be initialized by loading a feature set file using the ImageFeatureManager::Load() method. * - * @return An error code. - * @param[in] imageFeatureManager ImageFeatureManager managing image feature set to be used for recognition + * @return An error code + * @param[in] imageFeatureManager The ImageFeatureManager instance managing image feature set to use for recognition * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG An input ImageFeatureManager is invalid. * - * @remarks ImageFeatureManager should be initialized by loading feature set file. - * @see result ImageFeatureManager::Load(const Tizen::Base::String& featureSetFilePath). + * @remarks ImageFeatureManager should be initialized by loading a feature set file. */ result SetFeatureManager(ImageFeatureManager& imageFeatureManager); /** - * Gets the number of the recognized image object + * Gets a count of the recognized image object. * * @since 2.1 * - * @return Number of recognized image object + * @return A count of the recognized image object * - * @remarks The recognized object has index value from 0 to (number of the recognized image objects - 1) - * @see GetRecognizedObject(int index) + * @remarks The recognized object has index value from @c 0 to (count of the recognized image objects - 1) + * @see GetRecognizedObject(int) */ int GetRecognizedObjectCount(void); /** - * Gets the recognized image object to get information + * Gets the recognized image object to get information. * * @since 2.1 * - * @return The pointer of ImageObject including all information about the reconginzed image object - * @param[in] index Index of the recognized image object. - * Valid range of this parameter is 0 to (number of the recognized image objects - 1). + * @return A pointer to ImageObject that includes all information about the recognized image object + * @param[in] index The index of the recognized image object @n + * Valid range of this parameter is @c 0 to (count of the recognized image objects - 1). * @exception E_SUCCESS The method is successful. * - * @see GetRecognizedObjectCount(void) + * @see GetRecognizedObjectCount() */ const ImageObject* GetRecognizedObject(int index) const; /** - * Process input image for recognition + * Processes an input image for recognition. * * @since 2.1 * - * @return An error code. + * @return An error code * - * @param[in] imageBuffer Input image buffer - * It must be allocated outside and have size of (width*height) by SetImageSize(). + * @param[in] imageBuffer The input image buffer @n + * It must be allocated outside and have size of (width*height) set by SetImageSize(). * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG imageBuffer is not allocated or the size of imageBuffer is not equal to input image size by SetImageSize(). + * @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 width, int height) + * @see SetImageSize(int, int) */ result ProcessImage(const Tizen::Base::ByteBuffer& imageBuffer); diff --git a/inc/FUixVisionQrCodeGenerator.h b/inc/FUixVisionQrCodeGenerator.h index a3d6e86..67a40c0 100644 --- a/inc/FUixVisionQrCodeGenerator.h +++ b/inc/FUixVisionQrCodeGenerator.h @@ -18,7 +18,9 @@ /** * @file FUixVisionQrCodeGenerator.h - * @brief This is the header file for the %Tizen::Uix::Vision::QrCodeGenerator class. + * @brief This is the header file for the %QrCodeGenerator class. + * + * This header file contains the declarations of the %QrCodeGenerator class. */ #ifndef _FUIX_VISION_QR_CODE_GENERATOR_H_ @@ -35,9 +37,12 @@ namespace Tizen { namespace Uix { namespace Vision /** * @class QrCodeGenerator - * @brief This class provides methods to generate QR code image. + * @brief This class provides methods to generate a QR code image. * * @since 2.1 + * + * The %QrCodeGenerator class provides methods to generate a QR code image. + * * The following example demonstrates how to use the %QrCodeGenerator class. * * @code @@ -53,8 +58,8 @@ class _OSP_EXPORT_ QrCodeGenerator public: /** - * This is the default constructor for this class. - * The object is not fully constructed after this constructor is called. + * This is the default constructor for this class. @n + * The object is not fully constructed after this constructor is called. @n * For full construction, the Construct() method must be called right after calling this constructor. * * @since 2.1 @@ -71,8 +76,8 @@ public: ~QrCodeGenerator(void); /** - * Initializes this instance of QRCodeGenerator. - * Every application must call Construct() before calling any other method of QRCodeGenerator. + * Initializes this instance of %QRCodeGenerator. @n + * Every application must call %Construct() before calling any other methods of %QRCodeGenerator. * * @since 2.1 * @@ -82,63 +87,58 @@ public: * @exception E_UNSUPPORTED_OPERATION The Emulator or target device does not support the required feature. * For more information, see Application Filtering. * @remarks Before calling this method, check whether the feature is supported by %Tizen::System::SystemInfo::GetValue() methods. - * @see */ result Construct(void); /** - * Returns list of supported image file formats . + * Gets a list of supported image file formats. * - * @return list of supported image file formats * @since 2.1 - * - * @remarks - * @see + * + * @return A list of supported image file formats */ static Tizen::Base::Collection::IListT* GetSupportedImageFileFormatsListN(void); /** - * Generates QR code into file + * Encodes a QR code into a file. * * @since 2.1 * - * @return An error code. - * @param[in] message Text to be encoded to QR code image - * @param[in] mode Input text encoding format (QR_CODE_MODE_ALPHANUMERIC, QR_CODE_MODE_BYTE, QR_CODE_MODE_UTF8) - * @param[in] errorCorrectionLevel QR code error correction level - * @param[in] compatibility Compatibility mode with zxing library for UTF-8 codes mode when mode is selected with QR_MODE_UTF8 - * @param[in] imageFilePath File path of the generated QR code image - * @param[in] imageFormat Image file format of the generated QR code image - * @param[out] width Width of the generated QR code image - * @param[out] height Height of the generated QR code image + * @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] 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] 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 + * @param[out] height The height of the generated QR code image * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG A specified input parameter is invalid. * @exception E_FILE_NOT_FOUND The specified file cannot be found or accessed. * - * @remarks QR code encoding for UTF-8 is not standardized yet. + * @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. - * @see */ 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); /** - * Generates QR code into a byte buffer + * Encodes a QR code into a byte buffer. * * @since 2.1 * - * @return A pointer to the ByteBuffer instance containing the generated QR code image - * @param[in] message Text to be encoded to QR code image - * @param[in] mode Input text encoding format (QR_MODE_ALPHANUMERIC, QR_MODE_BYTE, QR_MODE_UTF8) - * @param[in] error_level QR code error correction level - * @param[in] compatibility Compatibility mode with zxing library for UTF-8 codes mode when mode is selected with QR_MODE_UTF8 - * @param[out] width Width of the generated QR code image - * @param[out] height Height of the generated QR code image + * @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] 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[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. * @exception E_INVALID_ARG A specified input parameter is invalid. * - * @remarks QR code encoding for UTF-8 is not standardized yet. + * @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. - * @see */ Tizen::Base::ByteBuffer* EncodeToBufferN(const Tizen::Base::String& message, QrCodeMode mode, QrCodeErrorCorrectionLevel error_level, bool compatibility, int& width, int& height); diff --git a/inc/FUixVisionQrCodeObject.h b/inc/FUixVisionQrCodeObject.h index 431f9ed..653ba62 100644 --- a/inc/FUixVisionQrCodeObject.h +++ b/inc/FUixVisionQrCodeObject.h @@ -18,9 +18,9 @@ /** * @file FUixVisionQrCodeObject.h - * @brief This is the header file for the %Tizen::Uix::Vision::QrCodeObject class. + * @brief This is the header file for the %QrCodeObject class. * - * This header file contains the declarations of the %Tizen::Uix::Vision::QrCodeObject class. + * This header file contains the declarations of the %QrCodeObject class. */ #ifndef _FUIX_VISION_QR_CODE_OBJECT_H_ @@ -36,10 +36,11 @@ namespace Tizen { namespace Uix { namespace Vision /** * @class QrCodeObject - * @brief This class represents single QR code object recognized by QrCodeRecognizer and provide 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 * + * The %QrCodeObject class represents a single QR code object recognized by QrCodeRecognizer and provides the method to access information of the recognized QR code object. */ class _OSP_EXPORT_ QrCodeObject @@ -49,84 +50,76 @@ class _OSP_EXPORT_ QrCodeObject public: /** - * Gets unique identifier of the recognized QR code object in a scene + * Gets a unique identifier of the recognized QR code object in a scene. * * @since 2.1 * - * @return Unique identifier of the recognized QR code object in a scene * - * @see + * @return A unique identifier of the recognized QR code object in a scene */ int GetId(void) const; /** - * Gets version of the recognized QR code object + * Gets a version of the recognized QR code object. * * @since 2.1 * - * @return Version of current QR code object - * @see + * @return A version of the recognized QR code object */ int GetVersion(void) const; /** - * Gets error correction level of the recognized QR code object + * Gets an error correction level of the recognized QR code object. * * @since 2.1 * - * @return error correction level of the recognized QR code object - * @see + * @return An error correction level of the recognized QR code object */ Tizen::Uix::Vision::QrCodeErrorCorrectionLevel GetErrorCorrectionLevel(void) const; /** - * Gets text of QR code object. + * Gets a text of the QR code object. * * @since 2.1 * - * @return text of QR code object - * @see + * @return A text of the QR code object */ Tizen::Base::String GetText(void) const; /** - * Gets transformation matrix 4x4 for 3D pose of the recognized QR code object + * Gets a transformation matrix 4x4 for 3D pose of the recognized QR code object. * * @since 2.1 * - * @return Pointer to transformation matrix 4x4 for object position - * - * @see + * @return A pointer to transformation matrix 4x4 for object position */ const Tizen::Graphics::FloatMatrix4* GetTransformMatrix(void) const; /** - * Get the transformed quadrilateral of the recognized QR code object + * Gets a transformed quadrilateral of the recognized QR code object. * * @since 2.1 * * @return The array list of 4 points of the quadrilateral of the recognized QR code object - * - * @see */ const Tizen::Base::Collection::IListT* GetRectangle(void) const; /** - * Compares the calling instance with the specified instance. + * Compares the calling instance with a specified instance. * * @since 2.1 * - * @return true if the specified instance of Object is equal to the calling QrCodeObject instance, - * else false + * @return @c true if the specified instance of Tizen::Base::Object is equal to the calling %QrCodeObject instance, @n + * else @c false * @param[in] obj The object to compare */ virtual bool Equals(const Tizen::Base::Object& obj) const; /** - * Gets the hash value of the current instance. + * Gets the hash value of a current instance. * * @since 2.1 * - * @return The address value of the current instance pointer + * @return The hash value of the current instance */ virtual int GetHashCode(void) const; diff --git a/inc/FUixVisionQrCodeRecognizer.h b/inc/FUixVisionQrCodeRecognizer.h index 8b0beae..c4f96ac 100644 --- a/inc/FUixVisionQrCodeRecognizer.h +++ b/inc/FUixVisionQrCodeRecognizer.h @@ -18,7 +18,9 @@ /** * @file FUixVisionQrCodeRecognizer.h - * @brief This is the header file for the %Tizen::Uix::Vision::QrCodeRecognizer class. + * @brief This is the header file for the %QrCodeRecognizer class. + * + * This header file contains the declarations of the %QrCodeRecognizer class. */ #ifndef _FUIX_VISION_QR_CODE_RECOGNIZER_H_ #define _FUIX_VISION_QR_CODE_RECOGNIZER_H_ @@ -31,15 +33,17 @@ namespace Tizen { namespace Uix { namespace Vision { /** * @class QrCodeRecognizer - * @brief This class provides methods to generate QR code image. + * @brief This class provides methods to generate a QR code image. * * @since 2.1 * + * The %QrCodeRecognizer class provides methods to generate a QR code image. + * * The following example demonstrates how to use the %QrCodeRecognizer class. * * @code * - * // Recognition engine initialization + * // Initializes recognition engine * * void * Tracker::Initialize() @@ -50,15 +54,15 @@ namespace Tizen { namespace Uix { namespace Vision * __pQrRecognizer->SetFrameSize(CAMERA_WIDTH, CAMERA_HEIGHT); * } * - * //We suppose camera to be initialized with Tizen::Graphics::PIXEL_FORMAT_YCbCr420_PLANAR format + * // We suppose camera to be initialized with Tizen::Graphics::PIXEL_FORMAT_YCbCr420_PLANAR format * * void * Tracker::OnCameraPreviewed(Tizen::Base::ByteBuffer& previewedData, result r) * { - * //Processing of the camera image follows + * // Processing of the camera image follows * __pQrRecognizer->ProcessFrame(previewedData); * - * //Loop through all recognized QRs + * // Loops through all recognized QRs * for (int i = 0; i < __pQrRecognizer->GetRecognizedObjectCount(); i++) * { * @@ -77,8 +81,8 @@ class _OSP_EXPORT_ QrCodeRecognizer public: /** - * This is the default constructor for this class. - * The object is not fully constructed after this constructor is called. + * This is the default constructor for this class. @n + * The object is not fully constructed after this constructor is called. @n * For full construction, the Construct() method must be called right after calling this constructor. * * @since 2.1 @@ -95,8 +99,8 @@ public: ~QrCodeRecognizer(void); /** - * Initializes this instance of ImageRecognizer. - * Every application must call Construct() before calling any other method of ImageRecognizer. + * Initializes this instance of %QrCodeRecognizer. @n + * Every application must call %Construct() before calling any other methods of %QrCodeRecognizer. * * @since 2.1 * @@ -106,80 +110,77 @@ public: * @exception E_UNSUPPORTED_OPERATION The Emulator or target device does not support the required feature. * For more information, see Application Filtering. * @remarks Before calling this method, check whether the feature is supported by %Tizen::System::SystemInfo::GetValue() methods. - * @see */ result Construct(void); /** - * Sets width and height of input image + * Sets the width and height of an input image. * * @since 2.1 * - * @return An error code. + * @return An error code * - * @param[in] width frame width in pixels - * @param[in] height frame height in pixels + * @param[in] width The width of the frame in pixels + * @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 must be called once before calling processFrame. - * @see + * @remarks This method must be called once before calling ProcessImage(). */ result SetImageSize(int width, int height); /** - * Process input image for recognition + * Processes an input image for recognition. * * @since 2.1 * - * @return An error code. + * @return An error code * - * @param[in] imageBuffer Input image buffer - * It must be allocated outside and have size of (width*height) by SetImageSize(). + * @param[in] imageBuffer The input image buffer @n + * It must be allocated outside and have size of (width*height) set by SetImageSize(). * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG imageBuffer is not allocated or the size of imageBuffer is not equal to input image size by SetImageSize(). + * @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 width, int height) + * @see SetImageSize(int, int) */ result ProcessImage(const Tizen::Base::ByteBuffer& imageBuffer); /** - * Get the expected ROI(Region of Interest) of the recognized QR code for focusing + * Gets the expected ROI (Region of Interest) of the recognized QR code for focusing. * * @since 2.1 * * @return An error code - * @param[out] roi the expected ROI(Region of Interest) of the recognized QR code + * @param[out] roi The expected ROI (Region of Interest) of the recognized QR code * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG A specified input parameter is invalid. + * @exception E_INVALID_ARG The specified input parameter is invalid. * - * @remarks The ROI is used for reset of camera foucs to get better image and it can be obtained after calling ProcessImage() at least once. - * @see + * @remarks The ROI is used to reset camera focus to get better image and it can be obtained after calling ProcessImage() at least once. */ result GetFocusRoi(Tizen::Graphics::Rectangle& roi); /** - * Gets the number of the recognized QR code object + * Gets a count of the recognized QR code object. * * @since 2.1 * - * @return Number of recognized QR code object + * @return A count of the recognized QR code object * - * @remarks The recognized QR code object has index value from 0 to (number of the recognized QR code objects - 1) - * @see GetRecognizedObject(int index) + * @remarks The recognized QR code object has index value from @c 0 to (count of the recognized QR code objects - 1) + * @see GetRecognizedObject(int) */ int GetRecognizedObjectCount(void); /** - * Gets the recognized QR code object to get information + * Gets the recognized QR code object to get information. * * @since 2.1 * - * @return The pointer of QrCodeObject including all information about the reconginzed QR code object - * @param[in] index Index of the recognized QR code object - * Valid range of this parameter is 0 to (number of the recognized QR code objects - 1). + * @return A pointer to QrCodeObject that includes all 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). * @exception E_SUCCESS The method is successful. * - * @see GetRecognizedObjectCount(void) + * @see GetRecognizedObjectCount() */ const QrCodeObject* GetRecognizedObject(int index) const; diff --git a/inc/FUixVisionQrCodeTypes.h b/inc/FUixVisionQrCodeTypes.h index 15826b4..3fe26fb 100644 --- a/inc/FUixVisionQrCodeTypes.h +++ b/inc/FUixVisionQrCodeTypes.h @@ -19,6 +19,8 @@ /** * @file FUixVisionQrCodeTypes.h * @brief This is the header file for the QR code types. + * + * This header file contains the declarations of the QR code types. */ #ifndef _FUIX_VISION_QR_CODE_TYPES_H_ @@ -30,9 +32,7 @@ namespace Tizen { namespace Uix { namespace Vision /** * @enum QrCodeErrorCorrectionLevel * - * Defines possible error correction levels. - * - * @brief Enumeration that defines possible error correction levels for QR code. + * Defines possible error correction levels for QR code. * * @since 2.1 */ @@ -49,8 +49,6 @@ enum QrCodeErrorCorrectionLevel * * Defines possible encoding modes for QR codes. * - * @brief Enumeration that defines possible encoding modes for QR code. - * * @since 2.1 */ enum QrCodeMode -- 2.7.4