Fix Dosygen mistakes 95/168095/2
authorhj kim <backto.kim@samsung.com>
Wed, 24 Jan 2018 06:24:56 +0000 (15:24 +0900)
committerhj kim <backto.kim@samsung.com>
Wed, 24 Jan 2018 06:58:12 +0000 (15:58 +0900)
Change-Id: Ic0a10736ad16ef94f5ecf3375f67f121434db904

include/thumbnail_util.h
include/thumbnail_util_private.h
include/thumbnail_util_type.h

index e5fa048..25447cd 100755 (executable)
@@ -14,8 +14,8 @@
 * limitations under the License.
 */
 
-#ifndef __TIZEN_THUMBNAIL_UTIL_H__
-#define __TIZEN_THUMBNAIL_UTIL_H__
+#ifndef __TIZEN_MULTIMEDIA_THUMBNAIL_UTIL_H__
+#define __TIZEN_MULTIMEDIA_THUMBNAIL_UTIL_H__
 
 #include <thumbnail_util_type.h>
 
@@ -37,7 +37,7 @@ extern "C" {
 /**
  * @brief Creates thumbnail info handle.
  * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
- * @remarks You must release @a thumb info using thumbnail_util_destroy().
+ * @remarks The @a thumb info should be released using thumbnail_util_destroy().
  *
  * @param[in] thumb The handle to thumbnail info
  *
@@ -61,7 +61,7 @@ int thumbnail_util_create(thumbnail_h *thumb);
  *
  * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
  *
- * @remarks You must release @a request_id using free(). \n
+ * @remarks The @a request_id should be released using free(). \n
  *                http://tizen.org/privilege/mediastorage is needed if input or output path are relevant to media storage. \n
  *                http://tizen.org/privilege/externalstorage is needed if input or output path are relevant to external storage. \n
  *                If you don't set the size, the thumbnail size will be set default size. Default size is 320x240. \n
@@ -87,7 +87,6 @@ int thumbnail_util_create(thumbnail_h *thumb);
  * @see thumbnail_util_set_size()
  * @see thumbnail_extracted_cb()
  * @see thumbnail_util_cancel()
- * @see thumbnail_util_cancel_all()
  * @see thumbnail_util_destroy()
  */
 int thumbnail_util_extract(thumbnail_h thumb, thumbnail_extracted_cb callback, void *user_data, char **request_id);
@@ -139,7 +138,7 @@ int thumbnail_util_set_size(thumbnail_h thumb, int width, int height);
 /**
  * @brief Cancels the thumbnail extraction request for the given media.
  * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
- * @remarks If there is no item you want to cancel, this API return MEDIA_CONTENT_ERROR_INVALID_OPERATION
+ * @remarks If there is no item you want to cancel, this function return MEDIA_CONTENT_ERROR_INVALID_OPERATION
  *
  * @param[in] thumb         The media thumbnail info handle
  * @param[in] request_id   The generated request id by thumbnail extraction request
@@ -159,7 +158,7 @@ int thumbnail_util_cancel(thumbnail_h thumb, const char *request_id);
  * @deprecated Deprecated since 4.0. Use thumbnail_util_cancel() instead.
  * @brief Cancels all thumbnail extraction requests associated with the given thumbnail info handle.
  * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
- * @remarks If there is no item you want to cancel, this API return MEDIA_CONTENT_ERROR_INVALID_OPERATION
+ * @remarks If there is no item you want to cancel, this function return MEDIA_CONTENT_ERROR_INVALID_OPERATION
  *
  * @param[in] thumb The media thumbnail info handle
  *
@@ -203,4 +202,4 @@ int thumbnail_util_destroy(thumbnail_h thumb);
 }
 #endif /* __cplusplus */
 
-#endif /* __TIZEN_THUMBNAIL_UTIL_H__ */
+#endif /* __TIZEN_MULTIMEDIA_THUMBNAIL_UTIL_H__ */
index 763ea6e..6fe642a 100755 (executable)
@@ -16,8 +16,8 @@
 
 
 
-#ifndef __TIZEN_THUMBNAIL_UTIL_PRIVATE_H__
-#define __TIZEN_THUMBNAIL_UTIL_PRIVATE_H__
+#ifndef __TIZEN_MULTIMEDIA_THUMBNAIL_UTIL_PRIVATE_H__
+#define __TIZEN_MULTIMEDIA_THUMBNAIL_UTIL_PRIVATE_H__
 
 
 #include <unistd.h>
@@ -90,4 +90,4 @@ typedef struct {
 #ifdef __cplusplus
 }
 #endif /* __cplusplus */
-#endif /*__TIZEN_THUMBNAIL_UTIL_PRIVATE_H__*/
+#endif /*__TIZEN_MULTIMEDIA_THUMBNAIL_UTIL_PRIVATE_H__*/
index c60f8f5..ef5d52c 100755 (executable)
@@ -15,8 +15,8 @@
 */
 
 
-#ifndef __TIZEN_THUMBNAIL_UTIL_TYPE_H__
-#define __TIZEN_THUMBNAIL_UTIL_TYPE_H__
+#ifndef __TIZEN_MULTIMEDIA_THUMBNAIL_UTIL_TYPE_H__
+#define __TIZEN_MULTIMEDIA_THUMBNAIL_UTIL_TYPE_H__
 
 #include <time.h>
 #include <tizen.h>
@@ -30,6 +30,11 @@ extern "C" {
  * @{
  */
 
+/**
+* @brief Definition for Thumbnail util Error Class.
+* @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
+*
+*/
 #define THUMBNAIL_UTIL_ERROR_CLASS                             TIZEN_ERROR_THUMBNAIL_UTIL
 
 /**
@@ -60,12 +65,16 @@ typedef struct thumbnail_s *thumbnail_h;
  * @ingroup CAPI_MEDIA_THUMBNAIL_UTIL_MODULE
  * @brief Called when creating the thumbnail.
  * @details This callback is called for completion of generating the thumbnail.
+ *            The following error codes can be received: \n
+ *            #THUMBNAIL_UTIL_ERROR_NONE : Successful
+ *            #THUMBNAIL_UTIL_ERROR_INVALID_PARAMETER : Invalid parameter
+ *            #THUMBNAIL_UTIL_ERROR_PERMISSION_DENIED : Permission denied
  *
  * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
  *
  * @remarks Color space of the generated thumbnail is BGRA. \n
  *                  The callback is called in a separate thread(not in the main loop). \n
- *                  You must release @a thumb_data using free().
+ *                  The @a thumb_data should be released using free().
  *
  * @param[in] error     The error code
  * @param[in] request_id       The generated request id by thumbnail extraction request
@@ -89,4 +98,4 @@ typedef void (*thumbnail_extracted_cb)(thumbnail_util_error_e error, const char
 #endif /* __cplusplus */
 
 
-#endif /*__TIZEN_THUMBNAIL_UTIL_TYPE_H__*/
+#endif /*__TIZEN_MULTIMEDIA_THUMBNAIL_UTIL_TYPE_H__*/