Modify error type(annotation) 65/40565/3
authorMinje Ahn <minje.ahn@samsung.com>
Fri, 5 Jun 2015 07:01:28 +0000 (16:01 +0900)
committerMinje Ahn <minje.ahn@samsung.com>
Fri, 5 Jun 2015 07:25:21 +0000 (16:25 +0900)
Change-Id: I0145b68cc08a327048b3f8c945dcc5af0bef0f8a
Signed-off-by: Minje Ahn <minje.ahn@samsung.com>
include/media-thumbnail-private.h
include/media-thumbnail.h
server/include/thumb-server-internal.h
src/include/media-thumb-internal.h
src/include/util/media-thumb-util.h

index a7d1daf..84842f6 100755 (executable)
@@ -33,7 +33,7 @@ extern "C" {
  *     This function generates a hash code using its original path by md5 algorithm. 
  *     If done, the code will be returned.
  *
- *     @return         This function returns zero(MEDIA_THUMB_ERROR_NONE) on success, or negative value with error code.
+ *     @return         This function returns zero(MS_MEDIA_ERR_NONE) on success, or negative value with error code.
  *                             Please refer 'media-thumb-error.h' to know the exact meaning of the error.
  *  @param[in]                         origin_path      The path of the original media
  *  @param[out]                                hash_code       The hash code generated by md5 algorithm.
@@ -49,7 +49,7 @@ extern "C" {
 
 void gen_thumb_hash_code()
 {
-       int ret = MEDIA_THUMB_ERROR_NONE;
+       int ret = MS_MEDIA_ERR_NONE;
        const char *origin_path = "/opt/usr/media/test.jpg";
        char hashcode[255];
 
index f3b6148..8983e76 100755 (executable)
@@ -32,185 +32,19 @@ extern "C" {
 #endif
 
 
-/**
-       @defgroup       THUMB_GENERATE  Thumbnail generator
-        @{
-         * @file                       media-thumbnail.h
-         * @brief              This file defines API's for thumbnail generator.
-         * @version            1.0
- */
-
-/**
-        @defgroup THUMB_API    Thumbnail generator API
-        @{
-
-        @par
-        generates thumbnail data and return the path of the generated thumbnail file.
- */
-
 
-/**
- * Callback function, which is used to call thumbnail_request_from_db_async
- */
 
 typedef int (*ThumbFunc) (int error_code, char* path, void* data);
 
-
-/**
- *     thumbnail_request_from_db:
- *     This function connects to the media database and find thumbnail path of the passed original image. 
- *  If found, the thumbnail path will be returned, or starts to generate thumbnail
- *
- *     @return         This function returns zero(MEDIA_THUMB_ERROR_NONE) on success, or negative value with error code.
- *                             Please refer 'media-thumb-error.h' to know the exact meaning of the error.
- *  @param[in]                         origin_path      The path of the original image
- *  @param[out]                                thumb_path       The path of generated thumbnail image.
- *  @param[in]                         max_length       The max length of the returned thumbnail path.
- *     @see            None.
- *     @pre            None.
- *     @post           None.
- *     @remark The database name is "/opt/usr/dbspace/.media.db".
- *     @par example
- *     @code
-
-#include <media-thumbnail.h>
-
-void gen_thumbs()
-{
-       int ret = MEDIA_THUMB_ERROR_NONE;
-       const char *origin_path = "/opt/usr/media/test.jpg";
-       char thumb_path[255];
-
-       ret = thumbnail_request_from_db(origin_path, thumb_path, 255);
-
-       if (ret < 0)
-       {
-               printf( "thumbnail_request_from_db fails. error code->%d", ret);
-       }
-
-       return;
-}
-
- *     @endcode
- */
 int thumbnail_request_from_db(const char *origin_path, char *thumb_path, int max_length, uid_t uid);
 
-/**
- *     thumbnail_request_from_db_async:
- *     This function connects to the media database and find thumbnail path of the passed original image. 
- *  If found, the thumbnail path will be returned through callback, which is registered by user.
- *
- *     @return         This function returns zero(MEDIA_THUMB_ERROR_NONE) on success, or negative value with error code.
- *                             Please refer 'media-thumb-error.h' to know the exact meaning of the error.
- *  @param[in]                         origin_path     The path of the original image
- *  @param[in]                         func            The callback, which is registered by user
- *  @param[in]                         user_data       User data, which is used by user in callback
- *     @see            None.
- *     @pre            None.
- *     @post           None.
- *     @remark The database name is "/opt/usr/dbspace/.media.db".
- *     @par example
- *     @code
-
-#include <media-thumbnail.h>
-
-int _thumb_cb(int error_code, char *path, void *user_data)
-{
-       printf("Error code : %d\n", error_code);
-       printf("Thumb path : %s\n", path);
-}
-
-void gen_thumbs()
-{
-       int ret = MEDIA_THUMB_ERROR_NONE;
-       const char *origin_path = "/opt/usr/media/test.jpg";
-       char thumb_path[255];
-
-       ret = thumbnail_request_from_db_async(origin_path, _thumb_cb, NULL);
-
-       if (ret < 0)
-       {
-               printf( "thumbnail_request_from_db_async fails. error code->%d", ret);
-       }
-
-       return;
-}
-
- *     @endcode
- */
 int thumbnail_request_from_db_async(const char *origin_path, ThumbFunc func, void *user_data, uid_t uid);
 
-/**
- *     thumbnail_request_save_to_file:
- *     This function generates thumbnail of the original path and save it to the file system as jpeg format with the passed thumbnail path.
- *  This function doesn't care about media DB.
- *
- *     @return         This function returns zero(MEDIA_THUMB_ERROR_NONE) on success, or negative value with error code.
- *                             Please refer 'media-thumb-error.h' to know the exact meaning of the error.
- *  @param[in]                         origin_path      The path of the original image
- *  @param[in]                         thumb_type       The type of the returned thumbnail data.
- *  @param[in]                         thumb_path       The path of generated thumbnail image.
- *     @see            None.
- *     @pre            None.
- *     @post           None.
- *     @par example
- *     @code
-
-#include <media-thumbnail.h>
-
-void save_thumbs()
-{
-       int ret = MEDIA_THUMB_ERROR_NONE;
-       const char *origin_path = "/opt/usr/media/test.jpg";
-       const char *thumb_path = "/my_dir/thumb.jpg";
-
-       ret = thumbnail_request_save_to_file(origin_path, thumb_path);
-
-       if (ret < 0) {
-               printf( "thumbnail_request_save_to_file fails. error code->%d", ret);
-       }
-
-       return;
-}
-
- *     @endcode
- */
 int thumbnail_request_save_to_file(const char *origin_path,
                                                                        media_thumb_type thumb_type,
                                                                        const char *thumb_path, uid_t uid);
 
 
-/**
- *     thumbnail_request_extract_all_thumbs:
- *     This function generates thumbnail of all media, which don't have thumbnail yet and save it to the file system as jpeg format.
- *  Once thumbnail generated, the thumbnail path and original image's width and height will be updated to media database.
- *
- *     @return         This function returns zero(MEDIA_THUMB_ERROR_NONE) on success, or negative value with error code.
- *                             Please refer 'media-thumb-error.h' to know the exact meaning of the error.
- *     @see            None.
- *     @pre            None.
- *     @post           None.
- *     @par example
- *     @code
-
-#include <media-thumbnail.h>
-
-void extract_all_thumbs()
-{
-       int ret = MEDIA_THUMB_ERROR_NONE;
-
-       ret = thumbnail_request_extract_all_thumbs();
-
-       if (ret < 0) {
-               printf( "thumbnail_request_extract_all_thumbs fails. error code->%d", ret);
-       }
-
-       return;
-}
-
- *     @endcode
- */
-
 int thumbnail_request_extract_all_thumbs(uid_t uid);
 
 int thumbnail_request_from_db_with_size(const char *origin_path, char *thumb_path, int max_length, int *origin_width, int *origin_height, uid_t uid);
@@ -221,12 +55,6 @@ int thumbnail_request_cancel_media(const char *origin_path, uid_t uid);
 /* Cancel APIs that all requests to extract thumbnail of a process */
 int thumbnail_request_cancel_all();
 
-/** @} */
-
-/**
-       @}
- */
-
 #ifdef __cplusplus
 }
 #endif
index bcf5f4d..13e06fe 100755 (executable)
@@ -54,4 +54,3 @@ gboolean _thumb_server_read_socket(GIOChannel *src,
                                                                        gpointer data);
 
 #endif /*_THUMB_DAEMON_INTERNAL_H_*/
-
index addbc7b..f101f52 100755 (executable)
@@ -66,16 +66,14 @@ typedef struct {
        void *user_data;
 } thumbUserData;
 
-int
-_media_thumb_image(const char *origin_path,
+int _media_thumb_image(const char *origin_path,
                                        int thumb_width,
                                        int thumb_height,
                                        media_thumb_format format,
                                        media_thumb_info *thumb_info,
                                        uid_t uid);
 
-int
-_media_thumb_video(const char *origin_path,
+int _media_thumb_video(const char *origin_path,
                                        int thumb_width,
                                        int thumb_height,
                                        media_thumb_format format,
index 7eee7d8..41e48f4 100755 (executable)
 typedef enum
 {
        THUMB_PHONE,                    /**< Stored only in phone */
-       THUMB_MMC                               /**< Stored only in MMC */      
+       THUMB_MMC                               /**< Stored only in MMC */
 } media_thumb_store_type;
 
 int _media_thumb_get_length(media_thumb_type thumb_type);
 
 int _media_thumb_get_store_type_by_path(const char *full_path);
 
-int
-_media_thumb_get_file_ext(const char *file_path, char *file_ext, int max_len);
+int _media_thumb_get_file_ext(const char *file_path, char *file_ext, int max_len);
 
-int
-_media_thumb_get_file_type(const char *file_full_path);
+int _media_thumb_get_file_type(const char *file_full_path);
 
-int
-_media_thumb_remove_file(const char *path);
+int _media_thumb_remove_file(const char *path);
 
-char
-*_media_thumb_generate_hash_name(const char *file);
+char* _media_thumb_generate_hash_name(const char *file);
 
-int
-_media_thumb_get_hash_name(const char *file_full_path,
-                                char *thumb_hash_path, size_t max_thumb_path, uid_t uid);
+int _media_thumb_get_hash_name(const char *file_full_path, char *thumb_hash_path, size_t max_thumb_path, uid_t uid);
 
-int
-_media_thumb_save_to_file_with_gdk(GdkPixbuf *data,
+int _media_thumb_save_to_file_with_gdk(GdkPixbuf *data,
                                                                                        int w,
                                                                                        int h,
                                                                                        gboolean alpha,
                                                                                        char *thumb_path);
 
-int
-_media_thumb_get_width(media_thumb_type thumb_type);
+int _media_thumb_get_width(media_thumb_type thumb_type);
 
-int
-_media_thumb_get_height(media_thumb_type thumb_type);
+int _media_thumb_get_height(media_thumb_type thumb_type);
 
-/**
- *     _thumbnail_get_data:
- *  This function generates thumbnail raw data, which is wanted by user
- *  This api is closed for a while until being independent from evas object to be thread-safe
- *
- *     @return         This function returns zero(MEDIA_THUMB_ERROR_NONE) on success, or negative value with error code.
- *                             Please refer 'media-thumb-error.h' to know the exact meaning of the error.
- *  @param[in]                         origin_path      The path of the original image
- *  @param[in]                         thumb_type       The type of the returned thumbnail data
- *  @param[in]                         format           The format of the returned data
- *  @param[out]                                data             The data of generated thumbnail.
- *  @param[out]                                size             The size of generated thumbnail.
- *  @param[out]                                width             The width of generated thumbnail.
- *  @param[out]                                height             The height of generated thumbnail.
- *  @param[out]                                origin_width        The width of original image.
- *  @param[out]                                origin_height       The height of original image.
- *     @see            None.
- *     @pre            None.
- *     @post           None.
- *     @remark         None.   
- *     @par example
- *     @code
-
-#include <media-thumbnail.h>
-
-void test_get_thumb_data()
-{
-       int ret = MEDIA_THUMB_ERROR_NONE;
-       int thumb_type = 0;
-       const char *origin_path = "/opt/usr/media/test.jpg";
-       void *data = NULL;
-       
-
-       ret = _thumbnail_get_data(origin_path, thumb_type, thumb_path, &data);
-
-       if (ret < 0)
-       {
-               printf( "_thumbnail_get_data fails. error code->%d", ret);
-       }
-
-       return;
-}
-
- *     @endcode
-*/
 int _thumbnail_get_data(const char *origin_path,
                                                media_thumb_type thumb_type,
                                                media_thumb_format format,