Merge branch 'devel/home/master'

Change-Id: Icd8fc17682324b3fc5dd20c43609d2cda0d294ca

7 files changed, 59 insertions, 60 deletions

diff --git a/doc/shortcut_doc.h b/doc/shortcut_doc.h
index 55b7c9a..8123d21 100644
--- a/doc/shortcut_doc.h
+++ b/doc/shortcut_doc.h
@@ -23,7 +23,7 @@
  * @brief To enhance the Add to home feature. Two types of API set are supported.
  *   - One for the homescreen developers.
  *   - The others for the application developers who should implement the Add to home feature.
- * @ingroup CORE_LIB_GROUP 
+ * @ingroup CAPI_APPLICATION_FRAMEWORK 
  * @section SHORTCUT_MODULE_HEADER Required Header
  *   \#include <shortcut.h>
  * @section SHORTCUT_MODULE_OVERVIEW Overview
diff --git a/lib/CMakeLists.txt b/lib/CMakeLists.txt
index 9731104..b26f003 100644
--- a/lib/CMakeLists.txt
+++ b/lib/CMakeLists.txt
@@ -44,7 +44,7 @@ SET_DIRECTORY_PROPERTIES(PROPERTIES ADDITIONAL_MAKE_CLEAN_FILES "${PROJECT_NAME}
 
 INSTALL(TARGETS ${PROJECT_NAME} DESTINATION lib)
 INSTALL(FILES ${CMAKE_SOURCE_DIR}/lib/include/shortcut.h DESTINATION include/${PROJECT_NAME})
-INSTALL(FILES ${CMAKE_SOURCE_DIR}/lib/include/shortcut_internal.h DESTINATION include/${PROJECT_NAME})
+INSTALL(FILES ${CMAKE_SOURCE_DIR}/lib/include/shortcut_product.h DESTINATION include/${PROJECT_NAME})
 INSTALL(FILES ${CMAKE_BINARY_DIR}/lib/${PROJECT_NAME}.pc DESTINATION lib/pkgconfig)
 INSTALL(FILES ${CMAKE_SOURCE_DIR}/lib/LICENSE DESTINATION /usr/share/license RENAME "lib${PROJECT_NAME}")
 
diff --git a/lib/include/shortcut.h b/lib/include/shortcut.h
index 0f101d1..de3b5ee 100644
--- a/lib/include/shortcut.h
+++ b/lib/include/shortcut.h
@@ -46,7 +46,7 @@ extern "C" {
  * @param[in] data Callback data
  * @return Developer should returns the result of handling shortcut creation request\n
  *             Returns 0, if succeed to handles the add_to_home request, or returns proper errno
- * @see shortcut_set_request_cb
+ * @see shortcut_set_request_cb()
  */
 typedef int (*request_cb_t)(const char *appid, const char *name, int type, const char *content_info, const char *icon, int pid, double period, int allow_duplicate, void *data);
 
@@ -261,12 +261,12 @@ extern int shortcut_set_request_cb(request_cb_t request_cb, void *data);
  *
  * @return Return Type (int)
  * @retval 0 Succeed to send the request
- * @retval SHORTCUT_ERROR_FAULT Unrecoverable error
- * @retval SHORTCUT_ERROR_INVALID Shortcut request is not valid, invalid parameter or invalid argument value
- * @retval SHORTCUT_ERROR_COMM Connection is not estabilished. or there is a problem of communication
- * @retval SHORTCUT_ERROR_MEMORY Memory is not enough to handle new request
- * @retval SHORTCUT_ERROR_IO Unable to access file or DB. Check your resource files
- * @retval SHORTCUT_ERROR_PERMISSION Has no permission to add a shortcut
+ * @retval #SHORTCUT_ERROR_FAULT Unrecoverable error
+ * @retval #SHORTCUT_ERROR_INVALID Shortcut request is not valid, invalid parameter or invalid argument value
+ * @retval #SHORTCUT_ERROR_COMM Connection is not estabilished. or there is a problem of communication
+ * @retval #SHORTCUT_ERROR_MEMORY Memory is not enough to handle new request
+ * @retval #SHORTCUT_ERROR_IO Unable to access file or DB. Check your resource files
+ * @retval #SHORTCUT_ERROR_PERMISSION Has no permission to add a shortcut
  *
  * @pre You have to prepare the callback function.
  *
@@ -329,8 +329,8 @@ extern int add_to_home_shortcut(const char *appid, const char *name, int type, c
  *
  * @return Return Type (int)
  * @retval @c N Number of items (call count of callback function)
- * @retval SHORTCUT_ERROR_FAULT Unrecoverable error
- * @retval SHORTCUT_ERROR_IO Unable to access file or DB. Check your resource files
+ * @retval #SHORTCUT_ERROR_FAULT Unrecoverable error
+ * @retval #SHORTCUT_ERROR_IO Unable to access file or DB. Check your resource files
  *
  * @pre You have to prepare the callback function.
  *
@@ -369,12 +369,12 @@ extern int shortcut_get_list(const char *appid, int (*cb)(const char *appid, con
  *
  * @return Return Type (int)
  * @retval 0 Succeed to send the request
- * @retval SHORTCUT_ERROR_FAULT Unrecoverable error
- * @retval SHORTCUT_ERROR_INVALID Shortcut request is not valid, invalid parameter or invalid argument value
- * @retval SHORTCUT_ERROR_COMM Connection is not estabilished or there is a problem of communication
- * @retval SHORTCUT_ERROR_MEMORY Memory is not enough to handle new request
- * @retval SHORTCUT_ERROR_IO Unable to access file or DB  Check your resource files
- * @retval SHORTCUT_ERROR_PERMISSION Has no permission to add a shortcut
+ * @retval #SHORTCUT_ERROR_FAULT Unrecoverable error
+ * @retval #SHORTCUT_ERROR_INVALID Shortcut request is not valid, invalid parameter or invalid argument value
+ * @retval #SHORTCUT_ERROR_COMM Connection is not estabilished or there is a problem of communication
+ * @retval #SHORTCUT_ERROR_MEMORY Memory is not enough to handle new request
+ * @retval #SHORTCUT_ERROR_IO Unable to access file or DB  Check your resource files
+ * @retval #SHORTCUT_ERROR_PERMISSION Has no permission to add a shortcut
  *
  * @pre You have to prepare the callback function.
  *
@@ -439,12 +439,12 @@ extern int add_to_home_livebox(const char *appid, const char *name, int type, co
  *
  * @return Return Type (int)
  * \retval 0 Succeed to send the request
- * \retval SHORTCUT_ERROR_FAULT Unrecoverable error
- * \retval SHORTCUT_ERROR_INVALID Shortcut request is not valid, invalid parameter or invalid argument value
- * \retval SHORTCUT_ERROR_COMM Connection is not estabilished. or there is a problem of communication
- * \retval SHORTCUT_ERROR_MEMORY Memory is not enough to handle new request
- * \retval SHORTCUT_ERROR_IO Unable to access file or DB. Check your resource files
- * \retval SHORTCUT_ERROR_PERMISSION Has no permission to add a shortcut
+ * \retval #SHORTCUT_ERROR_FAULT Unrecoverable error
+ * \retval #SHORTCUT_ERROR_INVALID Shortcut request is not valid, invalid parameter or invalid argument value
+ * \retval #SHORTCUT_ERROR_COMM Connection is not estabilished. or there is a problem of communication
+ * \retval #SHORTCUT_ERROR_MEMORY Memory is not enough to handle new request
+ * \retval #SHORTCUT_ERROR_IO Unable to access file or DB. Check your resource files
+ * \retval #SHORTCUT_ERROR_PERMISSION Has no permission to add a shortcut
  *
  * @pre You have to prepare the callback function
  *
@@ -508,12 +508,12 @@ extern int add_to_home_remove_shortcut(const char *appid, const char *name, cons
  *
  * @return Return Type (int)
  * \retval 0 Succeed to send the request
- * \retval SHORTCUT_ERROR_FAULT Unrecoverable error
- * \retval SHORTCUT_ERROR_INVALID Shortcut request is not valid, invalid parameter or invalid argument value
- * \retval SHORTCUT_ERROR_COMM Connection is not estabilished. or there is a problem of communication
- * \retval SHORTCUT_ERROR_MEMORY Memory is not enough to handle new request
- * \retval SHORTCUT_ERROR_IO Unable to access file or DB. Check your resource files
- * \retval SHORTCUT_ERROR_PERMISSION Has no permission to add a shortcut
+ * \retval #SHORTCUT_ERROR_FAULT Unrecoverable error
+ * \retval #SHORTCUT_ERROR_INVALID Shortcut request is not valid, invalid parameter or invalid argument value
+ * \retval #SHORTCUT_ERROR_COMM Connection is not estabilished. or there is a problem of communication
+ * \retval #SHORTCUT_ERROR_MEMORY Memory is not enough to handle new request
+ * \retval #SHORTCUT_ERROR_IO Unable to access file or DB. Check your resource files
+ * \retval #SHORTCUT_ERROR_PERMISSION Has no permission to add a shortcut
  *
  * @pre You have to prepare the callback function
  *
@@ -521,7 +521,6 @@ extern int add_to_home_remove_shortcut(const char *appid, const char *name, cons
  *
  * @see result_cb_t
  *
- *
  * @par Example
  * @code
  *
diff --git a/lib/include/shortcut_internal.h b/lib/include/shortcut_product.h
index c18bc63..9a9b21a 100644
--- a/lib/include/shortcut_internal.h
+++ b/lib/include/shortcut_product.h
@@ -15,8 +15,8 @@
  *
 */
 
-#if !defined(__SHORTCUT_INTERNAL_H__)
-#define __SHORTCUT_INTERNAL_H__
+#if !defined(__SHORTCUT_PRODUCT_H__)
+#define __SHORTCUT_PRODUCT_H__
 
 #ifdef __cplusplus
 extern "C" {
@@ -122,27 +122,27 @@ typedef int (*icon_request_cb_t)(struct shortcut_icon *handle, int ret, void *da
  * @param[in] init_cb Initialized result will be delievered via this callback
  * @param[in] data Callback data
  * @return int value
- * @retval SHORTCUT_ERROR_INVALID Already initialized
- * @retval SHORTCUT_ERROR_SUCCESS Successfully initialized
- * @see shortcut_icon_service_fini
+ * @retval #SHORTCUT_ERROR_INVALID Already initialized
+ * @retval #SHORTCUT_ERROR_SUCCESS Successfully initialized
+ * @see shortcut_icon_service_fini()
  */
 extern int shortcut_icon_service_init(int (*init_cb)(int status, void *data), void *data);
 
 /**
  * @brief Finalizes the icon creation service.
  * @return int value
- * @retval SHORTCUT_SUCCESS Successfully initialized
- * @retval SHORTCUT_ERROR_INVALID icon service is not initialized
- * @see shortcut_icon_service_init
+ * @retval #SHORTCUT_SUCCESS Successfully initialized
+ * @retval #SHORTCUT_ERROR_INVALID icon service is not initialized
+ * @see shortcut_icon_service_init()
  */
 extern int shortcut_icon_service_fini(void);
 
 /**
  * @brief Creates a request object to create a new icon image.
  * @return struct shortcut_icon * value
- * @retval NULL If it fails to create a new handle
+ * @retval @c NULL If it fails to create a new handle
  * @retval pointer Handle address
- * @see shortcut_icon_request_destroy
+ * @see shortcut_icon_request_destroy()
  */
 extern struct shortcut_icon *shortcut_icon_request_create(void);
 
@@ -150,16 +150,16 @@ extern struct shortcut_icon *shortcut_icon_request_create(void);
  * @brief Sets information for creating icon image.
  * @param[in] handle Request handle
  * @param[in] id Target ID to be affected by this data
- * @param[in] type SHORTCUT_ICON_TYPE_IMAGE, SHORTCUT_ICON_TYPE_TEXT, SHORTCUT_ICON_TYPE_SCRIPT can be used
+ * @param[in] type #SHORTCUT_ICON_TYPE_IMAGE, #SHORTCUT_ICON_TYPE_TEXT, #SHORTCUT_ICON_TYPE_SCRIPT can be used
  * @param[in] part Target part to be affect by this data
  * @param[in] data type == IMAGE ? Image file path : type == TEXT ? text string : type == SCRIPT ? script file path : N/A
  * @param[in] option Image load option or group name of script file to be loaded
  * @param[in] subid ID for script. this ID will be used as "id"
  * @return int value
  * @retval index Index of data set
- * @retval SHORTCUT_ERROR_INVALID Invalid handle
- * @retval SHORTCUT_ERROR_MEMORY Out of memory
- * @see shortcut_icon_request_create
+ * @retval #SHORTCUT_ERROR_INVALID Invalid handle
+ * @retval #SHORTCUT_ERROR_MEMORY Out of memory
+ * @see shortcut_icon_request_create()
  */
 extern int shortcut_icon_request_set_info(struct shortcut_icon *handle, const char *id, const char *type, const char *part, const char *data, const char *option, const char *subid);
 
@@ -173,11 +173,11 @@ extern int shortcut_icon_request_set_info(struct shortcut_icon *handle, const ch
  * @param[in] result_cb Result callback
  * @param[in] data Callback data
  * @return int value
- * @retval SHORTCUT_ERROR_INVALID Invalid parameters
- * @retval SHORTCUT_ERROR_MEMORY Out of memory
- * @retval SHORTCUT_ERROR_FAULT Failed to send a request
- * @retval SHORTCUT_SUCCESS Successfully sent
- * @see shortcut_icon_service_fini
+ * @retval #SHORTCUT_ERROR_INVALID Invalid parameters
+ * @retval #SHORTCUT_ERROR_MEMORY Out of memory
+ * @retval #SHORTCUT_ERROR_FAULT Failed to send a request
+ * @retval #SHORTCUT_SUCCESS Successfully sent
+ * @see shortcut_icon_service_fini()
  */
 extern int shortcut_icon_request_send(struct shortcut_icon *handle, int size_type, const char *layout, const char *group, const char *outfile, icon_request_cb_t result_cb, void *data);
 
@@ -185,9 +185,9 @@ extern int shortcut_icon_request_send(struct shortcut_icon *handle, int size_typ
  * @brief Destroys handle of creating shortcut icon request.
  * @param[in] handle Shortcut request handle
  * @return int value
- * @retval SHORTCUT_ERROR_INVALID Invalid handle
- * @retval SHORTCUT_SUCCESS Successfully destroyed
- * @see shortcut_icon_service_fini
+ * @retval #SHORTCUT_ERROR_INVALID Invalid handle
+ * @retval #SHORTCUT_SUCCESS Successfully destroyed
+ * @see shortcut_icon_service_fini()
  */
 extern int shortcut_icon_request_destroy(struct shortcut_icon *handle);
 
@@ -197,9 +197,9 @@ extern int shortcut_icon_request_destroy(struct shortcut_icon *handle);
  * @param[in] handle Handle to be used for carrying a data
  * @param[in] data Private data
  * @return int value
- * @retval SHORTCUT_ERROR_INVALID Invalid handle
- * @retval SHORTCUT_SUCCESS Successfully done
- * @see shortcut_icon_service_fini
+ * @retval #SHORTCUT_ERROR_INVALID Invalid handle
+ * @retval #SHORTCUT_SUCCESS Successfully done
+ * @see shortcut_icon_service_fini()
  */
 extern int shortcut_icon_request_set_data(struct shortcut_icon *handle, void *data);
 
@@ -207,9 +207,9 @@ extern int shortcut_icon_request_set_data(struct shortcut_icon *handle, void *da
  * @brief Gets the private data from handle.
  * @param[in] handle
  * @return int value
- * @retval NULL If there is no data
+ * @retval @c NULL If there is no data
  * @retval pointer data pointer
- * @see shortcut_icon_request_set_data
+ * @see shortcut_icon_request_set_data()
  */
 extern void *shortcut_icon_request_data(struct shortcut_icon *handle);
 
diff --git a/lib/src/icon.c b/lib/src/icon.c
index f2b6e15..ef2c498 100644
--- a/lib/src/icon.c
+++ b/lib/src/icon.c
@@ -36,7 +36,7 @@
 #include <com-core.h>
 #include <com-core_packet.h>
 
-#include "shortcut_internal.h"
+#include "shortcut_product.h"
 #include "shortcut.h"
 #include "dlist.h"
 #include "shortcut_private.h"
diff --git a/lib/src/main.c b/lib/src/main.c
index 90bb301..890124c 100644
--- a/lib/src/main.c
+++ b/lib/src/main.c
@@ -35,7 +35,7 @@
 #include <com-core_packet.h>
 
 #include "shortcut.h"
-#include "shortcut_internal.h"
+#include "shortcut_product.h"
 #include "shortcut_private.h"
 
 int errno;
diff --git a/packaging/libshortcut.spec b/packaging/libshortcut.spec
index 3f52f55..47f0386 100644
--- a/packaging/libshortcut.spec
+++ b/packaging/libshortcut.spec
@@ -73,7 +73,7 @@ touch %{buildroot}/opt/dbspace/.shortcut_service.db-journal
 %manifest %{name}.manifest
 %defattr(-,root,root,-)
 %{_includedir}/shortcut/shortcut.h
-%{_includedir}/shortcut/shortcut_internal.h
+%{_includedir}/shortcut/shortcut_product.h
 %{_libdir}/pkgconfig/shortcut.pc
 
 # End of a file