summaryrefslogtreecommitdiff
path: root/lib
diff options
context:
space:
mode:
authormk5004.lee <mk5004.lee@samsung.com>2019-09-26 14:26:12 +0900
committermk5004.lee <mk5004.lee@samsung.com>2019-09-27 09:05:46 +0900
commit991a1a18afd904d9d4184c6b262e576ff3d0f204 (patch)
treed7b86ee93da46444af86c13cb3ba2a3cc0d8eb43 /lib
parentb12262f36e145e3730050a114fa84be5e0c0da4c (diff)
downloadshortcut-991a1a18afd904d9d4184c6b262e576ff3d0f204.tar.gz
shortcut-991a1a18afd904d9d4184c6b262e576ff3d0f204.tar.bz2
shortcut-991a1a18afd904d9d4184c6b262e576ff3d0f204.zip
Update doxygen
- change file mode 664 Change-Id: I8942d5bd021218a7d91fa8a8fb8cf37e66b7c69b Signed-off-by: mk5004.lee <mk5004.lee@samsung.com>
Diffstat (limited to 'lib')
-rw-r--r--[-rwxr-xr-x]lib/CMakeLists.txt0
-rw-r--r--[-rwxr-xr-x]lib/LICENSE0
-rw-r--r--[-rwxr-xr-x]lib/include/shortcut.h2
-rw-r--r--[-rwxr-xr-x]lib/include/shortcut_error.h0
-rw-r--r--[-rwxr-xr-x]lib/include/shortcut_internal.h0
-rw-r--r--[-rwxr-xr-x]lib/include/shortcut_manager.h38
-rw-r--r--[-rwxr-xr-x]lib/include/shortcut_private.h0
-rw-r--r--[-rwxr-xr-x]lib/shortcut.pc.in0
-rw-r--r--[-rwxr-xr-x]lib/src/shortcut_db.c0
-rw-r--r--[-rwxr-xr-x]lib/src/shortcut_error.c0
-rw-r--r--[-rwxr-xr-x]lib/src/shortcut_internal.c0
-rw-r--r--[-rwxr-xr-x]lib/src/shortcut_manager.c0
12 files changed, 20 insertions, 20 deletions
diff --git a/lib/CMakeLists.txt b/lib/CMakeLists.txt
index a61b117..a61b117 100755..100644
--- a/lib/CMakeLists.txt
+++ b/lib/CMakeLists.txt
diff --git a/lib/LICENSE b/lib/LICENSE
index b7ea6db..b7ea6db 100755..100644
--- a/lib/LICENSE
+++ b/lib/LICENSE
diff --git a/lib/include/shortcut.h b/lib/include/shortcut.h
index b598224..78d77d4 100755..100644
--- a/lib/include/shortcut.h
+++ b/lib/include/shortcut.h
@@ -43,7 +43,7 @@ extern "C" {
* @param[in] ret The result value, it could be @c 0 if it succeeds to add a shortcut,
* otherwise it returns an errno
* @param[in] pid The process ID of who handle this add_to_home request
- * @param[in] data The callback data
+ * @param[in] user_data The user data passed from the registration function
* @return int @c 0 if there is no error, otherwise errno
* @see add_to_home_shortcut()
*/
diff --git a/lib/include/shortcut_error.h b/lib/include/shortcut_error.h
index bb91924..bb91924 100755..100644
--- a/lib/include/shortcut_error.h
+++ b/lib/include/shortcut_error.h
diff --git a/lib/include/shortcut_internal.h b/lib/include/shortcut_internal.h
index 369296a..369296a 100755..100644
--- a/lib/include/shortcut_internal.h
+++ b/lib/include/shortcut_internal.h
diff --git a/lib/include/shortcut_manager.h b/lib/include/shortcut_manager.h
index 7feb6ec..2318b6f 100755..100644
--- a/lib/include/shortcut_manager.h
+++ b/lib/include/shortcut_manager.h
@@ -105,11 +105,11 @@ typedef int (*result_cb)(int ret, void *user_data);
* @return @c 0 on success,
* otherwise a negative error value
* @retval #SHORTCUT_ERROR_NONE Successful
+ * @retval #SHORTCUT_ERROR_NOT_SUPPORTED Not supported
+ * @retval #SHORTCUT_ERROR_PERMISSION_DENIED Permission denied
* @retval #SHORTCUT_ERROR_INVALID_PARAMETER Invalid function parameter
* @retval #SHORTCUT_ERROR_OUT_OF_MEMORY Out of memory
* @retval #SHORTCUT_ERROR_IO_ERROR I/O Error
- * @retval #SHORTCUT_ERROR_PERMISSION_DENIED Permission denied
- * @retval #SHORTCUT_ERROR_NOT_SUPPORTED Not supported
* @retval #SHORTCUT_ERROR_RESOURCE_BUSY Device or resource busy
* @retval #SHORTCUT_ERROR_NO_SPACE There is no space to add a new shortcut
* @retval #SHORTCUT_ERROR_EXIST Shortcut is already exist
@@ -117,7 +117,7 @@ typedef int (*result_cb)(int ret, void *user_data);
* @retval #SHORTCUT_ERROR_COMM Connection not established or communication problem
* @pre You have to prepare the callback function.
* @post You have to check the return status from the callback function which is passed by the argument.
- * @see result_cb
+ * @see result_cb()
* @par Example
* @code
#include <stdio.h>
@@ -171,16 +171,16 @@ int shortcut_add_to_home(const char *name, shortcut_type type, const char *uri,
* @return @c 0 on success,
* otherwise a negative error value
* @retval #SHORTCUT_ERROR_NONE Successful
+ * @retval #SHORTCUT_ERROR_NOT_SUPPORTED Not supported
+ * @retval #SHORTCUT_ERROR_PERMISSION_DENIED Permission denied
* @retval #SHORTCUT_ERROR_INVALID_PARAMETER Invalid function parameter
* @retval #SHORTCUT_ERROR_OUT_OF_MEMORY Out of memory
* @retval #SHORTCUT_ERROR_IO_ERROR I/O Error
- * @retval #SHORTCUT_ERROR_PERMISSION_DENIED Permission denied
- * @retval #SHORTCUT_ERROR_NOT_SUPPORTED Not supported
* @retval #SHORTCUT_ERROR_FAULT Unrecoverable error
* @retval #SHORTCUT_ERROR_COMM Connection not established or communication problem
* @pre You have to prepare the callback function.
* @post You have to check the return status from the callback function which is passed by the argument.
- * @see result_cb
+ * @see result_cb()
* @see shortcut_widget_size_e
* @par Example
* @code
@@ -228,15 +228,15 @@ int shortcut_add_to_home_widget(const char *name, shortcut_widget_size_e size, c
* @param[in] user_data The callback data that is used in the callback function
* @return 0 on success, otherwise a negative error value
* @retval #SHORTCUT_ERROR_NONE Successful
+ * @retval #SHORTCUT_ERROR_NOT_SUPPORTED Not supported
+ * @retval #SHORTCUT_ERROR_PERMISSION_DENIED Permission denied
* @retval #SHORTCUT_ERROR_INVALID_PARAMETER Invalid function parameter
* @retval #SHORTCUT_ERROR_OUT_OF_MEMORY Out of memory
* @retval #SHORTCUT_ERROR_IO_ERROR I/O Error
- * @retval #SHORTCUT_ERROR_PERMISSION_DENIED Permission denied
* @retval #SHORTCUT_ERROR_COMM Connection not established or communication problem
- * @retval #SHORTCUT_ERROR_NOT_SUPPORTED Not supported
* @pre You have to prepare the callback function.
* @post You have to check the return status from the callback function which is passed by the argument.
- * @see result_cb
+ * @see result_cb()
* @par Example
* @code
#include <shortcut_manager.h>
@@ -293,13 +293,13 @@ typedef int (*shortcut_list_cb)(const char *package_name, const char *icon, cons
* @param[in] data The callback data that is used in the callback function
* @return The return type (int)
* @retval @c N Number of items (call count of the callback function)
+ * @retval #SHORTCUT_ERROR_NOT_SUPPORTED Not supported
+ * @retval #SHORTCUT_ERROR_PERMISSION_DENIED Permission denied
* @retval #SHORTCUT_ERROR_INVALID_PARAMETER Invalid function parameter
* @retval #SHORTCUT_ERROR_OUT_OF_MEMORY Out of memory
* @retval #SHORTCUT_ERROR_IO_ERROR I/O Error
- * @retval #SHORTCUT_ERROR_PERMISSION_DENIED Permission denied
* @retval #SHORTCUT_ERROR_FAULT Unrecoverable error
* @retval #SHORTCUT_ERROR_COMM Connection not established or communication problem
- * @retval #SHORTCUT_ERROR_NOT_SUPPORTED Not supported
* @pre You have to prepare the callback function.
* @post You have to check the return status from the callback function which is passed by the argument.
*
@@ -331,11 +331,11 @@ typedef int (*shortcut_request_cb)(const char *package_name, const char *name, i
/**
- * @brief Called to the shortcut_remove_from_home request.
+ * @brief Called to the shortcut_remove_from_home() request.
* @since_tizen 3.0
* @param[in] package_name The name of package
* @param[in] name The name of the created shortcut icon
- * @param[in] sender_pid The process ID of who request shortcut_remove_from_home
+ * @param[in] sender_pid The process ID of who request shortcut_remove_from_home()
* @param[in] user_data The user data passed from the callback register function
* @return The result of handling a shortcut remove request\n
* This returns @c 0 if the remove_from_home request is handled successfully,
@@ -357,12 +357,12 @@ typedef int (*shortcut_remove_cb)(const char *package_name, const char *name, in
* @param[in] data The callback data to deliver to the callback function
* @return @c 0 on success, otherwise a negative error value
* @retval #SHORTCUT_ERROR_NONE Successful
+ * @retval #SHORTCUT_ERROR_NOT_SUPPORTED Not supported
+ * @retval #SHORTCUT_ERROR_PERMISSION_DENIED Permission denied
* @retval #SHORTCUT_ERROR_INVALID_PARAMETER Invalid function parameter
* @retval #SHORTCUT_ERROR_OUT_OF_MEMORY Out of memory
* @retval #SHORTCUT_ERROR_IO_ERROR I/O Error
- * @retval #SHORTCUT_ERROR_PERMISSION_DENIED Permission denied
* @retval #SHORTCUT_ERROR_COMM Connection not established or communication problem
- * @retval #SHORTCUT_ERROR_NOT_SUPPORTED Not supported
* @pre You have to prepare a callback function.
* @post If a request is sent from the application, the registered callback will be invoked.
* @see request_cb_t
@@ -381,7 +381,7 @@ int shortcut_set_request_cb(shortcut_request_cb request_cb, void *data);
* @exception #SHORTCUT_ERROR_NONE Successful
* @exception #SHORTCUT_ERROR_NOT_SUPPORTED Not supported
* @exception #SHORTCUT_ERROR_PERMISSION_DENIED Permission denied
- * @see shortcut_set_request_cb
+ * @see shortcut_set_request_cb()
* @see get_last_result()
*/
void shortcut_unset_request_cb(void);
@@ -399,12 +399,12 @@ void shortcut_unset_request_cb(void);
* @param[in] data The callback data to deliver to the callback function
* @return 0 on success, otherwise a negative error value
* @retval #SHORTCUT_ERROR_NONE Successful
+ * @retval #SHORTCUT_ERROR_NOT_SUPPORTED Not supported
+ * @retval #SHORTCUT_ERROR_PERMISSION_DENIED Permission denied
* @retval #SHORTCUT_ERROR_INVALID_PARAMETER Invalid function parameter
* @retval #SHORTCUT_ERROR_OUT_OF_MEMORY Out of memory
* @retval #SHORTCUT_ERROR_IO_ERROR I/O Error
- * @retval #SHORTCUT_ERROR_PERMISSION_DENIED Permission denied
* @retval #SHORTCUT_ERROR_COMM Connection not established or communication problem
- * @retval #SHORTCUT_ERROR_NOT_SUPPORTED Not supported
* @pre You have to prepare a callback function.
* @post If a request is sent from the application, the registered callback will be invoked.
* @see remove_cb_t
@@ -423,7 +423,7 @@ int shortcut_set_remove_cb(shortcut_remove_cb remove_cb, void *data);
* @exception #SHORTCUT_ERROR_NONE Successful
* @exception #SHORTCUT_ERROR_NOT_SUPPORTED Not supported
* @exception #SHORTCUT_ERROR_PERMISSION_DENIED Permission denied
- * @see shortcut_set_remove_cb
+ * @see shortcut_set_remove_cb()
* @see get_last_result()
*/
void shortcut_unset_remove_cb(void);
diff --git a/lib/include/shortcut_private.h b/lib/include/shortcut_private.h
index 3a62cff..3a62cff 100755..100644
--- a/lib/include/shortcut_private.h
+++ b/lib/include/shortcut_private.h
diff --git a/lib/shortcut.pc.in b/lib/shortcut.pc.in
index 060e119..060e119 100755..100644
--- a/lib/shortcut.pc.in
+++ b/lib/shortcut.pc.in
diff --git a/lib/src/shortcut_db.c b/lib/src/shortcut_db.c
index 65cd203..65cd203 100755..100644
--- a/lib/src/shortcut_db.c
+++ b/lib/src/shortcut_db.c
diff --git a/lib/src/shortcut_error.c b/lib/src/shortcut_error.c
index c590e25..c590e25 100755..100644
--- a/lib/src/shortcut_error.c
+++ b/lib/src/shortcut_error.c
diff --git a/lib/src/shortcut_internal.c b/lib/src/shortcut_internal.c
index 5782a09..5782a09 100755..100644
--- a/lib/src/shortcut_internal.c
+++ b/lib/src/shortcut_internal.c
diff --git a/lib/src/shortcut_manager.c b/lib/src/shortcut_manager.c
index dae74af..dae74af 100755..100644
--- a/lib/src/shortcut_manager.c
+++ b/lib/src/shortcut_manager.c