Update Doxygen

Change-Id: I280f372008cfedbc0d3bd08059581554b667c35d

diff --git a/include/livebox.h b/include/livebox.h
index b8e074a..0e556fc 100644 (file)
--- a/include/livebox.h
+++ b/include/livebox.h
@@ -446,9 +446,9 @@ enum buffer_event {
        BUFFER_EVENT_UNHIGHLIGHT, /*!< Accessibility - Remove highlight */
 
        BUFFER_EVENT_ON_HOLD,   /*!< To prevent from generating mouse clicked event */
-       BUFFER_EVENT_OFF_HOLD,
-       BUFFER_EVENT_ON_SCROLL,
-       BUFFER_EVENT_OFF_SCROLL
+       BUFFER_EVENT_OFF_HOLD,  /*!< Stopped holding. */
+       BUFFER_EVENT_ON_SCROLL, /*!< On scrolling */
+       BUFFER_EVENT_OFF_SCROLL /*!< Scrolling stopped */
 };
 
 struct buffer_event_data {
@@ -485,6 +485,7 @@ struct buffer_event_data {
  * \post
  *    Allocated buffer object must be released via livebox_release_Buffer
  * \see livebox_release_buffer
+ * \sa livebox_acquire_buffer_NEW
  */
 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);
 extern struct livebox_buffer *livebox_acquire_buffer_NEW(const char *id, int is_pd, int width, int height, int pixels, int (*handler)(struct livebox_buffer *, struct buffer_event_data *, void *), void *data);
@@ -515,6 +516,7 @@ extern unsigned long livebox_pixmap_id(struct livebox_buffer *handle);
  * \pre handle must be created using livebox_acquire_buffer.
  * \post N/A
  * \see livebox_acquire_buffer
+ * \sa livebox_release_buffer_NEW
  */
 extern int livebox_release_buffer(struct livebox_buffer *handle);
 extern int livebox_release_buffer_NEW(struct livebox_buffer *handle);
@@ -708,7 +710,41 @@ extern Evas_Object *livebox_get_evas_object(const char *id, int is_pd);
  */
 extern int livebox_request_close_pd(const char *pkgname, const char *id, int reason);
 
+/*!
+ * \brief Send a freeze request to the viewer (homescreen)
+ * \details
+ *        The viewer will get this request via event callback.
+ *        Then it should freeze its scroller or stop moving the livebox.
+ * \remarks If the viewer doesn't care this request, this will has no effect.
+ * \param[in] pkgname Livebox Package Id
+ * \param[in] id Livebox Instance Id
+ * \return int
+ * \retval LB_STATUS_ERROR_INVALID Invalid parameters
+ * \retval LB_STATUS_ERROR_MEMORY Out of memory
+ * \retval LB_STATUS_ERROR_FAULT Failed to send requet
+ * \retval LB_STATUS_SUCCESS Successfully requested
+ * \pre N/A
+ * \post N/A
+ * \see livebox_release_scroller
+ */
 extern int livebox_freeze_scroller(const char *pkgname, const char *id);
+
+/*!
+ * \brief Send a release request to the viewer (homescreen)
+ * \details
+ *        The viewer will get this request via event callback.
+ *        Then it should release its scroller or continue moving the livebox.
+ * \remarks If the viewer doesn't care this request, this will has no effect.
+ * \param[in] pkgname Livebox Package Id
+ * \param[in] id Livebox Instance Id
+ * \retval LB_STATUS_ERROR_INVALID Invalid parameters
+ * \retval LB_STATUS_ERROR_MEMORY Out of memory
+ * \retval LB_STATUS_ERROR_FAULT Failed to send requet
+ * \retval LB_STATUS_SUCCESS Successfully requested
+ * \pre N/A
+ * \post N/A
+ * \see livebox_freeze_scroller
+ */
 extern int livebox_release_scroller(const char *pkgname, const char *id);
 
 /*!