diff options
author | hj kim <backto.kim@samsung.com> | 2018-01-24 14:40:22 +0900 |
---|---|---|
committer | hj kim <backto.kim@samsung.com> | 2018-01-24 15:25:45 +0900 |
commit | 03b788591df88b32da73311fa65bc21be883f097 (patch) | |
tree | 4d11d8e6892a5f9f107ebb50ad13768ae411371b /include | |
parent | 86be7d185867dc278117113e48d7e61034cdc45d (diff) | |
download | metadata-extractor-03b788591df88b32da73311fa65bc21be883f097.tar.gz metadata-extractor-03b788591df88b32da73311fa65bc21be883f097.tar.bz2 metadata-extractor-03b788591df88b32da73311fa65bc21be883f097.zip |
Fix Doxygen mistakes
Change-Id: I1d23bd86dde45236c1412227df58192b80754c00
Diffstat (limited to 'include')
-rwxr-xr-x | include/metadata_extractor.h | 32 | ||||
-rwxr-xr-x | include/metadata_extractor_private.h | 8 | ||||
-rwxr-xr-x | include/metadata_extractor_type.h | 11 |
3 files changed, 27 insertions, 24 deletions
diff --git a/include/metadata_extractor.h b/include/metadata_extractor.h index efcfd1d..11c3b75 100755 --- a/include/metadata_extractor.h +++ b/include/metadata_extractor.h @@ -14,8 +14,8 @@ * limitations under the License. */ -#ifndef __TIZEN_MEDIA_METADATA_EXTRACTOR_H__ -#define __TIZEN_MEDIA_METADATA_EXTRACTOR_H__ +#ifndef __TIZEN_MULTIMEDIA_METADATA_EXTRACTOR_H__ +#define __TIZEN_MULTIMEDIA_METADATA_EXTRACTOR_H__ #include <tizen.h> @@ -40,7 +40,7 @@ extern "C" { /** * @brief Creates metadata. * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif - * @remarks You must release @a metadata using metadata_extractor_destroy(). + * @remarks The @a metadata should be released using metadata_extractor_destroy(). * * @param[in] metadata The handle to metadata * @@ -58,8 +58,8 @@ int metadata_extractor_create(metadata_extractor_h *metadata); * @brief Sets the file path to extract. * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif * - * @param [in] metadata The handle to metadata - * @param [in] path The path to extract metadata + * @param[in] metadata The handle to metadata + * @param[in] path The path to extract metadata * * @return @c 0 on success, otherwise a negative error value * @retval #METADATA_EXTRACTOR_ERROR_NONE Successful @@ -78,9 +78,9 @@ int metadata_extractor_set_path(metadata_extractor_h metadata, const char *path) * @brief Sets the buffer to extract. * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif * - * @param [in] metadata The handle to metadata - * @param [in] buffer The buffer to extract metadata - * @param [in] size The buffer size + * @param[in] metadata The handle to metadata + * @param[in] buffer The buffer to extract metadata + * @param[in] size The buffer size * * @return @c 0 on success, otherwise a negative error value * @retval #METADATA_EXTRACTOR_ERROR_NONE Successful @@ -98,7 +98,7 @@ int metadata_extractor_set_buffer(metadata_extractor_h metadata, const void *buf * @brief Destroys metadata. * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif * - * @param [in] metadata The handle to metadata + * @param[in] metadata The handle to metadata * * @return @c 0 on success, otherwise a negative error value * @retval #METADATA_EXTRACTOR_ERROR_NONE Successful @@ -115,7 +115,7 @@ int metadata_extractor_destroy(metadata_extractor_h metadata); * @brief Gets metadata. * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif * - * @remarks You must release @a value using @c free(). \n + * @remarks The @a value 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. * @@ -140,14 +140,14 @@ int metadata_extractor_get_metadata(metadata_extractor_h metadata, metadata_extr * @brief Gets the artwork image in a media file. * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif * - * @remarks You must release @a artwork and @a artwork_mime using @c free(). \n + * @remarks The @a artwork and @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[out] artwork The encoded artwork image * @param[out] size The encoded artwork size - * @param[out] mime_type The mime type of artwork + * @param[out] mime_type The MIME of the artwork * @return @c 0 on success, otherwise a negative error value * * @retval #METADATA_EXTRACTOR_ERROR_NONE Successful @@ -166,7 +166,7 @@ int metadata_extractor_get_artwork(metadata_extractor_h metadata, void **artwork * @brief Gets the frame of a video media file. * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif * - * @remarks You must release @a frame using @c free(). + * @remarks The @a frame should be released using free(). * 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. * @@ -191,7 +191,7 @@ int metadata_extractor_get_frame(metadata_extractor_h metadata, void **frame, in * @brief Gets the synclyrics of a media file. * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif * - * @remarks You must release @a lyrics using @c free(). + * @remarks The @a lyrics should be released using free(). * 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. * @@ -217,7 +217,7 @@ int metadata_extractor_get_synclyrics(metadata_extractor_h metadata, int index, * @brief Gets the frame of a video media. * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif * - * @remarks You must release @a frame using @c free(). + * @remarks The @a frame should be released using free(). * 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. * @@ -250,6 +250,6 @@ int metadata_extractor_get_frame_at_time(metadata_extractor_h metadata, unsigned } #endif /* __cplusplus */ -#endif /* __TIZEN_MEDIA_METADATA_EXTRACTOR_H__ */ +#endif /* __TIZEN_MULTIMEDIA_METADATA_EXTRACTOR_H__ */ diff --git a/include/metadata_extractor_private.h b/include/metadata_extractor_private.h index b9ea8e7..4d63f2c 100755 --- a/include/metadata_extractor_private.h +++ b/include/metadata_extractor_private.h @@ -15,8 +15,8 @@ */ -#ifndef __TIZEN_MEDIA_METADATA_EXTRACTOR_PRIVATE_H__ -#define __TIZEN_MEDIA_METADATA_EXTRACTOR_PRIVATE_H__ +#ifndef __TIZEN_MULTIMEDIA_METADATA_EXTRACTOR_PRIVATE_H__ +#define __TIZEN_MULTIMEDIA_METADATA_EXTRACTOR_PRIVATE_H__ #include <stdbool.h> #include <mm_types.h> @@ -107,7 +107,5 @@ typedef struct { #ifdef __cplusplus } #endif /* __cplusplus */ -#endif /*__TIZEN_MEDIA_METADATA_EXTRACTOR_PRIVATE_H__*/ - - +#endif /*__TIZEN_MULTIMEDIA_METADATA_EXTRACTOR_PRIVATE_H__*/ diff --git a/include/metadata_extractor_type.h b/include/metadata_extractor_type.h index 690ab6f..85cd088 100755 --- a/include/metadata_extractor_type.h +++ b/include/metadata_extractor_type.h @@ -14,8 +14,8 @@ * limitations under the License. */ -#ifndef __TIZEN_MEDIA_METADATA_EXTRACTOR_TYPE_H__ -#define __TIZEN_MEDIA_METADATA_EXTRACTOR_TYPE_H__ +#ifndef __TIZEN_MULTIMEDIA_METADATA_EXTRACTOR_TYPE_H__ +#define __TIZEN_MULTIMEDIA_METADATA_EXTRACTOR_TYPE_H__ #include <tizen.h> @@ -32,6 +32,11 @@ extern "C" { * @{ */ +/** +* @brief Definition for Metadata extractor Error Class. +* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif +* +*/ #define METADATA_EXTRACTOR_ERROR_CLASS TIZEN_ERROR_METADATA_EXTRACTOR /** @@ -108,4 +113,4 @@ typedef struct metadata_extractor_s *metadata_extractor_h; } #endif /* __cplusplus */ -#endif /*__TIZEN_MEDIA_METADATA_EXTRACTOR_TYPE_H__*/ +#endif /*__TIZEN_MULTIMEDIA_METADATA_EXTRACTOR_TYPE_H__*/ |