Update doxygen

Change-Id: I9519069c834bd459b79d29fe75bddf7313736d90

diff --git a/include/livebox.h b/include/livebox.h
index b57e5c6..76386f2 100644 (file)
--- a/include/livebox.h
+++ b/include/livebox.h
@@ -23,37 +23,160 @@ extern "C" {
 
 #include <Evas.h>
 
-struct livebox_buffer; /* Defined by provider */
+/*!
+ * \ingroup CAPI_LIVEBOX_FRAMEWORK Tizen livebox framework
+ * \{
+ * \defgroup LIVEBOX Inhouse(EF) Livebox helper library
+ * \{
+ * \section Intro Introduction
+ * This helper library only can be used for Inhouse(EFL) liveboxes.
+ * data-provider-slave only can be linked with the livebox which is built with this library
+ */
+
+/*!
+ * \brief Defined by provider
+ */
+struct livebox_buffer;
 
 /*!
  * \brief
  * Return values of livebox programming interfaces.
+ * \{
  */
-extern const int DONE; /*!< Operation is successfully done */
-extern const int OUTPUT_UPDATED; /*!< Contents is updated */
+/*!
+ * \brief
+ * Operation is successfully done
+ */
+extern const int DONE;
+
+/*!
+ * \brief
+ * Contents is updated
+ */
+extern const int OUTPUT_UPDATED;
 
-extern const int NEED_TO_SCHEDULE; /*!< Need to call the livebox_need_to_update and livebox_update_content */
-extern const int NEED_TO_CREATE; /*!< Need to create a new instance */
-extern const int NEED_TO_DESTROY; /*!< Need to destroy this instance */
+/*!
+ * \brief
+ * Need to call the livebox_need_to_update and livebox_update_content
+ */
+extern const int NEED_TO_SCHEDULE;
+
+/*!
+ * \brief
+ * Need to create a new instance
+ */
+extern const int NEED_TO_CREATE;
+
+/*!
+ * \brief
+ * Need to destroy this instance
+ */
+extern const int NEED_TO_DESTROY;
+
+/*!
+ * \brief
+ * Need to update
+ */
 extern const int NEED_TO_UPDATE;
 
-extern const int USE_NET; /*!< Using network */
+/*!
+ * \brief
+ * Using network
+ */
+extern const int USE_NET;
+
+/*!
+ * \brief
+ * System font is changed
+ */
+extern const int LB_SYS_EVENT_FONT_CHANGED;
+
+/*!
+ * \brief
+ * System language is changed
+ */
+extern const int LB_SYS_EVENT_LANG_CHANGED;
+
+/*!
+ * \brief
+ * System time is changed
+ */
+extern const int LB_SYS_EVENT_TIME_CHANGED;
+
+/*!
+ * \brief
+ * Region changed
+ */
+extern const int LB_SYS_EVENT_REGION_CHANGED;
 
-extern const int LB_SYS_EVENT_FONT_CHANGED; /*!< System font is changed */
-extern const int LB_SYS_EVENT_LANG_CHANGED; /*!< System language is changed */
-extern const int LB_SYS_EVENT_TIME_CHANGED; /*!< System time is changed */
-extern const int LB_SYS_EVENT_REGION_CHANGED; /*!< Region changed */
+/*!
+ * \brief
+ * Livebox is paused
+ */
 extern const int LB_SYS_EVENT_PAUSED;
+
+/*!
+ * \brief
+ * Livebox is resumed
+ */
 extern const int LB_SYS_EVENT_RESUMED;
-extern const int LB_SYS_EVENT_MMC_STATUS_CHANGED; /*!< MMC Status change event */
 
+/*!
+ * \brief
+ * MMC Status change event
+ */
+extern const int LB_SYS_EVENT_MMC_STATUS_CHANGED;
+
+/*!
+ * \}
+ */
+
+/*!
+ * \brief
+ * COLOR BLOCK
+ */
 #define LB_DESC_TYPE_COLOR "color"
+
+/*!
+ * \brief
+ * TEXT BLOCK
+ */
 #define LB_DESC_TYPE_TEXT "text"
+
+/*!
+ * \brief
+ * IMAGE BLOCK
+ */
 #define LB_DESC_TYPE_IMAGE "image"
+
+/*!
+ * \brief
+ * SIGNAL BLOCK
+ */
 #define LB_DESC_TYPE_SIGNAL "signal"
+
+/*!
+ * \brief
+ * INFO BLOCK
+ */
 #define LB_DESC_TYPE_INFO "info"
+
+/*!
+ * \brief
+ * DRAG BLOCK
+ */
 #define LB_DESC_TYPE_DRAG "drag"
+
+/*!
+ * \brief
+ * SCRIPT SCRIPT
+ */
 #define LB_DESC_TYPE_SCRIPT "script"
+
+/*!
+ * \brief
+ * ACCESSIBILITY INFORMATION BLOCK
+ */
 #define LB_DESC_TYPE_ACCESS "access"
 
 /*!
@@ -77,6 +200,9 @@ struct event_info {
 };
 #endif
 
+/*!
+ * Livebox description data handle structure.
+ */
 struct livebox_desc;
 
 /*!
@@ -84,6 +210,7 @@ struct livebox_desc;
  * \param[in] filename
  * \param[in] for_pd
  * \return handle
+ * \sa livebox_desc_close
  */
 extern struct livebox_desc *livebox_desc_open(const char *filename, int for_pd);
 
@@ -91,6 +218,7 @@ extern struct livebox_desc *livebox_desc_open(const char *filename, int for_pd);
  * \brief Complete the description file updating
  * \param[in] handle
  * \return int
+ * \sa livebox_desc_open
  */
 extern int livebox_desc_close(struct livebox_desc *handle);
 
@@ -114,7 +242,7 @@ extern int livebox_desc_set_category(struct livebox_desc *handle, const char *id
 extern int livebox_desc_set_size(struct livebox_desc *handle, const char *id, int w, int h);
 
 /*!
- * \breif Set the target id of given block
+ * \brief Set the target id of given block
  *        Only available for the script block
  * \param[in] handle
  * \param[in] idx
@@ -132,6 +260,7 @@ extern int livebox_desc_set_id(struct livebox_desc *handle, int idx, const char
  * \param[in] data content for specified part
  * \param[in] option option for the block. (script: group, image: option, ...)
  * \return idx Index of current description block
+ * \sa livebox_desc_set_id
  */
 extern int livebox_desc_add_block(struct livebox_desc *handle, const char *id, const char *type, const char *part, const char *data, const char *option);
 
@@ -166,7 +295,7 @@ extern char *livebox_util_nl2br(const char *str);
 
 #ifndef __PROVIDER_BUFFER_H
 /*!
- * \NOTE
+ * \note
  * This enumeration value should be sync'd with provider
  */
 enum buffer_event {
@@ -201,6 +330,7 @@ enum buffer_event {
  * \param[in] handler Event handling callback
  * \param[in] data user data for event handling callback
  * \return handler Buffer handle
+ * \sa livebox_release_buffer
  */
 extern struct livebox_buffer *livebox_acquire_buffer(const char *id, int is_pd, int width, int height, int (*handler)(struct livebox_buffer *, enum buffer_event, double, double, double, void *), void *data);
 
@@ -209,7 +339,7 @@ extern struct livebox_buffer *livebox_acquire_buffer(const char *id, int is_pd,
  *        Only if the provider uses pixmap for providing render buffer.
  * \param[in] handle Buffer handle
  * \return pixmap ID if succeed or 0lu
- * \see livebox_acquire_buffer
+ * \sa livebox_acquire_buffer
  */
 extern unsigned long livebox_pixmap_id(struct livebox_buffer *handle);
 
@@ -217,7 +347,7 @@ extern unsigned long livebox_pixmap_id(struct livebox_buffer *handle);
  * \brief
  * \param[in] handle Buffer handle
  * \return int
- * \see livebox_acquire_buffer
+ * \sa livebox_acquire_buffer
  */
 extern int livebox_release_buffer(struct livebox_buffer *handle);
 
@@ -226,24 +356,24 @@ extern int livebox_release_buffer(struct livebox_buffer *handle);
  *        If you try to use this, after create_hw_buffer, you will get NULL
  * \param[in] handle Buffer handle
  * \return void* address of the render buffer
- * \see livebox_unref_buffer
+ * \sa livebox_unref_buffer
  */
 extern void *livebox_ref_buffer(struct livebox_buffer *handle);
 
 /*!
  * \brief Release the S/W render buffer.
- * \param[in] void* Address of render buffer
+ * \param[in] buffer Address of render buffer
  * \return int 0 if succeed or errno < 0
- * \see livebox_ref_buffer
+ * \sa livebox_ref_buffer
  */
 extern int livebox_unref_buffer(void *buffer);
 
 /*!
  * \brief Sync the updated buffer
  *        This is only needed for non-H/W accelerated buffer
- * \param[in] handler Buffer handle
+ * \param[in] handle Buffer handle
  * \return int 0 if succeed or errno < 0
- * \see livebox_acquire_buffer
+ * \sa livebox_acquire_buffer
  */
 extern int livebox_sync_buffer(struct livebox_buffer *handle);
 
@@ -258,7 +388,7 @@ extern int livebox_request_update(const char *id);
  * \brief Checking wether the livebox support H/W acceleration or not.
  * \param[in] handle Buffer handle.
  * \return 1 if support or 0
- * \see livebox_acquire_buffer
+ * \sa livebox_acquire_buffer
  */
 extern int livebox_support_hw_buffer(struct livebox_buffer *handle);
 
@@ -266,7 +396,7 @@ extern int livebox_support_hw_buffer(struct livebox_buffer *handle);
  * \brief Create the H/W accelerated buffer.
  * \param[in] handle Buffer handle
  * \return 0 if succeed to create it or errno < 0
- * \see livebox_support_hw_buffer
+ * \sa livebox_support_hw_buffer
  */
 extern int livebox_create_hw_buffer(struct livebox_buffer *handle);
 
@@ -274,7 +404,7 @@ extern int livebox_create_hw_buffer(struct livebox_buffer *handle);
  * \brief Destroy the H/W accelerated buffer.
  * \param[in] handle Buffer handle
  * \return 0 if succeed to destroy it or errno < 0
- * \see livebox_create_hw_buffer
+ * \sa livebox_create_hw_buffer
  */
 extern int livebox_destroy_hw_buffer(struct livebox_buffer *handle);
 
@@ -282,7 +412,7 @@ extern int livebox_destroy_hw_buffer(struct livebox_buffer *handle);
  * \brief Get the address of accelerated H/W buffer
  * \param[in] handle Buffer handle
  * \return void
- * \see livebox_create_hw_buffer
+ * \sa livebox_create_hw_buffer
  */
 extern void *livebox_buffer_hw_buffer(struct livebox_buffer *handle);
 
@@ -291,7 +421,8 @@ extern void *livebox_buffer_hw_buffer(struct livebox_buffer *handle);
  *        This is only needed for accessing H/W accelerated buffer.
  * \param[in] handle Buffer handle
  * \return 0 if succeed or errno < 0
- * \see livebox_support_hw_buffer
+ * \sa livebox_support_hw_buffer
+ * \sa livebox_buffer_post_render
  */
 extern int livebox_buffer_pre_render(struct livebox_buffer *handle);
 
@@ -299,7 +430,8 @@ extern int livebox_buffer_pre_render(struct livebox_buffer *handle);
  * \brief Post-processing for rendering content.
  * \param[in] handle Buffer handle
  * \return 0 if succeed or errno < 0
- * \see livebox_support_hw_buffer
+ * \sa livebox_support_hw_buffer
+ * \sa livebox_buffer_pre_render
  */
 extern int livebox_buffer_post_render(struct livebox_buffer *handle);
 
@@ -311,7 +443,10 @@ extern Evas_Object *livebox_virtual_window_add(const char *id, int width, int he
 extern int livebox_virtual_window_del(Evas_Object *virtual_win);
 */
 
-// End of a file
+/*!
+ * \}
+ */
+
 #ifdef __cplusplus
 }
 #endif