Fix Doxygen mistakes

Change-Id: I5338485c225160dc101280459f4dbb01a631c0b1

diff --git a/include/metadata_editor.h b/include/metadata_editor.h
index 07d6a50..d012f1a 100755 (executable)
--- a/include/metadata_editor.h
+++ b/include/metadata_editor.h
@@ -14,8 +14,8 @@
 * limitations under the License.
 */
 
-#ifndef __TIZEN_METADATA_EDITOR_H__
-#define __TIZEN_METADATA_EDITOR_H__
+#ifndef __TIZEN_MULTIMEDIA_METADATA_EDITOR_H__
+#define __TIZEN_MULTIMEDIA_METADATA_EDITOR_H__
 
 
 #include <metadata_editor_type.h>
@@ -36,12 +36,12 @@ extern "C" {
 
 
 /**
- * @brief Create metadata
+ * @brief Creates metadata.
  * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
  *
- * @remarks You must release @a metadata using metadata_editor_destroy().
+ * @remarks The @a metadata should be released using metadata_editor_destroy().
  *
- * @param [in] metadata The handle to metadata
+ * @param[in] metadata The handle to metadata
  * @return 0 on success, otherwise a negative error value
  * @retval #METADATA_EDITOR_ERROR_NONE Successful
  * @retval #METADATA_EDITOR_ERROR_INVALID_PARAMETER Invalid parameter
@@ -52,14 +52,14 @@ int metadata_editor_create(metadata_editor_h *metadata);
 
 
 /**
- * @brief Set file path to read or write metadata
+ * @brief Sets file path to read or write metadata.
  * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
  *
  * @remarks In case of accessing specific path in internal storage or external storage, you may add the privilege for accessing the path. \n
  *                   For example, if you get the specific path by using storage_get_directory(). you should add previlege http://tizen.org/privilege/mediastorage or http://tizen.org/privilege/externalstorage.
  *
- * @param [in] metadata The handle to metadata
- * @param [in] path path to read or write metadata
+ * @param[in] metadata The handle to metadata
+ * @param[in] path path to read or write metadata
  * @return 0 on success, otherwise a negative error value
  * @retval #METADATA_EDITOR_ERROR_NONE Successful
  * @retval #METADATA_EDITOR_ERROR_INVALID_PARAMETER Invalid parameter
@@ -74,17 +74,17 @@ int metadata_editor_set_path(metadata_editor_h metadata, const char *path);
 
 
 /**
- * @brief Get the metadata corresponding to the attribute.
+ * @brief Gets the metadata corresponding to the attribute.
  * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
  *
- * @remarks You must release @a value using @c free(). \n
+ * @remarks The @a value should be released using free(). \n
  *                   If the attribute value of the metadata is empty, return value is NULL. \n
  *                   In case of accessing specific path in internal storage or external storage, you may add the privilege for accessing the path. \n
  *                   For example, if you get the specific path by using storage_get_directory(). you should add previlege http://tizen.org/privilege/mediastorage or http://tizen.org/privilege/externalstorage.
  *
- * @param [in] metadata The handle to metadata
- * @param [in] attribute key attribute name to get
- * @param [out] value The value of the attribute
+ * @param[in] metadata The handle to metadata
+ * @param[in] attribute key attribute name to get
+ * @param[out] value The value of the attribute
  * @return 0 on success, otherwise a negative error value
  * @retval #METADATA_EDITOR_ERROR_NONE Successful
  * @retval #METADATA_EDITOR_ERROR_INVALID_PARAMETER Invalid parameter
@@ -98,16 +98,16 @@ int metadata_editor_get_metadata(metadata_editor_h metadata, metadata_editor_att
 
 
 /**
- * @brief Set the attribute of the metadata.
- * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
+ * @brief Sets the attribute of the metadata.
  * @details This function set the attribute of the metadata for updating the metadata. \n
+ * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
  *
- * @remarks You must release @a value using @c free(). \n
+ * @remarks The @a value should be released using free(). \n
  *                  You must call metadata_editor_update_metadata() for applying to the metadata of the media file. if not, you will see the existing metadata when you call metadata_editor_get_metadata().
  *
- * @param [in] metadata The handle to metadata
- * @param [in] attribute key attribute name to get
- * @param [in] value The value of the attribute
+ * @param[in] metadata The handle to metadata
+ * @param[in] attribute key attribute name to get
+ * @param[in] value The value of the attribute
  * @return 0 on success, otherwise a negative error value
  * @retval #METADATA_EDITOR_ERROR_NONE Successful
  * @retval #METADATA_EDITOR_ERROR_INVALID_PARAMETER Invalid parameter
@@ -120,14 +120,14 @@ int metadata_editor_set_metadata(metadata_editor_h metadata, metadata_editor_att
 
 
 /**
- * @brief Update the modified metadata
- * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
+ * @brief Updates the modified metadata.
  * @details This function update the metadata in the media file that is modified by metadata_editor_set_metadata().
+ * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
  *
  * @remarks In case of accessing specific path in internal storage or external storage, you may add the privilege for accessing the path. \n
  *                   For example, if you get the specific path by using storage_get_directory(). you should add previlege http://tizen.org/privilege/mediastorage or http://tizen.org/privilege/externalstorage.
  *
- * @param [in] metadata The handle to metadata
+ * @param[in] metadata The handle to metadata
  * @return 0 on success, otherwise a negative error value
  * @retval #METADATA_EDITOR_ERROR_NONE Successful
  * @retval #METADATA_EDITOR_ERROR_INVALID_PARAMETER Invalid parameter
@@ -140,18 +140,18 @@ int metadata_editor_set_metadata(metadata_editor_h metadata, metadata_editor_att
 int metadata_editor_update_metadata(metadata_editor_h metadata);
 
 /**
- * @brief Get the picture in the media file
+ * @brief Gets the picture in the media file.
  * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
  *
- * @remarks You must release @a picture using @c free(). \n
+ * @remarks The @a picture abd @a mime_type should be released using free(). \n
  *                   In case of accessing specific path in internal storage or external storage, you may add the privilege for accessing the path. \n
  *                   For example, if you get the specific path by using storage_get_directory(). you should add previlege http://tizen.org/privilege/mediastorage or http://tizen.org/privilege/externalstorage.
  *
- * @param [in] metadata The handle to metadata
- * @param [in] index picture order
- * @param [out] picture encoded picture
- * @param [out] size encoded picture size
- * @param [out] mime_type the mime type of picture
+ * @param[in] metadata The handle to metadata
+ * @param[in] index picture order
+ * @param[out] picture encoded picture
+ * @param[out] size encoded picture size
+ * @param[out] mime_type the MIME of the picture
  * @return 0 on success, otherwise a negative error value
  * @retval #METADATA_EDITOR_ERROR_NONE Successful
  * @retval #METADATA_EDITOR_ERROR_INVALID_PARAMETER Invalid parameter
@@ -164,7 +164,7 @@ int metadata_editor_update_metadata(metadata_editor_h metadata);
 int metadata_editor_get_picture(metadata_editor_h metadata, int index, void **picture, int *size, char **mime_type);
 
 /**
- * @brief Append the picture to the media file
+ * @brief Appends the picture to the media file.
  * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
  *
  * @remarks You must call metadata_editor_update_metadata() for applying to the metadata of the media file. if not, you will see the existing metadata when you call metadata_editor_get_metadata(). \n
@@ -172,8 +172,8 @@ int metadata_editor_get_picture(metadata_editor_h metadata, int index, void **pi
  *                   In case of accessing specific path in internal storage or external storage, you may add the privilege for accessing the path. \n
  *                   For example, if you get the specific path by using storage_get_directory(). you should add previlege http://tizen.org/privilege/mediastorage or http://tizen.org/privilege/externalstorage.
  *
- * @param [in] metadata The handle to metadata
- * @param [in] picture_path The path of picture for adding to the metadata
+ * @param[in] metadata The handle to metadata
+ * @param[in] picture_path The path of picture for adding to the metadata
  * @return 0 on success, otherwise a negative error value
  * @retval #METADATA_EDITOR_ERROR_NONE Successful
  * @retval #METADATA_EDITOR_ERROR_INVALID_PARAMETER Invalid parameter
@@ -187,13 +187,13 @@ int metadata_editor_get_picture(metadata_editor_h metadata, int index, void **pi
 int metadata_editor_append_picture(metadata_editor_h metadata, const char *picture_path);
 
 /**
- * @brief Remove artwork image from media file
+ * @brief Removes artwork image from media file.
  * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
  *
  * @remarks You must call metadata_editor_update_metadata() for applying to the metadata of the media file. if not, you will see the existing metadata when you call metadata_editor_get_metadata(). \n
  *
- * @param [in] metadata The handle to metadata
- * @param [in] index artwork image order
+ * @param[in] metadata The handle to metadata
+ * @param[in] index artwork image order
  * @return 0 on success, otherwise a negative error value
  * @retval #METADATA_EDITOR_ERROR_NONE Successful
  * @retval #METADATA_EDITOR_ERROR_INVALID_PARAMETER Invalid parameter
@@ -206,10 +206,10 @@ int metadata_editor_append_picture(metadata_editor_h metadata, const char *pictu
 int metadata_editor_remove_picture(metadata_editor_h metadata, int index);
 
 /**
- * @brief Destroy metadata
+ * @brief Destroys metadata.
  * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
  *
- * @param [in] metadata The handle to metadata
+ * @param[in] metadata The handle to metadata
  * @return 0 on success, otherwise a negative error value
  * @retval #METADATA_EDITOR_ERROR_NONE Successful
  * @retval #METADATA_EDITOR_ERROR_INVALID_PARAMETER Invalid parameter
@@ -228,4 +228,4 @@ int metadata_editor_destroy(metadata_editor_h metadata);
 }
 #endif /* __cplusplus */
 
-#endif /* __TIZEN_METADATA_EDITOR_H__ */
+#endif /* __TIZEN_MULTIMEDIA_METADATA_EDITOR_H__ */

diff --git a/include/metadata_editor_private.h b/include/metadata_editor_private.h
index 4207292..767fdbb 100755 (executable)
--- a/include/metadata_editor_private.h
+++ b/include/metadata_editor_private.h
@@ -15,8 +15,8 @@
 */
 
 
-#ifndef __TIZEN_METADATA_EDITOR_PRIVATE_H__
-#define __TIZEN_METADATA_EDITOR_PRIVATE_H__
+#ifndef __TIZEN_MULTIMEDIA_METADATA_EDITOR_PRIVATE_H__
+#define __TIZEN_MULTIMEDIA_METADATA_EDITOR_PRIVATE_H__
 
 #include <iostream>
 #include <sys/stat.h>
@@ -96,4 +96,4 @@ typedef struct {
 #ifdef __cplusplus
 }
 #endif /* __cplusplus */
-#endif /*__TIZEN_METADATA_EDITOR_PRIVATE_H__*/
+#endif /*__TIZEN_MULTIMEDIA_METADATA_EDITOR_PRIVATE_H__*/

diff --git a/include/metadata_editor_type.h b/include/metadata_editor_type.h
index d7ab918..f1e55ba 100755 (executable)
--- a/include/metadata_editor_type.h
+++ b/include/metadata_editor_type.h
@@ -16,8 +16,8 @@
 
 
 
-#ifndef __TIZEN_METADATA_EDITOR_TYPE_H__
-#define __TIZEN_METADATA_EDITOR_TYPE_H__
+#ifndef __TIZEN_MULTIMEDIA_METADATA_EDITOR_TYPE_H__
+#define __TIZEN_MULTIMEDIA_METADATA_EDITOR_TYPE_H__
 
 #include <tizen.h>
 
@@ -31,12 +31,17 @@ extern "C" {
 * @{
 */
 
-/** @brief Definition for Metadata editor Error Class */
+
+/**
+* @brief Definition for Metadata editor Error Class.
+* @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
+*
+*/
 #define METADATA_EDITOR_ERROR_CLASS                            TIZEN_ERROR_METADATA_EDITOR
 
 /**
  * @ingroup CAPI_MEDIA_METADATA_EDITOR_MODULE
- * @brief The enumerations of media metadata error
+ * @brief The enumerations of media metadata error.
  * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
  */
 typedef enum {
@@ -52,7 +57,7 @@ typedef enum {
 
 /**
  * @ingroup CAPI_MEDIA_METADATA_EDITOR_MODULE
- * @brief The enumerations of attribute
+ * @brief The enumerations of attribute.
  * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
  */
 typedef enum {
@@ -73,7 +78,7 @@ typedef enum {
 
 /**
  * @ingroup CAPI_MEDIA_METADATA_EDITOR_MODULE
- * @brief The handle of media metadata
+ * @brief The handle of media metadata.
  * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
  */
 typedef void * metadata_editor_h;
@@ -86,4 +91,4 @@ typedef void * metadata_editor_h;
 }
 #endif /* __cplusplus */
 
-#endif /*__TIZEN_METADATA_EDITOR_TYPE_H__*/
+#endif /*__TIZEN_MULTIMEDIA_METADATA_EDITOR_TYPE_H__*/

diff --git a/packaging/capi-media-metadata-editor.spec b/packaging/capi-media-metadata-editor.spec
index e69ec87..d55882b 100755 (executable)
--- a/packaging/capi-media-metadata-editor.spec
+++ b/packaging/capi-media-metadata-editor.spec
@@ -1,6 +1,6 @@
 Name:       capi-media-metadata-editor
 Summary:    A metadata editor library in Tizen Native API
-Version: 0.1.7
+Version: 0.1.8
 Release:    0
 Group:      Multimedia/API
 License:    Apache-2.0