Update doxygen and error code

Change-Id: I5dca67e72c2b48b22cd4928a1a2f0a1e938532f9

diff --git a/doc/provider_doc.h b/doc/provider_doc.h
new file mode 100644 (file)
index 0000000..7a21b54
--- /dev/null
+++ b/doc/provider_doc.h
@@ -0,0 +1,26 @@
+/*
+ * Copyright 2013  Samsung Electronics Co., Ltd
+ *
+ * Licensed under the Flora License, Version 1.1 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://floralicense.org/license/
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+
+/*!
+ * \ingroup CAPI_LIVEBOX_FRAMEWORK Tizen livebox framework
+ * \defgroup CAPI_PROVIDER_MODULE Provider Programming Interfaces for development of livebox service provider.
+ * \section CAPI_PROVIDER_MODULE_HEADER Required Header
+ * \#include <provider.h>
+ * \#include <provider_buffer.h>
+ * \section CAPI_PROVIDER_MODULE_OVERVIEW Overview
+ * Overview
+ */

diff --git a/include/provider.h b/include/provider.h
index a9edb45..5a52d1a 100644 (file)
--- a/include/provider.h
+++ b/include/provider.h
@@ -14,18 +14,6 @@
  * limitations under the License.
  */
 
-/*!
- * \mainpage Provider
- * \{
- * \section Intro Livebox Service Provider
- * \subsection IntroSub
- * \section WhatFor Hello
- * \subsection WaitForSub Hello Sub
- * \section WhatFor GoodBye
- * \subsection WhatForSub What for sub
- * \}
- */
-
 #ifndef __PROVIDER_H
 #define __PROVIDER_H
 
