Revise the API (just applying the doxygen)

diff --git a/include/livebox.h b/include/livebox.h
index 2c072e8..8304a72 100644 (file)
--- a/include/livebox.h
+++ b/include/livebox.h
@@ -5,39 +5,89 @@
 extern "C" {
 #endif
 
-extern const int DONE;
-extern const int NEED_TO_SCHEDULE;
-extern const int OUTPUT_UPDATED;
-extern const int NEED_TO_CREATE;
-extern const int NEED_TO_DESTROY;
+/*!
+ * \brief
+ * Return values of livebox programming interfaces.
+ */
+extern const int DONE; /*!< Operation is successfully done */
+extern const int NEED_TO_SCHEDULE; /*!< Need to call the livebox_need_to_update and livebox_update_content */
+extern const int OUTPUT_UPDATED; /*!< Contents is updated */
+extern const int NEED_TO_CREATE; /*!< Need to create a new instance */
+extern const int NEED_TO_DESTROY; /*!< Need to destroy this instance */
 
+/*!
+ * \brief
+ * Extra event informatino for livebox_content_event interface function
+ */
 struct event_info {
        struct {
                double x;
                double y;
                int down;
-       } pointer;
+       } pointer; /*!< Down/Up state and mouse position */
 
        struct {
                double sx;
                double sy;
                double ex;
                double ey;
-       } part;
+       } part; /*!< Geometry of event received part */
 };
 
 struct livebox_desc;
 
+/*!
+ * \brief Update a description file.
+ * \param[in] filename
+ * \param[in] for_pd
+ * \return handle
+ */
 extern struct livebox_desc *livebox_desc_open(const char *filename, int for_pd);
+
+/*!
+ * \brief Complete the description file updating
+ * \param[in] handle
+ * \return int
+ */
 extern int livebox_desc_close(struct livebox_desc *handle);
 
+/*!
+ * \brief Set the category information of current description data
+ * \param[in] handle
+ * \param[in] id
+ * \param[in] category
+ * \return int
+ */
 extern int livebox_desc_set_category(struct livebox_desc *handle, const char *id, const char *category);
+
+/*!
+ * \brief Set the content size
+ * \param[in] handle
+ * \param[in] id
+ * \param[in] w
+ * \param[in] h
+ * \return int
+ */
 extern int livebox_desc_set_size(struct livebox_desc *handle, const char *id, int w, int h);
 
 /*!
- * \return idx
+ * \brief Add a new block
+ * \param[in] handle
+ * \param[in] id
+ * \param[in] type image|text|script|signal|...
+ * \param[in] part target part to update with given content(data)
+ * \param[in] data content for specified part
+ * \param[in] group script group name
+ * \return idx Index of current description block
  */
 extern int livebox_desc_add_block(struct livebox_desc *handle, const char *id, const char *type, const char *part, const char *data, const char *group);
+
+/*!
+ * \brief Delete a added block
+ * \param[in] handle
+ * \param[in] idx Index of added block
+ * \return int
+ */
 extern int livebox_desc_del_block(struct livebox_desc *handle, int idx);
 
 #ifdef __cplusplus