summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorhyun lee <hyunn.lee@samsung.com>2014-09-05 14:04:54 +0900
committerhyun lee <hyunn.lee@samsung.com>2014-09-05 14:04:54 +0900
commitfdd6066898edb865978b83face8d82530270ce87 (patch)
tree1dac59309a2484be529f9c773ea911944df7c75b
parentc5370b37b1e84e2040e6a412aa0bee65646832bd (diff)
downloadshortcut-fdd6066898edb865978b83face8d82530270ce87.tar.gz
shortcut-fdd6066898edb865978b83face8d82530270ce87.tar.bz2
shortcut-fdd6066898edb865978b83face8d82530270ce87.zip
remove doxygen build warning
Change-Id: Id74a4c98e979bfd7c2c8e46ca35432bb59ac94be Signed-off-by: hyun lee <hyunn.lee@samsung.com>
-rwxr-xr-xdoc/shortcut_doc.h6
-rwxr-xr-xdoc_prod/shortcut_doc.h6
-rwxr-xr-xlib/include/shortcut.h9
-rwxr-xr-xlib/include/shortcut_product.h21
4 files changed, 19 insertions, 23 deletions
diff --git a/doc/shortcut_doc.h b/doc/shortcut_doc.h
index c6ed5f9..c413923 100755
--- a/doc/shortcut_doc.h
+++ b/doc/shortcut_doc.h
@@ -74,7 +74,7 @@ Application data used for creating a pure shortcut or creating a dynamicbox
</TABLE>
<H3>2.1.1 Supported types</H3>
-\snippet lib/include/shortcut.h Enumeration values for type of shortcuts
+shortcut.h Enumeration values for type of shortcuts
<H2>2.2 Add shortcut (Home screen retrieves shortcuts from app)</H2>
"Add shortcut " service enables home screen to retrieve all shortcuts that applications promised to support and request an app to send their shortcuts to home directly, as opposed to "add to home".
@@ -91,7 +91,7 @@ The following table describes the format and information necessary to define the
Then, the information will be shown and used in home screen when a user selects "add shortcut" service.
<TABLE>
-<TH><TD>Syntax of the shortcut manifest file</TD></TH>
+<caption>Syntax of the shortcut manifest file</caption>
<TR><TD>
\code
<manifest xmlns="http://tizen.org/ns/packages" package="com.samsung.APP_PKGNAME">
@@ -144,7 +144,7 @@ It will use the pkgname and param attrbute to launch your application.
Shortcut list view will launch your "[App] Shortcut list" using followed code.
<TABLE>
-<TH><TD>Launch your app from shortcut list viewer</TD></TH>
+<caption>Launch your app from shortcut list viewer</caption>
<TR><TD>
\code
service_h service;
diff --git a/doc_prod/shortcut_doc.h b/doc_prod/shortcut_doc.h
index b010ce7..b8e74fd 100755
--- a/doc_prod/shortcut_doc.h
+++ b/doc_prod/shortcut_doc.h
@@ -74,7 +74,7 @@ Application data used for creating a pure shortcut or creating a dynamicbox
</TABLE>
<H3>2.1.1 Supported types</H3>
-\snippet lib/include/shortcut.h Enumeration values for type of shortcuts
+shortcut.h Enumeration values for type of shortcuts
<H2>2.2 Add shortcut (Home screen retrieves shortcuts from app)</H2>
"Add shortcut " service enables home screen to retrieve all shortcuts that applications promised to support and request an app to send their shortcuts to home directly, as opposed to "add to home".
@@ -91,7 +91,7 @@ The following table describes the format and information necessary to define the
Then, the information will be shown and used in home screen when a user selects "add shortcut" service.
<TABLE>
-<TH><TD>Syntax of the shortcut manifest file</TD></TH>
+<caption>Syntax of the shortcut manifest file</caption>
<TR><TD>
\code
<manifest xmlns="http://tizen.org/ns/packages" package="com.samsung.APP_PKGNAME">
@@ -144,7 +144,7 @@ It will use the pkgname and param attrbute to launch your application.
Shortcut list view will launch your "[App] Shortcut list" using followed code.
<TABLE>
-<TH><TD>Launch your app from shortcut list viewer</TD></TH>
+<caption>Launch your app from shortcut list viewer</caption>
<TR><TD>
\code
service_h service;
diff --git a/lib/include/shortcut.h b/lib/include/shortcut.h
index 3036e36..f841134 100755
--- a/lib/include/shortcut.h
+++ b/lib/include/shortcut.h
@@ -394,7 +394,7 @@ extern int shortcut_get_list(const char *appid, int (*cb)(const char *appid, con
* @param[in] appid Package name of owner of this shortcut
* @param[in] name Name for created shortcut icon
* @param[in] type Type of shortcuts (dynamicbox or shortcut, and its size if it is for the dynamicbox)
- * @param[in] content_info Specific information for delivering to the viewer for creating a shortcut
+ * @param[in] content Specific information for delivering to the viewer for creating a shortcut
* @param[in] icon Absolute path of an icon file
* @param[in] period Update period
* @param[in] allow_duplicate Set 1 If accept the duplicated shortcut or 0
@@ -589,11 +589,12 @@ extern int add_to_home_remove_shortcut(const char *appid, const char *name, cons
*/
extern int add_to_home_remove_dynamicbox(const char *appid, const char *name, result_cb_t result_cb, void *data);
+/**
+ * @}
+ */
+
#ifdef __cplusplus
}
#endif
#endif
-/* @}
- * End of a file
- */
diff --git a/lib/include/shortcut_product.h b/lib/include/shortcut_product.h
index f45e061..4f4932b 100755
--- a/lib/include/shortcut_product.h
+++ b/lib/include/shortcut_product.h
@@ -23,17 +23,11 @@ extern "C" {
#endif
/**
- * @file shortcut_internal.h
+ * @file shortcut_product.h
* @brief This file declares API of libshortcut library (platform only)
*/
/**
-* @defgroup SHORTCUT_ICON_MODULE Shortcut Icon
-* @ingroup SHORTCUT_MODULE
-* @{
-*/
-
-/**
* @addtogroup SHORTCUT_ICON_MODULE
* @{
*/
@@ -129,7 +123,7 @@ typedef int (*icon_request_cb_t)(struct shortcut_icon *handle, int ret, void *da
* @param[in] data Callback data
* @return int value
* @retval #SHORTCUT_ERROR_INVALID_PARAMETER Already initialized
- * @retval #SHORTCUT_ERROR_SUCCESS Successfully initialized
+ * @retval #SHORTCUT_ERROR_NONE Successfully initialized
* @see shortcut_icon_service_fini()
*/
extern int shortcut_icon_service_init(int (*init_cb)(int status, void *data), void *data);
@@ -156,7 +150,7 @@ 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
@@ -219,11 +213,12 @@ extern int shortcut_icon_request_set_data(struct shortcut_icon *handle, void *da
*/
extern void *shortcut_icon_request_data(struct shortcut_icon *handle);
+/**
+ * @}
+ */
+
#ifdef __cplusplus
}
#endif
-#endif
-/* @}
- * End of a file
- */
+#endif \ No newline at end of file