@@ -34,7 +22,7 @@ extern "C" {
 #endif
 
 /*!
- * \defgroup PROVIDER Provider Programming Interfaces for development of livebox service provider.
+ * \addtogroup CAPI_PROVIDER_MODULE
  * \{
  */
 
@@ -260,161 +248,279 @@ struct event_handler {
 
 /*!
  * \brief Initialize the provider service
+ * \details N/A
+ * \remarks N/A
  * \param[in] disp XDisplay object, if you don't know what this is, set NULL
  * \param[in] name Slave name which is given by the master provider.
  * \param[in] table Event handler table
- * \return int Success LB_STATUS_SUCCESS otherwise errno < 0
- * \sa provider_fini
+ * \param[in] data callback data
+ * \return int
+ * \retval LB_STATUS_SUCCESS
+ * \retval LB_STATUS_ERROR_INVALID
+ * \retval LB_STATUS_ERROR_MEMORY
+ * \retval LB_STATUS_ERROR_ALREADY
+ * \retval LB_STATUS_ERROR_FAULT
+ * \pre N/A
+ * \post N/A
+ * \see provider_fini
  */
 extern int provider_init(void *disp, const char *name, struct event_handler *table, void *data);
 
 /*!
  * \brief Finalize the provider service
- * \return void
- * \sa provider_init
+ * \details N/A
+ * \remarks N/A
+ * \return void *
+ * \retval callback data which is registered via provider_init
+ * \pre N/A
+ * \post N/A
+ * \see provider_init
  */
 extern void *provider_fini(void);
 
 /*!
  * \brief Send the hello signal to the master
+ * \details N/A
+ * \remarks N/A
  *        Master will activate connection of this only if you send this hello event.
  *        or the master will reject all requests from your provider.
- * \return int Success LB_STATUS_SUCCESS otherwise errno < 0
+ * \return int
+ * \retval LB_STATUS_SUCCESS
+ * \retval LB_STATUS_ERROR_INVALID
+ * \retval LB_STATUS_ERROR_FAULT
+ * \pre N/A
+ * \post N/A
+ * \see N/A
  */
 extern int provider_send_hello(void);
 
 /*!
  * \brief Send the ping message to the master to notify that your provider is working properly.
- * \return int Success LB_STATUS_SUCCESS otherwise errno < 0
+ * \details N/A
+ * \remarks N/A
+ * \return int
+ * \retval LB_STATUS_SUCCESS
+ * \retval LB_STATUS_ERROR_INVALID
+ * \retval LB_STATUS_ERROR_FAULT
+ * \pre N/A
+ * \post N/A
+ * \see N/A
  */
 extern int provider_send_ping(void);
 
 /*!
  * \brief Send the updated event to the master
+ * \details N/A
+ * \remarks N/A
  * \param[in] pkgname Package name which of an updated livebox.
  * \param[in] id Instance ID of an updated livebox.
  * \param[in] w Width of an updated content
  * \param[in] h Height of an updated content
  * \param[in] priority Priority of an updated content
- * \return int Success LB_STATUS_SUCCESS otherwise errno < 0
+ * \param[in] content Content string
+ * \param[in] title Title string that is summarizing the content to a short text
+ * \return int
+ * \retval LB_STATUS_SUCCESS
+ * \retval LB_STATUS_ERROR_INVALID
+ * \retval LB_STATUS_ERROR_FAULT
+ * \pre N/A
+ * \post N/A
+ * \see N/A
  */
 extern int provider_send_updated(const char *pkgname, const char *id, int w, int h, double priority, const char *content, const char *title);
 
 /*!
  * \brief Send the description data updated event to the master
+ * \details N/A
+ * \remarks N/A
  * \param[in] pkgname Package name of an updated livebox.
  * \param[in] id Instance ID of an updated livebox.
  * \param[in] descfile The filename of a description file.
- * \return int Success LB_STATUS_SUCCESS otherwise errno < 0
+ * \return int
+ * \retval LB_STATUS_SUCCESS
+ * \retval LB_STATUS_ERROR_INVALID
+ * \retval LB_STATUS_ERROR_MEMORY
+ * \retval LB_STATUS_ERROR_FAULT
+ * \pre N/A
+ * \post N/A
+ * \see N/A
  */
 extern int provider_send_desc_updated(const char *pkgname, const char *id, const char *descfile);
 
 /*!
  * \brief If the client requests async update mode, service provider must has to send update begin when it really start to update its contents
+ * \details N/A
+ * \remarks N/A
  * \param[in] pkgname Package name of livebox
  * \param[in] id Instance Id of livebox
  * \param[in] priority Priority of current content of livebox
  * \param[in] content_info Content info should be come back again via livebox_create event.
  * \param[in] title A sentence for describing content of livebox
  * \return int
- * \sa provider_send_lb_update_end
+ * \retval LB_STATUS_SUCCESS
+ * \retval LB_STATUS_ERROR_INVALID
+ * \retval LB_STATUS_ERROR_FAULT
+ * \pre N/A
+ * \post N/A
+ * \see provider_send_lb_update_end
  */
 extern int provider_send_lb_update_begin(const char *pkgname, const char *id, double priority, const char *content_info, const char *title);
 
 /*!
  * \brief If the client requests async update mode, service provider must has to send update end when the update is done
+ * \details N/A
+ * \remarks N/A
  * \param[in] pkgname Package name of livebox
  * \param[in] id Instance Id of livebox
  * \return int
- * \sa provider_send_lb_update_begin
+ * \retval LB_STATUS_SUCCESS
+ * \retval LB_STATUS_ERROR_INVALID
+ * \retval LB_STATUS_ERROR_FAULT
+ * \pre N/A
+ * \post N/A
+ * \see provider_send_lb_update_begin
  */
 extern int provider_send_lb_update_end(const char *pkgname, const char *id);
 
 /*!
  * \brief If the client requests async update mode, service provider must has to send update begin when it really start to update its contents
+ * \details N/A
+ * \remarks N/A
  * \param[in] pkgname Package name of livebox
  * \param[in] id Instance Id of livebox
  * \return int
- * \sa provider_send_pd_update_end
+ * \retval LB_STATUS_SUCCESS
+ * \retval LB_STATUS_ERROR_INVALID
+ * \retval LB_STATUS_ERROR_FAULT
+ * \pre N/A
+ * \post N/A
+ * \see provider_send_pd_update_end
  */
 extern int provider_send_pd_update_begin(const char *pkgname, const char *id);
 
 /*!
  * \brief If the client requests async update mode, service provider must has to send update end when it really finish the update its contents
+ * \details N/A
+ * \remarks N/A
  * \param[in] pkgname Package name of livebox
  * \param[in] id Instance Id of livebox
  * \return int
- * \sa provider_send_pd_update_begin
+ * \retval LB_STATUS_SUCCESS
+ * \retval LB_STATUS_ERROR_INVALID
+ * \retval LB_STATUS_ERROR_FAULT
+ * \pre N/A
+ * \post N/A
+ * \see provider_send_pd_update_begin
  */
 extern int provider_send_pd_update_end(const char *pkgname, const char *id);
 
 /*!
  * \brief Send the deleted event of specified livebox instance
+ * \details N/A
+ * \remarks N/A
  * \param[in] pkgname Package name of the livebox
  * \param[in] id Livebox instance ID
- * \return int Success LB_STATUS_SUCCESS otherwise errno < 0
- * \sa provider_send_faulted
- * \sa provider_send_hold_scroll
+ * \return int
+ * \retval LB_STATUS_SUCCESS
+ * \retval LB_STATUS_ERROR_INVALID
+ * \retval LB_STATUS_ERROR_FAULT
+ * \pre N/A
+ * \post N/A
+ * \see provider_send_faulted
+ * \see provider_send_hold_scroll
  */
 extern int provider_send_deleted(const char *pkgname, const char *id);
 
 /*!
- * \breif If you want to use the fault management service of the master provider,
+ * \brief If you want to use the fault management service of the master provider,
  *        Before call any functions of a livebox, call this.
  * \param[in] pkgname Package name of the livebox
  * \param[in] id Instance ID of the livebox
  * \param[in] funcname Function name which will be called
- * \return int Success LB_STATUS_SUCCESS otherwise errno < 0
- * \sa provider_send_call
+ * \return int
+ * \retval LB_STATUS_SUCCESS
+ * \retval LB_STATUS_ERROR_INVALID
+ * \retval LB_STATUS_ERROR_FAULT
+ * \pre N/A
+ * \post N/A
+ * \see provider_send_call
  */
 extern int provider_send_ret(const char *pkgname, const char *id, const char *funcname);
 
 /*!
  * \brief If you want to use the fault management service of the master provider,
+ * \details N/A
+ * \remarks N/A
  *        After call any functions of a livebox, call this.
  * \param[in] pkgname Package name of the livebox
  * \param[in] id Instance ID of the livebox
  * \param[in] funcname Function name which is called by the slave
- * \return int Success LB_STATUS_SUCCESS otherwise errno < 0
- * \sa provider_send_ret
+ * \return int
+ * \retval LB_STATUS_SUCCESS
+ * \retval LB_STATUS_ERROR_INVALID
+ * \retval LB_STATUS_ERROR_FAULT
+ * \pre N/A
+ * \post N/A
+ * \see provider_send_ret
  */
 extern int provider_send_call(const char *pkgname, const char *id, const char *funcname);
 
 /*!
  * \brief If you want to send the fault event to the master provider,
+ * \details N/A
+ * \remarks N/A
  *        Use this API
  * \param[in] pkgname Package name of the livebox
  * \param[in] id ID of the livebox instance
  * \param[in] funcname Reason of the fault error
- * \return int Success LB_STATUS_SUCCESS otherwise errno < 0
- * \sa provider_send_deleted
- * \sa provider_send_hold_scroll
- * \sa provider_send_access_status
+ * \return int
+ * \retval LB_STATUS_SUCCESS
+ * \retval LB_STATUS_ERROR_INVALID
+ * \retval LB_STATUS_ERROR_FAULT
+ * \pre N/A
+ * \post N/A
+ * \see provider_send_deleted
+ * \see provider_send_hold_scroll
+ * \see provider_send_access_status
  */
 extern int provider_send_faulted(const char *pkgname, const char *id, const char *funcname);
 
 /*!
  * \brief If you want notify to viewer to seize the screen,
+ * \details N/A
+ * \remarks N/A
  *        prevent moving a box from user event
  * \param[in] pkgname Package name of the livebox
  * \param[in] id ID of the livebox instance
  * \param[in] seize 1 if viewer needs to hold a box, or 0
- * \return int Success LB_STATUS_SUCCESS othere LB_STATUS_ERROR_XXX
- * \sa provider_send_faulted
- * \sa provider_send_deleted
- * \sa provider_send_access_status
+ * \return int
+ * \retval LB_STATUS_SUCCESS
+ * \retval LB_STATUS_ERROR_INVALID
+ * \retval LB_STATUS_ERROR_FAULT
+ * \pre N/A
+ * \post N/A
+ * \see provider_send_faulted
+ * \see provider_send_deleted
+ * \see provider_send_access_status
  */
 extern int provider_send_hold_scroll(const char *pkgname, const char *id, int seize);
 
 /*!
  * \brief Notify to viewer for accessiblity event processing status.
+ * \details N/A
+ * \remarks N/A
  * \param[in] pkgname Package name of livebox
  * \param[in] id Instance Id of livebox
  * \param[in] status
  * \return int
- * \sa provider_send_deleted
- * \sa provider_send_faulted
- * \sa provider_send_hold_scroll
+ * \retval LB_STATUS_SUCCESS
+ * \retval LB_STATUS_ERROR_INVALID
+ * \retval LB_STATUS_ERROR_FAULT
+ * \pre N/A
+ * \post N/A
+ * \see provider_send_deleted
+ * \see provider_send_faulted
+ * \see provider_send_hold_scroll
  */
 extern int provider_send_access_status(const char *pkgname, const char *id, int status);
 

diff --git a/include/provider_buffer.h b/include/provider_buffer.h
index e247fa3..519710e 100644 (file)
--- a/include/provider_buffer.h
+++ b/include/provider_buffer.h
@@ -22,12 +22,12 @@ extern "C" {
 #endif
 
 /*!
- * \ingroup PROVIDER Provider Programming Interface for Buffer
+ * \addtogroup CAPI_PROVIDER_MODULE
  * \{
  */
 
 /*!
- * \NOTE
+ * \note
  * This enumeration value has to be sync'd with the liblivebox interface. (only for inhouse livebox)
  */
 enum target_type {
@@ -37,7 +37,7 @@ enum target_type {
 };
 
 /*!
- * \NOTE
+ * \note
  * This enumeration value should be sync'd with liblivebox interface. (only for inhouse livebox)
  */
 enum buffer_event {
@@ -66,6 +66,8 @@ struct livebox_buffer;
 
 /*!
  * \brief Send request for acquiring buffer of given type.
+ * \details N/A
+ * \remarks N/A
  * \param[in] type TYPE_LB or TYPE_PD, select the type of buffer. is it for LB? or PD?
  * \param[in] pkgname Package name of a livebox instance
  * \param[in] id Instance Id
@@ -74,171 +76,312 @@ struct livebox_buffer;
  * \param[in] pixel_size Normally, use "4" for this. it is fixed.
  * \param[in] handler Event handler. Viewer will send the events such as mouse down,move,up, accessibilty event, etc,. via this callback function.
  * \param[in] data Callback data for event handler
- * \return livebox_buffer Livebox buffer object handler
- * \sa provider_buffer_release
+ * \return livebox_buffer
+ * \retval Livebox buffer object handler
+ * \retval NULL if it fails to acquire buffer
+ * \pre N/A
+ * \post N/A
+ * \see provider_buffer_release
  */
 extern struct livebox_buffer *provider_buffer_acquire(enum target_type type, const char *pkgname, const char *id, int width, int height, int pixel_size, int (*handler)(struct livebox_buffer *, enum buffer_event, double, double, double, void *data), void *data);
 
 /*!
  * \brief
+ * \details N/A
+ * \remarks N/A
  * \param[in] info
  * \param[in] w
  * \param[in] h
  * \return int
+ * \retval LB_STATUS_ERROR_INVALID
+ * \retval LB_STATUS_SUCCESS
+ * \pre N/A
+ * \post N/A
+ * \see N/A
  */
 extern int provider_buffer_resize(struct livebox_buffer *info, int w, int h);
 
 /*!
  * \brief Get the buffer address of given livebox buffer handle.
+ * \details N/A
+ * \remarks N/A
  * \param[in] info Handle of livebox buffer
  * \return address
- * \sa provider_buffer_unref
+ * \retval Address of buffer
+ * \retval NULL
+ * \pre N/A
+ * \post N/A
+ * \see provider_buffer_unref
  */
 extern void *provider_buffer_ref(struct livebox_buffer *info);
 
 /*!
  * \brief Decrease the reference count of given buffer handle.
+ * \details N/A
+ * \remarks N/A
  * \param[in] ptr Address that gets by provider_buffer_ref
  * \return int
- * \sa provider_buffer_ref
+ * \pre N/A
+ * \post N/A
+ * \see provider_buffer_ref
  */
 extern int provider_buffer_unref(void *ptr);
 
 /*!
  * \brief Release the acquired buffer handle.
+ * \details N/A
+ * \remarks N/A
  * \param[in] info Handle of livebox buffer
  * \return int
- * \sa provider_buffer_acquire
+ * \retval LB_STATUS_ERROR_INVALID
+ * \retval LB_STATUS_SUCCESS
+ * \pre N/A
+ * \post N/A
+ * \see provider_buffer_acquire
  */
 extern int provider_buffer_release(struct livebox_buffer *info);
 
 /*!
  *\brief Make content sync with master.
- \param[in] info Handle of livebox buffer
- \return int
+ * \details N/A
+ * \remarks N/A
+ * \param[in] info Handle of livebox buffer
+ * \return int
+ * \retval LB_STATUS_ERROR_INVALID
+ * \retval LB_STATUS_SUCCESS
+ * \pre N/A
+ * \post N/A
+ * \see N/A
  */
 extern int provider_buffer_sync(struct livebox_buffer *info);
 
 /*!
  * \brief Get the buffer type
+ * \details N/A
+ * \remarks N/A
  * \param[in] info Handle of livebox buffer
  * \return target type PD or LB
+ * \retval TYPE_LB
+ * \retval TYPE_PD
+ * \retval TYPE_ERROR
+ * \pre N/A
+ * \post N/A
+ * \see N/A
  */
 extern enum target_type provider_buffer_type(struct livebox_buffer *info);
 
 /*!
  * \brief Get the package name
+ * \details N/A
+ * \remarks N/A
  * \param[in] info
- * \return pkgname
+ * \return const char *
+ * \retval NULL
+ * \retval pkgname package name
+ * \pre N/A
+ * \post N/A
+ * \see N/A
  */
 extern const char *provider_buffer_pkgname(struct livebox_buffer *info);
 
 /*!
  * \brief
+ * \details N/A
+ * \remarks N/A
  * \param[in] info Handle of livebox buffer
- * \return id
+ * \return const char *
+ * \retval instance Id
+ * \retval NULL
+ * \pre N/A
+ * \post N/A
+ * \see N/A
  */
 extern const char *provider_buffer_id(struct livebox_buffer *info);
 
 /*!
  * \brief Give the URI of buffer information.
+ * \details N/A
+ * \remarks N/A
  * \param[in] info Handle of livebox buffer
- * \return uri
+ * \return const char *
+ * \retval uri
+ * \retval NULL
+ * \pre N/A
+ * \post N/A
+ * \see N/A
  */
 extern const char *provider_buffer_uri(struct livebox_buffer *info);
 
 /*!
  * \brief
+ * \details N/A
+ * \remarks N/A
  * \param[in] info Handle of livebox buffer
  * \param[out] w
  * \param[out] h
  * \param[out] pixel_size
  * \return int
+ * \retval LB_STATUS_SUCCESS
+ * \retval LB_STATUS_ERROR_INVALID
+ * \pre N/A
+ * \post N/A
+ * \see N/A
  */
 extern int provider_buffer_get_size(struct livebox_buffer *info, int *w, int *h, int *pixel_size);
 
 /*!
  * \brief Getting the PIXMAP id of mapped on this livebox_buffer
+ * \details N/A
+ * \remarks N/A
  * \param[in] info Handle of livebox buffer
- * \return 0 if fails or pixmap ID
+ * \return int
+ * \retval 0 if fails
+ * \retval pixmap id, has to be casted to unsigned int type
+ * \pre N/A
+ * \post N/A
+ * \see N/A
  */
 extern unsigned long provider_buffer_pixmap_id(struct livebox_buffer *info);
 
 /*!
  * \brief Initialize the provider buffer system
+ * \details N/A
+ * \remarks N/A
  * \param[in] disp Display information for handling the XPixmap type.
  * \return int
+ * \retval LB_STATUS_ERROR_FAULT
+ * \retval LB_STATUS_SUCCESS
+ * \pre N/A
+ * \post N/A
+ * \see N/A
  */
 extern int provider_buffer_init(void *disp);
 
 /*!
  * \brief Finalize the provider buffer system
+ * \details N/A
+ * \remarks N/A
  * \return int
+ * \retval LB_STATUS_SUCCESS
+ * \pre N/A
+ * \post N/A
+ * \see N/A
  */
 extern int provider_buffer_fini(void);
 
 /*!
  * \brief Check whether current livebox buffer support H/W(GEM) buffer
+ * \details N/A
+ * \remarks N/A
  * \param[in] info Handle of livebox buffer
- * \return int 1 if support or 0
+ * \return int
+ * \retval LB_STATUS_ERROR_INVALID
+ * \retval 1 if support
+ * \retval 0 if not supported
+ * \pre N/A
+ * \post N/A
+ * \see N/A
  */
 extern int provider_buffer_pixmap_is_support_hw(struct livebox_buffer *info);
 
 /*!
  * \brief Create H/W(GEM) Buffer
+ * \details N/A
+ * \remarks N/A
  * \param[in] info Handle of livebox buffer
- * \return int LB_STATUS_SUCCESS or LB_STATUS_ERROR_INVALID, LB_STATUS_ERROR_FAULT
- * \sa provider_buffer_pixmap_destroy_hw
+ * \return int
+ * \retval LB_STATUS_SUCCESS
+ * \retval LB_STATUS_ERROR_INVALID
+ * \retval LB_STATUS_ERROR_FAULT
+ * \pre N/A
+ * \post N/A
+ * \see provider_buffer_pixmap_destroy_hw
  */
 extern int provider_buffer_pixmap_create_hw(struct livebox_buffer *info);
 
 /*!
  * \brief Destroy H/W(GEM) Buffer
+ * \details N/A
+ * \remarks N/A
  * \param[in] info Handle of livebox buffer
- * \return int LB_STATUS_SUCCESS or LB_STATUS_ERROR_INVALID
- * \sa provider_buffer_pixmap_create_hw
+ * \return int
+ * \retval LB_STATUS_SUCCESS
+ * \retval LB_STATUS_ERROR_INVALID
+ * \pre N/A
+ * \post N/A
+ * \see provider_buffer_pixmap_create_hw
  */
 extern int provider_buffer_pixmap_destroy_hw(struct livebox_buffer *info);
 
 /*!
  * \brief Get the H/W system mapped buffer address(GEM buffer) if a buffer support it.
+ * \details N/A
+ * \remarks N/A
  * \param[in] info Handle of livebox buffer
- * \return void * H/W system mapped buffer address
- * \sa provider_buffer_pixmap_create_hw
- * \sa provider_buffer_pixmap_destroy_hw
+ * \return void *
+ * \retval H/W system mapped buffer address
+ * \retval NULL fails to get buffer address
+ * \pre N/A
+ * \post N/A
+ * \see provider_buffer_pixmap_create_hw
+ * \see provider_buffer_pixmap_destroy_hw
  */
 extern void *provider_buffer_pixmap_hw_addr(struct livebox_buffer *info);
 
 /*!
  * \brief Prepare the render buffer to write or read something on it.
+ * \details N/A
+ * \remarks N/A
  * \param[in] info Handle of livebox buffer
  * \return int
- * \sa provider_buffer_post_render
+ * \retval LB_STATUS_SUCCESS
+ * \retval LB_STATUS_ERROR_INVALID
+ * \retval LB_STATUS_ERROR_FAULT
+ * \pre N/A
+ * \post N/A
+ * \see provider_buffer_post_render
  */
 extern int provider_buffer_pre_render(struct livebox_buffer *info);
 
 /*!
  * \brief Finish the render buffer acessing.
+ * \details N/A
+ * \remarks N/A
  * \param[in] info Handle of livebox buffer
  * \return int
- * \sa provider_buffer_pre_render
+ * \retval LB_STATUS_SUCCESS
+ * \retval LB_STATUS_ERROR_INVALID
+ * \pre N/A
+ * \post N/A
+ * \see provider_buffer_pre_render
  */
 extern int provider_buffer_post_render(struct livebox_buffer *info);
 
 /*!
  * \brief
+ * \details N/A
+ * \remarks N/A
  * \param[in] handle Handle of livebox buffer
- * \return void* User data
- * \sa provider_buffer_set_user_data
+ * \return void *
+ * \retval User data
+ * \pre N/A
+ * \post N/A
+ * \see provider_buffer_set_user_data
  */
 extern void *provider_buffer_user_data(struct livebox_buffer *handle);
 
 /*!
  * \brief
+ * \details N/A
+ * \remarks N/A
  * \param[in] handle Handle of livebox buffer
  * \param[in] data User data
  * \return int
- * \sa provider_buffer_user_data
+ * \retval LB_STATUS_SUCCESS
+ * \retval LB_STATUS_ERROR_INVALID
+ * \pre N/A
+ * \post N/A
+ * \see provider_buffer_user_data
  */
 extern int provider_buffer_set_user_data(struct livebox_buffer *handle, void *data);
 

diff --git a/src/fb.c b/src/fb.c
index a1b3036..7eccb87 100644 (file)
--- a/src/fb.c
+++ b/src/fb.c
@@ -199,7 +199,7 @@ int fb_init(void *disp)
        s_info.bufmgr = tbm_bufmgr_init(s_info.fd);
        if (!s_info.bufmgr) {
                ErrPrint("Failed to init bufmgr\n");
-               if (close(s_info.fd) < 0) {
+               if (close(s_info.fd) < 0) { 
                        ErrPrint("close: %s\n", strerror(errno));
                }
                s_info.fd = -1;

diff --git a/src/provider.c b/src/provider.c
index a4c1bf1..4b1cce1 100644 (file)
--- a/src/provider.c
+++ b/src/provider.c
@@ -1122,7 +1122,7 @@ static char *keep_file_in_safe(const char *id, int uri)
 }
 
 /*!
- * \NOTE
+ * \note
  *   Only for the buffer type
  */
 EAPI int provider_send_lb_update_begin(const char *pkgname, const char *id, double priority, const char *content_info, const char *title)

diff --git a/src/provider_buffer.c b/src/provider_buffer.c
index f9efc94..8e11feb 100644 (file)
--- a/src/provider_buffer.c
+++ b/src/provider_buffer.c
@@ -484,7 +484,7 @@ EAPI int provider_buffer_pre_render(struct livebox_buffer *info)
        }
 
        if (fb_has_gem(info->fb)) {
-               ret = fb_acquire_gem(info->fb) ? 0 : -EFAULT;
+               ret = fb_acquire_gem(info->fb) ? LB_STATUS_SUCCESS : LB_STATUS_ERROR_FAULT;
        }
 
        return ret;