Update doxygen and license info

[platform/framework/native/face.git] / inc / FUixVisionFaceDetector.h

diff --git a/inc/FUixVisionFaceDetector.h b/inc/FUixVisionFaceDetector.h
index c58186a..530308b 100644 (file)
--- a/inc/FUixVisionFaceDetector.h
+++ b/inc/FUixVisionFaceDetector.h
@@ -133,7 +133,7 @@ class _OSP_EXPORT_ FaceDetector
 // Lifecycle
 public:
        /**
-        * This is the default constructor for this class.
+        * This is the default constructor for this class. @n
         * The object is not fully constructed after this constructor is called.
         * For full construction, the Construct() method must be called right after calling this constructor.
         *
@@ -158,9 +158,14 @@ public:
         *
         * @since        2.0
         *
+        * @feature      %http://tizen.org/feature/vision.face_recognition
         * @return       An error code
         * @exception    E_SUCCESS          The method is successful.
-        * @exception    E_OUT_OF_MEMORY    The memory is insufficient.
+        * @exception    E_UNSUPPORTED_OPERATION   The target device does not support the face detection feature. @b Since: @b 2.1
+        * 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 the %Tizen::System::SystemInfo::GetValue() methods.
+
+
         */
        result Construct(void);
 
@@ -268,8 +273,9 @@ public:
         * @exception    E_SUCCESS          The method is successful.
         * @exception    E_OUT_OF_MEMORY    The memory is insufficient.
         * @exception    E_FAILURE          A system error has occurred.
-        * @remarks      The specific error code can be accessed using the GetLastResult() method.
-        * @remarks      BitmapPixelFormat::BITMAP_PIXEL_FORMAT_R8G8B8A8 is not applicable for this method.
+        * @remarks
+        *                        - The specific error code can be accessed using the GetLastResult() method.
+        *                        - BitmapPixelFormat::BITMAP_PIXEL_FORMAT_R8G8B8A8 is not applicable for this method.
         * @endif
         */
        Tizen::Base::Collection::IList* DetectFacesFromStillImageN(const Tizen::Graphics::Bitmap& bitmap);
@@ -288,13 +294,13 @@ public:
         * @param[in]    byteBuffer         The buffer containing the input image data
         * @param[in]    dim                The width and height of the input image @n
         *                                  Both the width and height must be greater than @c 0.
-        * @param[in]    format             The color format defined by Tizen::Graphics::BitmapPixelFormat
+        * @param[in]    format             The color format @n
+        *                                                      @c BITMAP_PIXEL_FORMAT_R8G8B8A8 is not applicable for this method.
         * @exception    E_SUCCESS          The method is successful.
         * @exception    E_INVALID_ARG      A specified input parameter is invalid.
         * @exception    E_OUT_OF_MEMORY    The memory is insufficient.
         * @exception    E_FAILURE          A system error has occurred.
-        * @remarks      The specific error code can be accessed using the GetLastResult() method.
-        * @remarks      BitmapPixelFormat::BITMAP_PIXEL_FORMAT_R8G8B8A8 is not applicable for this method.
+        * @remarks      The specific error code can be accessed using the GetLastResult() method.  
         */
        Tizen::Base::Collection::IList* DetectFacesFromStillImageN(const Tizen::Base::ByteBuffer& byteBuffer, const Tizen::Graphics::Dimension& dim, Tizen::Graphics::BitmapPixelFormat format);
 
@@ -316,7 +322,6 @@ public:
         * @exception    E_OUT_OF_MEMORY    The memory is insufficient.
         * @exception    E_SYSTEM           A system error has occurred.
         * @remarks      The specific error code can be accessed using the GetLastResult() method.
-        * @see          FaceBuffer
         */
        FaceBuffer* PreprocessDataN(const Tizen::Base::ByteBuffer& byteBuffer, const Tizen::Graphics::Dimension& dim, Tizen::Graphics::PixelFormat format);
 
@@ -362,13 +367,13 @@ public:
         * @exception    E_OPERATION_FAILED        The method has failed to extract the facial information, but there is no error reported. @n
         *                                         This happens when the detected faces are too small or the input data is not clear. This is the result of a normal operation.
         * @remarks      The specific error code can be accessed using the GetLastResult() method.
-        * @see          FaceComponentsPosition
         */
        FaceComponentsPosition* ExtractFaceComponentsN(const FaceBuffer& preprocessedFaceBuffer, const Tizen::Graphics::Rectangle& faceRect);
 
 
        /**
-        * Gets the position difference of the face.
+        * Gets the position difference of the face. @n
+        * The %GetFaceMovement() method can be used for tracking the face from a sequential video data.
         *
         * @since         2.0
         *
@@ -386,11 +391,10 @@ public:
         * @exception     E_SUCCESS             The method is successful.
         * @exception     E_INVALID_ARG         A specified input parameter is invalid.
         * @exception     E_OPERATION_FAILED    The method has failed to get the position difference of the specified region, but there is no error reported. @n
-        *                                      In this case, @c xDiff and @c yDiff will be returned with @c 0. @n
+        *                                      In this case, @c xDiff and @c yDiff are returned with @c 0. @n
         *                                      It can happen when the detected faces are too small or two video data are different even if they contain the same face.
         *                                      This is the result of a normal operation.
         * @remarks       The specific error code can be accessed using the GetLastResult() method.
-        * @remarks       This can be used for tracking the face from a sequential video data.
         * @see           DetectFacesN()
         */
        result GetFaceMovement(const FaceBuffer& prevData, const FaceBuffer& curData, const Tizen::Graphics::Rectangle& prevFaceRect, int& xDiff, int& yDiff);