mv_machine_learning: clean up description

[Issue type] : code cleanup

Cleaned up some descriptions to Face Recognition CAPI, which
applies some feedbacks from API REVIEW step of ACR.

Change-Id: Ifff3a6b627c365a7e3247832c0a4a567b1d40922
Signed-off-by: Inki Dae <inki.dae@samsung.com>

diff --git a/include/mv_face_recognition.h b/include/mv_face_recognition.h
index 370329fec5bc4fee893220d5084146db8a0fdd89..9cece8953b1d7337a7d4c3fadb6c0dc70ec3b6e7 100644 (file)
--- a/include/mv_face_recognition.h
+++ b/include/mv_face_recognition.h
@@ -24,6 +24,16 @@
 extern "C" {
 #endif /* __cplusplus */
 
+/**
+ * @file   mv_face_recognition.h
+ * @brief  This file contains the face recognition CAPI for the Mediavision.
+ */
+
+/**
+ * @addtogroup CAPI_MEDIA_VISION_FACE_RECOGNITION_MODULE
+ * @{
+ */
+
 /**
  * @brief Creates face recognition handle.
  * @details Use this function to create a face recognition handle. After the creation
@@ -155,14 +165,14 @@ int mv_face_recognition_unregister(mv_face_recognition_h handle, const char *lab
 int mv_face_recognition_inference(mv_face_recognition_h handle, mv_source_h source);
 
 /**
- * @brief Get a label name.
- * @details Use this function to get a label name after calling mv_face_recognition_inference function.
+ * @brief Gets the recognized face label name.
+ * @details Use this function to get the recognized label name after calling @ref mv_face_recognition_inference().
  *
  * @since_tizen 7.0
  *
  * @param[in] handle         The handle to the face recognition object.
  * @param[out] out_label     The array pointer for the label name to be stored.
- *                           This API returns memory pointer containing actual label string to @a out_label.
+ *                           This function returns memory pointer containing actual label string to @a out_label.
  *                           So do not free @a out_label. And please note that @a out_label is valid only while handle is alive.
  *
  * @return @c 0 on success, otherwise a negative error value
@@ -170,10 +180,14 @@ int mv_face_recognition_inference(mv_face_recognition_h handle, mv_source_h sour
  * @retval #MEDIA_VISION_ERROR_INVALID_PARAMETER Invalid parameter
  * @retval #MEDIA_VISION_ERROR_INVALID_OPERATION Invalid operation
  *
- * @pre Request a inference by calling @ref mv_face_recognition_inference()
+ * @pre Request an inference by calling @ref mv_face_recognition_inference()
  */
 int mv_face_recognition_get_label(mv_face_recognition_h handle, const char **out_label);
 
+/**
+ * @}
+ */
+
 #ifdef __cplusplus
 }
 #endif /* __cplusplus */

diff --git a/include/mv_face_recognition_type.h b/include/mv_face_recognition_type.h
index f9ab44860c957f3d6d5308f9081f3de599752b42..90f93cd90770b7e99653dbded5e5b1dbe6d54b22 100644 (file)
--- a/include/mv_face_recognition_type.h
+++ b/include/mv_face_recognition_type.h
@@ -23,6 +23,16 @@
 extern "C" {
 #endif /* __cplusplus */
 
+/**
+ * @file   mv_face_recognition_type.h
+ * @brief  This file contains the face recognition handle for Mediavision.
+ */
+
+/**
+ * @addtogroup CAPI_MEDIA_VISION_FACE_RECOGNITION_MODULE
+ * @{
+ */
+
 /**
  * @brief The face recognition object handle.
  *
@@ -30,6 +40,10 @@ extern "C" {
  */
 typedef void *mv_face_recognition_h;
 
+/**
+ * @}
+ */
+
 #ifdef __cplusplus
 }
 #endif /* __cplusplus */