* @param[in] ret Result status of operation (LB_STATUS_XXX defined from liblivebox-service)
* @param[in] data Data for result callback
* @return void
- * @see livebox_add
- * @see livebox_add_with_size
- * @see livebox_del
- * @see livebox_activate
- * @see livebox_resize
- * @see livebox_set_group
- * @see livebox_set_period
- * @see livebox_access_event
- * @see livebox_set_pinup
- * @see livebox_create_pd
- * @see livebox_create_pd_with_position
- * @see livebox_destroy_pd
- * @see livebox_emit_text_signal
- * @see livebox_acquire_pd_pixmap
- * @see livebox_acquire_lb_pixmap
- * @see livebox_set_update_mode.
+ * @see livebox_add()
+ * @see livebox_add_with_size()
+ * @see livebox_del()
+ * @see livebox_activate()
+ * @see livebox_resize()
+ * @see livebox_set_group()
+ * @see livebox_set_period()
+ * @see livebox_access_event()
+ * @see livebox_set_pinup()
+ * @see livebox_create_pd()
+ * @see livebox_create_pd_with_position()
+ * @see livebox_destroy_pd()
+ * @see livebox_emit_text_signal()
+ * @see livebox_acquire_pd_pixmap()
+ * @see livebox_acquire_lb_pixmap()
+ * @see livebox_set_update_mode()
*/
typedef void (*ret_cb_t)(struct livebox *handle, int ret, void *data);
* @param[in] disp X Display connection object (If you have X Display connection object already, you can re-use it. But you should care its life cycle.
* It must be alive before calling livebox_fini())
* @return int
- * @retval LB_STATUS_SUCCESS if success
- * @see livebox_fini
- * @see livebox_init_with_options
+ * @retval #LB_STATUS_SUCCESS if success
+ * @see livebox_fini()
+ * @see livebox_init_with_options()
*/
extern int livebox_init(void *disp);
* @details livebox_init function uses environment value to initiate some configurable values.
* But some applications do not want to use the env value.
* For them, this API will give a chance to set default options using given arguments.
- * @param[in] disp Display (if @a disp is NULL, the library will try to acquire a new connection with X)
+ * @param[in] disp Display (if @a disp is @c NULL, the library will try to acquire a new connection with X)
* @param[in] prevent_overwrite Overwrite flag (when the content of an image type livebox is updated, it will be overwriten (0) or not (1))
* @param[in] event_filter If the next event comes in this period, ignore it. It is too fast to processing it in time // need to be elaborated
* @param[in] use_thread Use the receive thread // need to be elaborated
* @privlevel platform
* @privilege %http://developer.samsung.com/privilege/core/dynamicbox.viewer
* @return int Integer, Livebox status code
- * @retval LB_STATUS_SUCCESS if success
- * @see livebox_init
- * @see livebox_fini
+ * @retval #LB_STATUS_SUCCESS if success
+ * @see livebox_init()
+ * @see livebox_fini()
*/
extern int livebox_init_with_options(void *disp, int prevent_overwrite, double event_filter, int use_thread);
* @privlevel platform
* @privilege %http://developer.samsung.com/privilege/core/dynamicbox.viewer
* @return int
- * @retval LB_STATUS_SUCCES if success
- * @retval LB_STATUS_ERROR_INVALID if livebox_init is not called
- * @see livebox_init
- * @see livebox_init_with_options
+ * @retval #LB_STATUS_SUCCES if success
+ * @retval #LB_STATUS_ERROR_INVALID if livebox_init is not called
+ * @see livebox_init()
+ * @see livebox_init_with_options()
*/
extern int livebox_fini(void);
* @privlevel platform
* @privilege %http://developer.samsung.com/privilege/core/dynamicbox.viewer
* @return int
- * @retval LB_STATUS_SUCCESS if success
- * @retval LB_STATUS_ERROR_FAULT if it failed to send state (paused) info
- * @see livebox_client_resumed
+ * @retval #LB_STATUS_SUCCESS if success
+ * @retval #LB_STATUS_ERROR_FAULT if it failed to send state (paused) info
+ * @see livebox_client_resumed()
*/
extern int livebox_client_paused(void);
* @privlevel platform
* @privilege %http://developer.samsung.com/privilege/core/dynamicbox.viewer
* @return int
- * @retval LB_STATUS_SUCCESS if success
- * @retval LB_STATUS_ERROR_FAULT if it failed to send state (resumed) info
- * @see livebox_client_paused
+ * @retval #LB_STATUS_SUCCESS if success
+ * @retval #LB_STATUS_ERROR_FAULT if it failed to send state (resumed) info
+ * @see livebox_client_paused()
*/
extern int livebox_client_resumed(void);
* @brief Adds a new livebox.
* @remarks Even though you get the livebox handle from the return value of this function,
* it is not initialized before return_callback is called.
- * You have to use the handle after getting return callback with "ret == LB_STATUS_SUCCESS"
+ * You have to use the handle after getting return callback with "ret == #LB_STATUS_SUCCESS"
* @param[in] pkgname Livebox Id
* @param[in] content Contetns that will be passed to the livebox instance
* @param[in] cluster Main group
* @param[in] category Sub group
- * @param[in] period Update period (if you set DEFAULT_PERIOD, the provider will use the default period which is described in the manifest)
+ * @param[in] period Update period (if you set @c DEFAULT_PERIOD, the provider will use the default period which is described in the manifest)
* @param[in] cb After send the request to the provider, its result will be passed
* @param[in] data Data
* @privlevel platform
* @privilege %http://developer.samsung.com/privilege/core/dynamicbox.viewer
* @return handle
- * @retval NULL if it fails to add a new instance
+ * @retval @c NULL if it fails to add a new instance
* @retval handle Livebox handle
* @see ret_cb_t
- * @see livebox_add_with_size
+ * @see livebox_add_with_size()
*/
extern struct livebox *livebox_add(const char *pkgname, const char *content, const char *cluster, const char *category, double period, ret_cb_t cb, void *data);
* Size types are defined from the liblivebox-service package (livebox-service.h).
*
* Normal mode livebox
- * 1x1=175x175, LB_SIZE_TYPE_1x1
- * 2x1=354x175, LB_SIZE_TYPE_2x1
- * 2x2=354x354, LB_SIZE_TYPE_2x2
- * 4x1=712x175, LB_SIZE_TYPE_4x1
- * 4x2=712x354, LB_SIZE_TYPE_4x2
- * 4x4=712x712, LB_SIZE_TYPE_4x4
+ * 1x1=175x175, #LB_SIZE_TYPE_1x1
+ * 2x1=354x175, #LB_SIZE_TYPE_2x1
+ * 2x2=354x354, #LB_SIZE_TYPE_2x2
+ * 4x1=712x175, #LB_SIZE_TYPE_4x1
+ * 4x2=712x354, #LB_SIZE_TYPE_4x2
+ * 4x4=712x712, #LB_SIZE_TYPE_4x4
*
* Extended sizes
- * 4x3=712x533, LB_SIZE_TYPE_4x3
- * 4x5=712x891, LB_SIZE_TYPE_4x5
- * 4x6=712x1070, LB_SIZE_TYPE_4x6
+ * 4x3=712x533, #LB_SIZE_TYPE_4x3
+ * 4x5=712x891, #LB_SIZE_TYPE_4x5
+ * 4x6=712x1070, #LB_SIZE_TYPE_4x6
*
* Easy mode livebox
- * 21x21=224x215, LB_SIZE_TYPE_EASY_1x1
- * 23x21=680x215, LB_SIZE_TYPE_EASY_3x1
- * 23x23=680x653, LB_SIZE_TYPE_EASY_3x3
+ * 21x21=224x215, #LB_SIZE_TYPE_EASY_1x1
+ * 23x21=680x215, #LB_SIZE_TYPE_EASY_3x1
+ * 23x23=680x653, #LB_SIZE_TYPE_EASY_3x3
*
* Special livebox
- * 0x0=720x1280, LB_SIZE_TYPE_0x0
+ * 0x0=720x1280, #LB_SIZE_TYPE_0x0
*
* @remarks
* Even if you get a handle from the return value of this function, it is not a created instance.
* So you have to consider it as a not initialized handle.
- * It can be initialized only after getting the return callback with "ret == LB_STATUS_SUCCESS"
+ * It can be initialized only after getting the return callback with "ret == #LB_STATUS_SUCCESS"
* @param[in] pkgname Livebox Id
* @param[in] content Contents that will be passed to the livebox instance
* @param[in] cluster Main group
* @param[in] category Sub group
- * @param[in] period Update period (DEFAULT_PERIOD can be used for this; this argument will be used to specify the period of updating contents of a livebox)
+ * @param[in] period Update period (@c DEFAULT_PERIOD can be used for this; this argument will be used to specify the period of updating contents of a livebox)
* @param[in] type Size type (defined from liblivebox-service package)
* @param[in] cb After the request is sent to the master provider, this callback will be called
* @param[in] data This data will be passed to the callback
* @privilege %http://developer.samsung.com/privilege/core/dynamicbox.viewer
* @return handle
* @retval Handle Livebox handle but not yet initialized
- * @retval NULL if it fails to create a handle
+ * @retval @c NULL if it fails to create a handle
* @see ret_cb_t
- * @see livebox_add
+ * @see livebox_add()
*/
extern struct livebox *livebox_add_with_size(const char *pkgname, const char *content, const char *cluster, const char *category, double period, int type, ret_cb_t cb, void *data);
* @privlevel platform
* @privilege %http://developer.samsung.com/privilege/core/dynamicbox.viewer
* @return int
- * @retval LB_STATUS_ERROR_INVALID Invalid argument
- * @retval LB_STATUS_ERROR_BUSY Already in process
- * @retval LB_STATUS_ERROR_FAULT Failed to create a request packet
- * @retval LB_STATUS_SUCCESS Successfully sent, return callack will be called
+ * @retval #LB_STATUS_ERROR_INVALID Invalid argument
+ * @retval #LB_STATUS_ERROR_BUSY Already in process
+ * @retval #LB_STATUS_ERROR_FAULT Failed to create a request packet
+ * @retval #LB_STATUS_SUCCESS Successfully sent, return callack will be called
* @see ret_cb_t
*/
extern int livebox_del(struct livebox *handler, ret_cb_t cb, void *data);
* @privlevel platform
* @privilege %http://developer.samsung.com/privilege/core/dynamicbox.viewer
* @return int
- * @retval LB_STATUS_ERROR_INVALID Invalid argument
- * @retval LB_STATUS_ERROR_BUSY Already in process
- * @retval LB_STATUS_ERROR_FAULT Failed to create a request packet
- * @retval LB_STATUS_SUCCESS Successfully sent, return callack will be called
+ * @retval #LB_STATUS_ERROR_INVALID Invalid argument
+ * @retval #LB_STATUS_ERROR_BUSY Already in process
+ * @retval #LB_STATUS_ERROR_FAULT Failed to create a request packet
+ * @retval #LB_STATUS_SUCCESS Successfully sent, return callack will be called
* @see ret_cb_t
*/
extern int livebox_del_NEW(struct livebox *handler, int type, ret_cb_t cb, void *data);
* @param[in] data User data for the event handler
* @privlevel N/P
* @return int
- * @retval LB_STATUS_SUCCESS If succeed to set event handler
- * @retval LB_STATUS_ERROR_INVALID Invalid argument
- * @retval LB_STATUS_ERROR_MEMORY Not enough memory
- * @see livebox_unset_event_handler
+ * @retval #LB_STATUS_SUCCESS If succeed to set event handler
+ * @retval #LB_STATUS_ERROR_INVALID Invalid argument
+ * @retval #LB_STATUS_ERROR_MEMORY Not enough memory
+ * @see livebox_unset_event_handler()
*/
extern int livebox_set_event_handler(int (*cb)(struct livebox *handler, enum livebox_event_type event, void *data), void *data);
* @privlevel N/P
* @return void * Event handler data
* @retval pointer Pointer of 'data' which is used with the livebox_set_event_handler
- * @see livebox_set_event_handler
+ * @see livebox_set_event_handler()
*/
extern void *livebox_unset_event_handler(int (*cb)(struct livebox *handler, enum livebox_event_type event, void *data));
* @param[in] data Event handler data
* @privlevel N/P
* @return int
- * @retval LB_STATUS_SUCCESS If succeed to set fault event handler
- * @retval LB_STATUS_ERROR_INVALID Invalid argument
- * @retval LB_STATUS_ERROR_MEMORY Not enough memory
- * @see livebox_unset_fault_handler.
+ * @retval #LB_STATUS_SUCCESS If succeed to set fault event handler
+ * @retval #LB_STATUS_ERROR_INVALID Invalid argument
+ * @retval #LB_STATUS_ERROR_MEMORY Not enough memory
+ * @see livebox_unset_fault_handler()
*/
extern int livebox_set_fault_handler(int (*cb)(enum livebox_fault_type, const char *, const char *, const char *, void *), void *data);
* @privlevel N/P
* @return void * Callback data which is set via livebox_set_fault_handler
* @retval pointer Pointer of 'data' which is used with the livebox_set_fault_handler
- * @see livebox_set_fault_handler
+ * @see livebox_set_fault_handler()
*/
extern void *livebox_unset_fault_handler(int (*cb)(enum livebox_fault_type, const char *, const char *, const char *, void *));
* @privlevel platform
* @privilege %http://developer.samsung.com/privilege/core/dynamicbox.viewer
* @return int type
- * @retval LB_STATUS_SUCCESS Successfully sent a request
- * @retval LB_STATUS_ERROR_INVALID Invalid argument
- * @retval LB_STATUS_ERROR_FAULT Failed to make a request
+ * @retval #LB_STATUS_SUCCESS Successfully sent a request
+ * @retval #LB_STATUS_ERROR_INVALID Invalid argument
+ * @retval #LB_STATUS_ERROR_FAULT Failed to make a request
* @see ret_cb_t
*/
extern int livebox_activate(const char *pkgname, ret_cb_t cb, void *data);
* @privlevel platform
* @privilege %http://developer.samsung.com/privilege/core/dynamicbox.viewer
* @return int type
- * @retval LB_STATUS_ERROR_INVALID Invalid argument
- * @retval LB_STATUS_ERROR_BUSY Previous request of resize is in progress
- * @retval LB_STATUS_ERROR_ALREADY Already resized, there is no differences between current size and requested size
- * @retval LB_STATUS_ERROR_PERMISSION Permission denied, you only have view the content of this box
- * @retval LB_STATUS_ERROR_FAULT Failed to make a request
+ * @retval #LB_STATUS_ERROR_INVALID Invalid argument
+ * @retval #LB_STATUS_ERROR_BUSY Previous request of resize is in progress
+ * @retval #LB_STATUS_ERROR_ALREADY Already resized, there is no differences between current size and requested size
+ * @retval #LB_STATUS_ERROR_PERMISSION Permission denied, you only have view the content of this box
+ * @retval #LB_STATUS_ERROR_FAULT Failed to make a request
* @see ret_cb_t
*/
extern int livebox_resize(struct livebox *handler, int type, ret_cb_t cb, void *data);
* @privlevel platform
* @privilege %http://developer.samsung.com/privilege/core/dynamicbox.viewer
* @return int
- * @retval LB_STATUS_ERROR_INVALID Invalid argument
- * @retval LB_STATUS_ERROR_FAULT Unrecoverable error occurred
- * @retval LB_STATUS_SUCCESS Successfully done
+ * @retval #LB_STATUS_ERROR_INVALID Invalid argument
+ * @retval #LB_STATUS_ERROR_FAULT Unrecoverable error occurred
+ * @retval #LB_STATUS_SUCCESS Successfully done
*/
extern int livebox_click(struct livebox *handler, double x, double y);
* @privlevel platform
* @privilege %http://developer.samsung.com/privilege/core/dynamicbox.viewer
* @return int
- * @retval LB_STATUS_SUCCESS Request is successfully sent. the return callback will be called
- * @retval LB_STATUS_ERROR_BUSY Previous request is not finished yet
- * @retval LB_STATUS_ERROR_ALREADY Group name is same with current one
- * @retval LB_STATUS_ERROR_PERMISSION You have no permission to change property of this livebox instance
- * @retval LB_STATUS_ERROR_FAULT Failed to make a request
+ * @retval #LB_STATUS_SUCCESS Request is successfully sent. the return callback will be called
+ * @retval #LB_STATUS_ERROR_BUSY Previous request is not finished yet
+ * @retval #LB_STATUS_ERROR_ALREADY Group name is same with current one
+ * @retval #LB_STATUS_ERROR_PERMISSION You have no permission to change property of this livebox instance
+ * @retval #LB_STATUS_ERROR_FAULT Failed to make a request
* @see ret_cb_t
*/
extern int livebox_set_group(struct livebox *handler, const char *cluster, const char *category, ret_cb_t cb, void *data);
* @param[out] category Storage(memory) for containing the category name
* @privlevel N/P
* @return int
- * @retval LB_STATUS_ERROR_INVALID Invalid argument
- * @retval LB_STATUS_SUCCESS Successfully done
+ * @retval #LB_STATUS_ERROR_INVALID Invalid argument
+ * @retval #LB_STATUS_SUCCESS Successfully done
*/
extern int livebox_get_group(struct livebox *handler, const char **cluster, const char **category);
* @privlevel platform
* @privilege %http://developer.samsung.com/privilege/core/dynamicbox.viewer
* @return int
- * @retval LB_STATUS_SUCCESS Successfully done
- * @retval LB_STATUS_ERROR_INVALID Invalid argument
- * @retval LB_STATUS_ERROR_BUSY
- * @retval LB_STATUS_ERROR_ALREADY
- * @retval LB_STATUS_ERROR_FAULT Unrecoverable error occurred
+ * @retval #LB_STATUS_SUCCESS Successfully done
+ * @retval #LB_STATUS_ERROR_INVALID Invalid argument
+ * @retval #LB_STATUS_ERROR_BUSY
+ * @retval #LB_STATUS_ERROR_ALREADY
+ * @retval #LB_STATUS_ERROR_FAULT Unrecoverable error occurred
* @see ret_cb_t
*/
extern int livebox_set_period(struct livebox *handler, double period, ret_cb_t cb, void *data);
* @param[in] handler Handler of a livebox instance
* @privlevel N/P
* @return livebox_lb_type
- * @retval LB_TYPE_IMAGE Contents of a livebox is based on the image file
- * @retval LB_TYPE_BUFFER Contents of a livebox is based on canvas buffer(shared)
- * @retval LB_TYPE_TEXT Contents of a livebox is based on formatted text file
- * @retval LB_TYPE_PIXMAP Contens of a livebox is shared by the pixmap(depends on X)
- * @retval LB_TYPE_INVALID
- * @see livebox_lb_type
+ * @retval #LB_TYPE_IMAGE Contents of a livebox is based on the image file
+ * @retval #LB_TYPE_BUFFER Contents of a livebox is based on canvas buffer(shared)
+ * @retval #LB_TYPE_TEXT Contents of a livebox is based on formatted text file
+ * @retval #LB_TYPE_PIXMAP Contens of a livebox is shared by the pixmap(depends on X)
+ * @retval #LB_TYPE_INVALID
+ * @see livebox_lb_type()
*/
extern enum livebox_lb_type livebox_lb_type(struct livebox *handler);
* @param[in] handler Handler of a livebox instance
* @privlevel N/P
* @return int
- * @retval LB_STATUS_ERROR_INVALID Invalid argument
+ * @retval #LB_STATUS_ERROR_INVALID Invalid argument
* @retval 0 Automatically created livebox by the provider
* @retval 1 Created by user via livebox_add or livebox_add_with_size
- * @see livebox_add
- * @see livebox_add_with_size
- * @see livebox_set_event_handler
+ * @see livebox_add()
+ * @see livebox_add_with_size()
+ * @see livebox_set_event_handler()
*/
extern int livebox_is_user(struct livebox *handler);
* @privlevel N/P
* @return const char *
* @retval content_info Livebox content info that can be used again via content_info argument of livebox_add or livebox_add_with_size
- * @see livebox_add
- * @see livebox_add_with_size
+ * @see livebox_add()
+ * @see livebox_add_with_size()
*/
extern const char *livebox_content(struct livebox *handler);
* @privlevel N/P
* @return const char *
* @retval sub Cluster name
- * @retval NULL
+ * @retval @c NULL
*/
extern const char *livebox_category_title(struct livebox *handler);
* @privlevel N/P
* @return const char *
* @retval filename If the livebox type is image this function will give you a abs-path of an image file (content is rendered)
- * @retval NULL If this has no image file or type is not image file.
+ * @retval @c NULL If this has no image file or type is not image file.
*/
extern const char *livebox_filename(struct livebox *handler);
* @privlevel N/P
* @return const char *
* @retval pkgname Package name
- * @retval NULL If the handler is not valid
+ * @retval @c NULL If the handler is not valid
*/
extern const char *livebox_pkgname(struct livebox *handler);
* @param[in] handler Handler of a livebox instance
* @privlevel N/P
* @return double
- * @retval 0.0f Handler is NULL
+ * @retval 0.0f Handler is @c NULL
* @retval -1.0f Handler is not valid (not yet initialized)
* @retval real Number between 0.0 and 1.0
*/
* @privilege %http://developer.samsung.com/privilege/core/dynamicbox.viewer
* @return void *
* @retval address Address of a FB
- * @retval NULL If it fails to get fb address
+ * @retval @c NULL If it fails to get fb address
*/
extern void *livebox_acquire_fb(struct livebox *handler);
* @privlevel platform
* @privilege %http://developer.samsung.com/privilege/core/dynamicbox.viewer
* @return int
- * @retval LB_STATUS_ERROR_INVALID Invalid argument
- * @retval LB_STATUS_SUCCESS Successfully done
- * @see livebox_acquire_fb
+ * @retval #LB_STATUS_ERROR_INVALID Invalid argument
+ * @retval #LB_STATUS_SUCCESS Successfully done
+ * @see livebox_acquire_fb()
*/
extern int livebox_release_fb(void *buffer);
* @param[in] buffer Buffer
* @privlevel N/P
* @return int
- * @retval LB_STATUS_ERROR_INVALID Invalid argument
- * @retval LB_STATUS_ERROR_FAULT Unrecoverable error occurred
+ * @retval #LB_STATUS_ERROR_INVALID Invalid argument
+ * @retval #LB_STATUS_ERROR_FAULT Unrecoverable error occurred
* @retval refcnt Positive integer including ZERO
- * @see livebox_pdfb_refcnt
+ * @see livebox_pdfb_refcnt()
*/
extern int livebox_fb_refcnt(void *buffer);
* @privlevel platform
* @privilege %http://developer.samsung.com/privilege/core/dynamicbox.viewer
* @return int
- * @retval NULL
+ * @retval @c NULL
* @retval adress Address of a buffer of PD
- * @see livebox_release_pdfb
+ * @see livebox_release_pdfb()
*/
extern void *livebox_acquire_pdfb(struct livebox *handler);
* @privlevel platform
* @privilege %http://developer.samsung.com/privilege/core/dynamicbox.viewer
* @return int
- * @retval LB_STATUS_ERROR_INVALID Invalid argument
- * @retval LB_STATUS_SUCCESS Successfully done
- * @see livebox_acquire_pdfb
+ * @retval #LB_STATUS_ERROR_INVALID Invalid argument
+ * @retval #LB_STATUS_SUCCESS Successfully done
+ * @see livebox_acquire_pdfb()
*/
extern int livebox_release_pdfb(void *buffer);
* @param[in] buffer Buffer
* @privlevel N/P
* @return int
- * @retval LB_STATUS_ERROR_INVALID Invalid argument
- * @retval LB_STATUS_ERROR_FAULT Unrecoverable error occurred
+ * @retval #LB_STATUS_ERROR_INVALID Invalid argument
+ * @retval #LB_STATUS_ERROR_FAULT Unrecoverable error occurred
* @retval reference Reference count
- * @see livebox_fb_refcnt
+ * @see livebox_fb_refcnt()
*/
extern int livebox_pdfb_refcnt(void *buffer);
* @param[in] handler Handler of a livebox instance
* @privlevel N/P
* @return int
- * @retval LB_SIZE_TYPE_NxM
- * @retval LB_SIZE_TYPE_INVALID
+ * @retval #LB_SIZE_TYPE_NxM
+ * @retval #LB_SIZE_TYPE_INVALID
*/
extern int livebox_size(struct livebox *handler);
* @param[out] h
* @privlevel N/P
* @return int type
- * @retval LB_STATUS_ERROR_INVALID Invalid argument
- * @retval LB_STATUS_SUCCESS Successfully done
+ * @retval #LB_STATUS_ERROR_INVALID Invalid argument
+ * @retval #LB_STATUS_SUCCESS Successfully done
*/
extern int livebox_get_pdsize(struct livebox *handler, int *w, int *h);
* @param[out] size_list
* @privlevel N/P
* @return int type
- * @retval LB_STATUS_ERROR_INVALID Invalid argument
- * @retval LB_STATUS_SUCCESS Successfully done
+ * @retval #LB_STATUS_ERROR_INVALID Invalid argument
+ * @retval #LB_STATUS_SUCCESS Successfully done
*/
extern int livebox_get_supported_sizes(struct livebox *handler, int *cnt, int *size_list);
* @param[in] handler Handler of a livebox instance
* @privlevel N/P
* @return int
- * @retval LB_STATUS_ERROR_INVALID Invalid argument
+ * @retval #LB_STATUS_ERROR_INVALID Invalid argument
* @retval size Size of livebox buffer
*/
extern int livebox_lbfb_bufsz(struct livebox *handler);
* @param[in] handler Handler of a livebox instance
* @privlevel N/P
* @return int
- * @retval LB_STATUS_ERROR_INVALID Invalid argument
+ * @retval #LB_STATUS_ERROR_INVALID Invalid argument
* @retval size Size of PD buffer
*/
extern int livebox_pdfb_bufsz(struct livebox *handler);
* @privlevel platform
* @privilege %http://developer.samsung.com/privilege/core/dynamicbox.viewer
* @return int
- * @retval LB_STATUS_ERROR_INVALID Invalid argument
- * @retval LB_STATUS_ERROR_BUSY Previous operaion is not finished yet
- * @retval LB_STATUS_ERROR_FAULT Unrecoverable error occurred
- * @retval LB_STATUS_SUCCESS Successfully sent
- * @see livebox_mouse_event
- * @see livebox_access_event
- * @see livebox_key_event
+ * @retval #LB_STATUS_ERROR_INVALID Invalid argument
+ * @retval #LB_STATUS_ERROR_BUSY Previous operaion is not finished yet
+ * @retval #LB_STATUS_ERROR_FAULT Unrecoverable error occurred
+ * @retval #LB_STATUS_SUCCESS Successfully sent
+ * @see livebox_mouse_event()
+ * @see livebox_access_event()
+ * @see livebox_key_event()
*/
extern int livebox_content_event(struct livebox *handler, enum content_event_type type, double x, double y);
* @privlevel platform
* @privilege %http://developer.samsung.com/privilege/core/dynamicbox.viewer
* @return int
- * @retval LB_STATUS_ERROR_INVALID Invalid argument
- * @retval LB_STATUS_ERROR_BUSY Previous operation is not finished yet
- * @retval LB_STATUS_ERROR_FAULT Unrecoverable error occurred
- * @retval LB_STATUS_SUCCESS Successfully sent
- * @see livebox_content_event
- * @see livebox_access_event
- * @see livebox_key_event
+ * @retval #LB_STATUS_ERROR_INVALID Invalid argument
+ * @retval #LB_STATUS_ERROR_BUSY Previous operation is not finished yet
+ * @retval #LB_STATUS_ERROR_FAULT Unrecoverable error occurred
+ * @retval #LB_STATUS_SUCCESS Successfully sent
+ * @see livebox_content_event()
+ * @see livebox_access_event()
+ * @see livebox_key_event()
*/
extern int livebox_mouse_event(struct livebox *handler, enum content_event_type type, double x, double y);
* @privlevel platform
* @privilege %http://developer.samsung.com/privilege/core/dynamicbox.viewer
* @return int
- * @retval LB_STATUS_ERROR_INVALID Invalid argument
- * @retval LB_STATUS_ERROR_BUSY Previous operation is not finished yet
- * @retval LB_STATUS_ERROR_FAULT Unrecoverable error occurred
- * @retval LB_STATUS_SUCCESS Successfully sent
- * @see livebox_mouse_event
- * @see livebox_key_event
+ * @retval #LB_STATUS_ERROR_INVALID Invalid argument
+ * @retval #LB_STATUS_ERROR_BUSY Previous operation is not finished yet
+ * @retval #LB_STATUS_ERROR_FAULT Unrecoverable error occurred
+ * @retval #LB_STATUS_SUCCESS Successfully sent
+ * @see livebox_mouse_event()
+ * @see livebox_key_event()
*/
extern int livebox_access_event(struct livebox *handler, enum access_event_type type, double x, double y, ret_cb_t cb, void *data);
* @privlevel platform
* @privilege %http://developer.samsung.com/privilege/core/dynamicbox.viewer
* @return int
- * @retval LB_STATUS_ERROR_INVALID Invalid argument
- * @retval LB_STATUS_ERROR_BUSY Previous operation is not finished yet
- * @retval LB_STATUS_ERROR_FAULT Unrecoverable error occurred
- * @retval LB_STATUS_SUCCESS Successfully sent
- * @see livebox_mouse_event
- * @see livebox_access_event
+ * @retval #LB_STATUS_ERROR_INVALID Invalid argument
+ * @retval #LB_STATUS_ERROR_BUSY Previous operation is not finished yet
+ * @retval #LB_STATUS_ERROR_FAULT Unrecoverable error occurred
+ * @retval #LB_STATUS_SUCCESS Successfully sent
+ * @see livebox_mouse_event()
+ * @see livebox_access_event()
*/
extern int livebox_key_event(struct livebox *handler, enum content_event_type type, unsigned int keycode, ret_cb_t cb, void *data);
* @privlevel platform
* @privilege %http://developer.samsung.com/privilege/core/dynamicbox.viewer
* @return int
- * @retval LB_STATUS_ERROR_INVALID Invalid parameters
+ * @retval #LB_STATUS_ERROR_INVALID Invalid parameters
* @see ret_cb_t
- * @see livebox_set_visibility
- * @see livebox_is_pinned_up
+ * @see livebox_set_visibility()
+ * @see livebox_is_pinned_up()
*/
extern int livebox_set_pinup(struct livebox *handler, int flag, ret_cb_t cb, void *data);
* @param[in] handler Handler of a livebox instance
* @privlevel N/P
* @return int
- * @retval LB_STATUS_ERROR_INVALID Invalid parameters
+ * @retval #LB_STATUS_ERROR_INVALID Invalid parameters
* @retval 1 Box is pinned up
* @retval 0 Box is not pinned up
- * @see livebox_set_pinup
+ * @see livebox_set_pinup()
*/
extern int livebox_is_pinned_up(struct livebox *handler);
* @param[in] handler Handler of a livebox instance
* @privlevel N/P
* @return int
- * @retval LB_STATUS_ERROR_INVALID Invalid argument
+ * @retval #LB_STATUS_ERROR_INVALID Invalid argument
* @retval 1 If the box support Pinup feature
* @retval 0 If the box does not support the Pinup feature
- * @see livebox_is_pinned_up
- * @see livebox_set_pinup
+ * @see livebox_is_pinned_up()
+ * @see livebox_set_pinup()
*/
extern int livebox_has_pinup(struct livebox *handler);
* @param[in] handler Handler of a livebox instance
* @privlevel N/P
* @return int
- * @retval LB_STATUS_ERROR_INVALID Invalid argument
+ * @retval #LB_STATUS_ERROR_INVALID Invalid argument
* @retval 1 If the box support the PD
* @retval 0 If the box has no PD
*/
* @privlevel platform
* @privilege %http://developer.samsung.com/privilege/core/dynamicbox.viewer
* @return int
- * @retval LB_STATUS_SUCCESS Successfully done
- * @retval LB_STATUS_ERROR_INVALID Invalid argument
- * @retval LB_STATUS_ERROR_BUSY Previous operation is not finished yet
- * @retval LB_STATUS_ERROR_FAULT Unrecoverable error occurred
+ * @retval #LB_STATUS_SUCCESS Successfully done
+ * @retval #LB_STATUS_ERROR_INVALID Invalid argument
+ * @retval #LB_STATUS_ERROR_BUSY Previous operation is not finished yet
+ * @retval #LB_STATUS_ERROR_FAULT Unrecoverable error occurred
* @see ret_cb_t
- * @see livebox_create_pd_with_position
- * @see livebox_move_pd
- * @see livebox_destroy_pd
+ * @see livebox_create_pd_with_position()
+ * @see livebox_move_pd()
+ * @see livebox_destroy_pd()
*/
extern int livebox_create_pd(struct livebox *handler, ret_cb_t cb, void *data);
* @privlevel platform
* @privilege %http://developer.samsung.com/privilege/core/dynamicbox.viewer
* @return int
- * @retval LB_STATUS_SUCCESS Successfully done
- * @retval LB_STATUS_ERROR_INVALID Invalid argument
- * @retval LB_STATUS_ERROR_BUSY Previous operation is not finished yet
- * @retval LB_STATUS_ERROR_FAULT Unrecoverable error occurred
- * @see livebox_create_pd
- * @see livebox_destroy_pd
- * @see livebox_move_pd
+ * @retval #LB_STATUS_SUCCESS Successfully done
+ * @retval #LB_STATUS_ERROR_INVALID Invalid argument
+ * @retval #LB_STATUS_ERROR_BUSY Previous operation is not finished yet
+ * @retval #LB_STATUS_ERROR_FAULT Unrecoverable error occurred
+ * @see livebox_create_pd()
+ * @see livebox_destroy_pd()
+ * @see livebox_move_pd()
*/
extern int livebox_create_pd_with_position(struct livebox *handler, double x, double y, ret_cb_t cb, void *data);
* @privlevel platform
* @privilege %http://developer.samsung.com/privilege/core/dynamicbox.viewer
* @return int
- * @retval LB_STATUS_SUCCESS If sending a request for updating position of the PD has been done successfully
- * @retval LB_STATUS_ERROR_FAULT Unrecoverable error occurred
- * @retval LB_STATUS_ERROR_INVALID Invalid argument
+ * @retval #LB_STATUS_SUCCESS If sending a request for updating position of the PD has been done successfully
+ * @retval #LB_STATUS_ERROR_FAULT Unrecoverable error occurred
+ * @retval #LB_STATUS_ERROR_INVALID Invalid argument
*/
extern int livebox_move_pd(struct livebox *handler, double x, double y);
* @privlevel platform
* @privilege %http://developer.samsung.com/privilege/core/dynamicbox.viewer
* @return int
- * @retval LB_STATUS_ERROR_INVALID Invalid argument
- * @retval LB_STATUS_ERROR_FAULT Unrecoverable error occurred
- * @retval LB_STATUS_SUCCESS Successfully done
+ * @retval #LB_STATUS_ERROR_INVALID Invalid argument
+ * @retval #LB_STATUS_ERROR_FAULT Unrecoverable error occurred
+ * @retval #LB_STATUS_SUCCESS Successfully done
* @see ret_cb_t
*/
extern int livebox_destroy_pd(struct livebox *handler, ret_cb_t cb, void *data);
* @param[in] handler Handler of a livebox instance
* @privlevel N/P
* @return int
- * @retval LB_STATUS_ERROR_INVALID Invalid argument
+ * @retval #LB_STATUS_ERROR_INVALID Invalid argument
* @retval 0 PD is not created
* @retval 1 PD is created
*/
* @param[in] handler Handler of a livebox instance
* @privlevel N/P
* @return int
- * @retval PD_TYPE_BUFFER Contents of a PD is based on canvas buffer(shared)
- * @retval PD_TYPE_TEXT Contents of a PD is based on formatted text file
- * @retval PD_TYPE_PIXMAP Contents of a livebox is shared by the pixmap(depends on X)
- * @retval PD_TYPE_INVALID
- * @see livebox_pd_type
+ * @retval #PD_TYPE_BUFFER Contents of a PD is based on canvas buffer(shared)
+ * @retval #PD_TYPE_TEXT Contents of a PD is based on formatted text file
+ * @retval #PD_TYPE_PIXMAP Contents of a livebox is shared by the pixmap(depends on X)
+ * @retval #PD_TYPE_INVALID
+ * @see livebox_pd_type()
*/
extern enum livebox_pd_type livebox_pd_type(struct livebox *handler);
* @brief Checks the existence of a livebox about the given package name.
* @param[in] pkgname Package name
* @privlevel platform
- * @privileve %http://developer.samsung.com/privilege/dynamicbox.info
+ * @privileve %http://developer.samsung.com/privilege/core/dynamicbox.info
* @return int
* @retval 1 If the box exists
* @retval 0 If the box does not exist
* @param[in] ops
* @privlevel N/P
* @return int
- * @retval LB_STATUS_SUCCESS Successfully done
- * @retval LB_STATUS_ERROR_INVALID Invalid argument
- * @see livebox_set_pd_text_handler
+ * @retval #LB_STATUS_SUCCESS Successfully done
+ * @retval #LB_STATUS_ERROR_INVALID Invalid argument
+ * @see livebox_set_pd_text_handler()
*/
extern int livebox_set_text_handler(struct livebox *handler, struct livebox_script_operators *ops);
* @param[in] ops
* @privlevel N/P
* @return int
- * @retval LB_STATUS_SUCCESS Successfully done
- * @retval LB_STATUS_ERROR_INVALID Invalid argument
- * @see livebox_set_text_handler
+ * @retval #LB_STATUS_SUCCESS Successfully done
+ * @retval #LB_STATUS_ERROR_INVALID Invalid argument
+ * @see livebox_set_text_handler()
*/
extern int livebox_set_pd_text_handler(struct livebox *handler, struct livebox_script_operators *ops);
* @param[in] cb Result callback
* @param[in] data Callback data
* @privlevel platform
- * @privileve %http://developer.samsung.com/privilege/dynamicbox.viewer
+ * @privileve %http://developer.samsung.com/privilege/core/dynamicbox.viewer
* @return int
- * @retval LB_STATUS_ERROR_INVALID Invalid parameters
- * @retval LB_STATUS_ERROR_FAULT Unrecoverable error occurred
- * @retval LB_STATUS_SUCCESS Successfully emitted
+ * @retval #LB_STATUS_ERROR_INVALID Invalid parameters
+ * @retval #LB_STATUS_ERROR_FAULT Unrecoverable error occurred
+ * @retval #LB_STATUS_SUCCESS Successfully emitted
* @see ret_cb_t
*/
extern int livebox_emit_text_signal(struct livebox *handler, const char *emission, const char *source, double sx, double sy, double ex, double ey, ret_cb_t cb, void *data);
* @param[in] data Data pointer
* @privlevel N/P
* @return int
- * @retval LB_STATUS_SUCCESS Successfully registered
- * @retval LB_STATUS_ERROR_INVALID Invalid argument
- * @see livebox_get_data
+ * @retval #LB_STATUS_SUCCESS Successfully registered
+ * @retval #LB_STATUS_ERROR_INVALID Invalid argument
+ * @see livebox_get_data()
*/
extern int livebox_set_data(struct livebox *handler, void *data);
* @privlevel N/P
* @return void *
* @retval data Data pointer
- * @retval NULL If there is no data
- * @see livebox_set_data
+ * @retval @c NULL If there is no data
+ * @see livebox_set_data()
*/
extern void *livebox_get_data(struct livebox *handler);
* @param[in] cluster Cluster ("*" can be used for subscribe all cluster's liveboxes event; If you use the "*", value in the category will be ignored)
* @param[in] category Category ("*" can be used for subscribe liveboxes events of all category(sub-cluster) in a given "cluster")
* @privlevel platform
- * @privileve %http://developer.samsung.com/privilege/dynamicbox.viewer
+ * @privileve %http://developer.samsung.com/privilege/core/dynamicbox.viewer
* @return int
- * @retval LB_STATUS_ERROR_FAULT Unrecoverable error occurred
- * @retval LB_STATUS_SUCCESS Successfully requested
- * @see livebox_unsubscribe_group
+ * @retval #LB_STATUS_ERROR_FAULT Unrecoverable error occurred
+ * @retval #LB_STATUS_SUCCESS Successfully requested
+ * @see livebox_unsubscribe_group()
*/
extern int livebox_subscribe_group(const char *cluster, const char *category);
* @param[in] cluster Cluster("*" can be used for subscribe all cluster's liveboxes event; If you use the "*", value in the category will be ignored)
* @param[in] category Category ("*" can be used for subscribe all sub-cluster's liveboxes event in a given "cluster")
* @privlevel platform
- * @privileve %http://developer.samsung.com/privilege/dynamicbox.viewer
+ * @privileve %http://developer.samsung.com/privilege/core/dynamicbox.viewer
* @return int
- * @retval LB_STATUS_ERROR_FAULT Unrecoverable error occurred
- * @retval LB_STATUS_SUCCESS Successfully requested
- * @see livebox_subscribe_group
+ * @retval #LB_STATUS_ERROR_FAULT Unrecoverable error occurred
+ * @retval #LB_STATUS_SUCCESS Successfully requested
+ * @see livebox_subscribe_group()
*/
extern int livebox_unsubscribe_group(const char *cluster, const char *category);
* @param[in] category Sub-cluster ID
* @param[in] force 1 if the boxes should be updated even if they are paused
* @privlevel platform
- * @privileve %http://developer.samsung.com/privilege/dynamicbox.viewer
+ * @privileve %http://developer.samsung.com/privilege/core/dynamicbox.viewer
* @return int
- * @retval LB_STATUS_ERROR_INVALID Invalid argument
- * @retval LB_STATUS_ERROR_FAULT Unrecoverable error occurred
- * @retval LB_STATUS_SUCCESS Successfully requested
- * @see livebox_refresh
+ * @retval #LB_STATUS_ERROR_INVALID Invalid argument
+ * @retval #LB_STATUS_ERROR_FAULT Unrecoverable error occurred
+ * @retval #LB_STATUS_SUCCESS Successfully requested
+ * @see livebox_refresh()
*/
extern int livebox_refresh_group(const char *cluster, const char *category, int force);
* @param[in] handler Handler of a livebox instance
* @param[in] force 1 if the box should be updated even if it is paused
* @privlevel platform
- * @privileve %http://developer.samsung.com/privilege/dynamicbox.viewer
+ * @privileve %http://developer.samsung.com/privilege/core/dynamicbox.viewer
* @return int
- * @retval LB_STATUS_ERROR_INVALID Invalid argument
- * @retval LB_STATUS_ERROR_FAULT Unrecoverable error occurred
- * @retval LB_STATUS_SUCCESS Successfully requested
- * @see livebox_refresh_group
+ * @retval #LB_STATUS_ERROR_INVALID Invalid argument
+ * @retval #LB_STATUS_ERROR_FAULT Unrecoverable error occurred
+ * @retval #LB_STATUS_SUCCESS Successfully requested
+ * @see livebox_refresh_group()
*/
extern int livebox_refresh(struct livebox *handler, int force);
* @return int
* @retval 0 If the pixmap is not created
* @retval pixmap Pixmap Id need to be casted to (unsigned int) type
- * @see livebox_pd_pixmap
+ * @see livebox_pd_pixmap()
*/
extern int livebox_lb_pixmap(const struct livebox *handler);
* @return int
* @retval 0 If the pixmap is not created
* @retval pixmap Pixmap Id need to be casted to (unsigned int) type
- * @see livebox_lb_pixmap
+ * @see livebox_lb_pixmap()
*/
extern int livebox_pd_pixmap(const struct livebox *handler);
* @param[in] cb Result callback for acquiring request
* @param[in] data Callback Data
* @privlevel platform
- * @privileve %http://developer.samsung.com/privilege/dynamicbox.viewer
+ * @privileve %http://developer.samsung.com/privilege/core/dynamicbox.viewer
* @return int
- * @retval LB_STATUS_ERROR_INVALID Invalid argument
- * @retval LB_STATUS_ERROR_FAULT Failed to send a request to the service provider or there is critical error that is unrecoverable
- * @retval LB_STATUS_SUCCESS Successfully requested to acquire the pixmap of PD
- * @see livebox_release_pd_pixmap
- * @see livebox_acquire_lb_pixmap
+ * @retval #LB_STATUS_ERROR_INVALID Invalid argument
+ * @retval #LB_STATUS_ERROR_FAULT Failed to send a request to the service provider or there is critical error that is unrecoverable
+ * @retval #LB_STATUS_SUCCESS Successfully requested to acquire the pixmap of PD
+ * @see livebox_release_pd_pixmap()
+ * @see livebox_acquire_lb_pixmap()
* @see ret_cb_t
*/
extern int livebox_acquire_pd_pixmap(struct livebox *handler, ret_cb_t cb, void *data);
* @param[in] handler Handler of a livebox instance
* @param[in] pixmap Pixmap Id to release it
* @privlevel platform
- * @privileve %http://developer.samsung.com/privilege/dynamicbox.viewer
+ * @privileve %http://developer.samsung.com/privilege/core/dynamicbox.viewer
* @return int
- * @retval LB_STATUS_ERROR_INVALID Invalid argument
- * @retval LB_STATUS_ERROR_FAULT Unrecoverable error occurred
- * @retval LB_STATUS_SUCCESS Successfully released (request is sent)
- * @see livebox_acquire_pd_pixmap
- * @see livebox_release_lb_pixmap
+ * @retval #LB_STATUS_ERROR_INVALID Invalid argument
+ * @retval #LB_STATUS_ERROR_FAULT Unrecoverable error occurred
+ * @retval #LB_STATUS_SUCCESS Successfully released (request is sent)
+ * @see livebox_acquire_pd_pixmap()
+ * @see livebox_release_lb_pixmap()
*/
extern int livebox_release_pd_pixmap(struct livebox *handler, int pixmap);
* @param[in] cb Callback function which will be called with result of acquiring lb pixmap
* @param[in] data Callback data
* @privlevel platform
- * @privileve %http://developer.samsung.com/privilege/dynamicbox.viewer
+ * @privileve %http://developer.samsung.com/privilege/core/dynamicbox.viewer
* @return int
- * @retval LB_STATUS_ERROR_INVALID Invalid argument
- * @retval LB_STATUS_ERROR_FAULT Unrecoverable error occurred
- * @retval LB_STATUS_SUCCESS Successfully requested
+ * @retval #LB_STATUS_ERROR_INVALID Invalid argument
+ * @retval #LB_STATUS_ERROR_FAULT Unrecoverable error occurred
+ * @retval #LB_STATUS_SUCCESS Successfully requested
* @pre Livebox service system should support the PIXMAP type buffer.
* The livebox should be designed to use the buffer (script type).
- * @see livebox_release_lb_pixmap
- * @see livebox_acquire_pd_pixmap
+ * @see livebox_release_lb_pixmap()
+ * @see livebox_acquire_pd_pixmap()
* @see ret_cb_t
*/
extern int livebox_acquire_lb_pixmap(struct livebox *handler, ret_cb_t cb, void *data);
* @param[in] handler Handler of a livebox instance
* @param[in] pixmap Pixmap Id of given livebox handler
* @privlevel platform
- * @privileve %http://developer.samsung.com/privilege/dynamicbox.viewer
+ * @privileve %http://developer.samsung.com/privilege/core/dynamicbox.viewer
* @return int
- * @retval LB_STATUS_ERROR_INVALID Invalid argument
- * @retval LB_STATUS_ERROR_FAULT Unrecoverable error occurred
- * @retval LB_STATUS_SUCCESS Successfully done
+ * @retval #LB_STATUS_ERROR_INVALID Invalid argument
+ * @retval #LB_STATUS_ERROR_FAULT Unrecoverable error occurred
+ * @retval #LB_STATUS_SUCCESS Successfully done
* @pre The pixmap should be acquired by livebox_acquire_lb_pixmap
- * @see livebox_acquire_lb_pixmap
- * @see livebox_release_pd_pixmap
+ * @see livebox_acquire_lb_pixmap()
+ * @see livebox_release_pd_pixmap()
*/
extern int livebox_release_lb_pixmap(struct livebox *handler, int pixmap);
* @param[in] handler Handler of a livebox instance
* @param[in] state Configure the current visible state of a livebox
* @privlevel platform
- * @privileve %http://developer.samsung.com/privilege/dynamicbox.viewer
+ * @privileve %http://developer.samsung.com/privilege/core/dynamicbox.viewer
* @return int
- * @retval LB_STATUS_ERROR_INVALID Invalid argument
- * @retval LB_STATUS_ERROR_BUSY
- * @retval LB_STATUS_ERROR_PERMISSION
- * @retval LB_STATUS_ERROR_ALREADY
- * @retval LB_STATUS_ERROR_FAULT Unrecoverable error occurred
- * @retval LB_STATUS_SUCCESS Successfully done
+ * @retval #LB_STATUS_ERROR_INVALID Invalid argument
+ * @retval #LB_STATUS_ERROR_BUSY
+ * @retval #LB_STATUS_ERROR_PERMISSION
+ * @retval #LB_STATUS_ERROR_ALREADY
+ * @retval #LB_STATUS_ERROR_FAULT Unrecoverable error occurred
+ * @retval #LB_STATUS_SUCCESS Successfully done
*/
extern int livebox_set_visibility(struct livebox *handler, enum livebox_visible_state state);
* @param[in] handler Handler of a livebox instance
* @privlevel N/P
* @return livebox_visible_state
- * @retval LB_SHOW Livebox is shown (Default state)
- * @retval LB_HIDE Livebox is hidden, Update timer is not frozen (but a user cannot receive any updated events; a user should refresh(reload) the content of a livebox when a user make this show again)
- * @retval LB_HIDE_WITH_PAUSE Livebox is hidden, it will pause the update timer, but if a livebox updates its contents, update event will occur
- * @retval LB_VISIBLE_ERROR To enlarge the size of this enumeration type
+ * @retval #LB_SHOW Livebox is shown (Default state)
+ * @retval #LB_HIDE Livebox is hidden, Update timer is not frozen (but a user cannot receive any updated events; a user should refresh(reload) the content of a livebox when a user make this show again)
+ * @retval #LB_HIDE_WITH_PAUSE Livebox is hidden, it will pause the update timer, but if a livebox updates its contents, update event will occur
+ * @retval #LB_VISIBLE_ERROR To enlarge the size of this enumeration type
*/
extern enum livebox_visible_state livebox_visibility(struct livebox *handler);
* @param[in] cb Result callback function
* @param[in] data Callback data
* @privlevel platform
- * @privileve %http://developer.samsung.com/privilege/dynamicbox.viewer
+ * @privileve %http://developer.samsung.com/privilege/core/dynamicbox.viewer
* @return int
- * @retval LB_STATUS_ERROR_INVALID Invalid argument
- * @retval LB_STATUS_ERROR_BUSY
- * @retval LB_STATUS_ERROR_PERMISSION
- * @retval LB_STATUS_ERROR_ALREADY
- * @retval LB_STATUS_ERROR_FAULT Unrecoverable error occurred
- * @retval LB_STATUS_SUCCESS Successfully done
+ * @retval #LB_STATUS_ERROR_INVALID Invalid argument
+ * @retval #LB_STATUS_ERROR_BUSY
+ * @retval #LB_STATUS_ERROR_PERMISSION
+ * @retval #LB_STATUS_ERROR_ALREADY
+ * @retval #LB_STATUS_ERROR_FAULT Unrecoverable error occurred
+ * @retval #LB_STATUS_SUCCESS Successfully done
* @see ret_cb_t
*/
extern int livebox_set_update_mode(struct livebox *handler, int active_update, ret_cb_t cb, void *data);
* @brief Syncs manually
* param[in] handler Handler of a livebox instance
* @privlevel platform
- * @privileve %http://developer.samsung.com/privilege/dynamicbox.viewer
+ * @privileve %http://developer.samsung.com/privilege/core/dynamicbox.viewer
* @return void
- * @retval LB_STATUS_SUCCESS If success
- * @retval LB_STATUS_ERROR_INVALID Invalid handle
- * @see livebox_set_manual_sync
- * @see livebox_manual_sync
- * @see livebox_sync_lb_fb
+ * @retval #LB_STATUS_SUCCESS If success
+ * @retval #LB_STATUS_ERROR_INVALID Invalid handle
+ * @see livebox_set_manual_sync()
+ * @see livebox_manual_sync()
+ * @see livebox_sync_lb_fb()
*/
extern int livebox_sync_pd_fb(struct livebox *handler);
* @brief Syncs manually
* @param[in] handler Handler of a livebox instance
* @privlevel platform
- * @privileve %http://developer.samsung.com/privilege/dynamicbox.viewer
+ * @privileve %http://developer.samsung.com/privilege/core/dynamicbox.viewer
* @return void
- * @retval LB_STATUS_SUCCESS If success
- * @retval LB_STATUS_ERROR_INVALID Invalid handle
- * @see livebox_set_manual_sync
- * @see livebox_manual_sync
- * @see livebox_sync_pd_fb
+ * @retval #LB_STATUS_SUCCESS If success
+ * @retval #LB_STATUS_ERROR_INVALID Invalid handle
+ * @see livebox_set_manual_sync()
+ * @see livebox_manual_sync()
+ * @see livebox_sync_pd_fb()
*/
extern int livebox_sync_lb_fb(struct livebox *handler);
* @privlevel N/P
* @return const char *
* @retval address Absolute path of an alternative icon file
- * @retval NULL Livebox has no alternative icon file
- * @see livebox_alt_name
+ * @retval @c NULL Livebox has no alternative icon file
+ * @see livebox_alt_name()
*/
extern const char *livebox_alt_icon(struct livebox *handler);
* @privlevel N/P
* @return const char *
* @retval name Alternative name of a livebox
- * @retval NULL Livebox has no alternative name
- * @see livebox_alt_icon
+ * @retval @c NULL Livebox has no alternative name
+ * @see livebox_alt_icon()
*/
extern const char *livebox_alt_name(struct livebox *handler);
* @param[in] handler Handler of a livebox instance
* @param[in] is_pd 1 for PD or 0
* @privlevel platform
- * @privileve %http://developer.samsung.com/privilege/dynamicbox.viewer
+ * @privileve %http://developer.samsung.com/privilege/core/dynamicbox.viewer
* @return int
- * @retval LB_STATUS_ERROR_FAULT Unrecoverable error occurred
- * @retval LB_STATUS_ERROR_INVALID Invalid argument
- * @retval LB_STATUS_SUCCESS Successfully done
- * @see livebox_release_fb_lock
+ * @retval #LB_STATUS_ERROR_FAULT Unrecoverable error occurred
+ * @retval #LB_STATUS_ERROR_INVALID Invalid argument
+ * @retval #LB_STATUS_SUCCESS Successfully done
+ * @see livebox_release_fb_lock()
*/
extern int livebox_acquire_fb_lock(struct livebox *handler, int is_pd);
* @param[in] handler Handler of a livebox instance
* @param[in] is_pd 1 for PD or 0
* @privlevel platform
- * @privileve %http://developer.samsung.com/privilege/dynamicbox.viewer
+ * @privileve %http://developer.samsung.com/privilege/core/dynamicbox.viewer
* @return int
- * @retval LB_STATUS_ERROR_FAULT Unrecoverable error occurred
- * @retval LB_STATUS_ERROR_INVALID Invalid argument
- * @retval LB_STATUS_SUCCESS Successfully done
- * @see livebox_acquire_fb_lock
+ * @retval #LB_STATUS_ERROR_FAULT Unrecoverable error occurred
+ * @retval #LB_STATUS_ERROR_INVALID Invalid argument
+ * @retval #LB_STATUS_SUCCESS Successfully done
+ * @see livebox_acquire_fb_lock()
*/
extern int livebox_release_fb_lock(struct livebox *handler, int is_pd);
* @param[in] state New value for given option
* @privlevel N/P
* @return int
- * @retval LB_STATUS_ERROR_INVALID Unknown option
- * @retval LB_STATUS_ERROR_FAULT Failed to change the state of option
- * @retval LB_STATUS_SUCCESS Successfully changed
- * @see livebox_get_option
- * @see livebox_sync_pd_fb
- * @see livebox_sync_lb_fb
+ * @retval #LB_STATUS_ERROR_INVALID Unknown option
+ * @retval #LB_STATUS_ERROR_FAULT Failed to change the state of option
+ * @retval #LB_STATUS_SUCCESS Successfully changed
+ * @see livebox_get_option()
+ * @see livebox_sync_pd_fb()
+ * @see livebox_sync_lb_fb()
*/
extern int livebox_set_option(enum livebox_option_type option, int state);
* @param[in] option Type of option
* @privlevel N/P
* @return int
- * @retval LB_STATUS_ERROR_INVALID Invalid option
- * @retval LB_STATUS_ERROR_FAULT Failed to get option
+ * @retval #LB_STATUS_ERROR_INVALID Invalid option
+ * @retval #LB_STATUS_ERROR_FAULT Failed to get option
* @retval >=0 Value of given option (must be >=0)
- * @see livebox_set_option
+ * @see livebox_set_option()
*/
extern int livebox_option(enum livebox_option_type option);
* @param[in] data Callback data which will be given a data for launch_handler
* @privlevel N/P
* @return int type
- * @retval LB_STATUS_SUCCESS Succeed to set new handler. there is no other cases
+ * @retval #LB_STATUS_SUCCESS Succeed to set new handler. there is no other cases
*/
extern int livebox_set_auto_launch_handler(int (*launch_handler)(struct livebox *handler, const char *appid, void *data), void *data);