From daefc71ec726b3757dd81ef37e50d72abd420a49 Mon Sep 17 00:00:00 2001 From: Sung-jae Park Date: Sat, 14 Jun 2014 19:03:48 +0900 Subject: [PATCH] Update doxygen Change-Id: Id4e1e9781e6e31968e176f0365ea1dbd2a866c21 --- include/livebox.h | 984 +++++++++++++++++++++++------------------------------- 1 file changed, 418 insertions(+), 566 deletions(-) diff --git a/include/livebox.h b/include/livebox.h index 60532e9..805662d 100644 --- a/include/livebox.h +++ b/include/livebox.h @@ -24,764 +24,616 @@ extern "C" { #include /** - * \addtogroup CAPI_LIVEBOX_HELPER_MODULE - * \{ + * @file livebox.h + * @brief This file declares API of liblivebox library */ -/*! - * \brief Defined by provider +/** + * @addtogroup CAPI_LIVEBOX_HELPER_MODULE + * @{ */ -struct livebox_buffer; -/*! - * \brief - * Return values of livebox programming interfaces. - */ -/*! - * \brief - * Operation is successfully done +/** + * @brief Structure for a livebox buffer defined by a provider. */ -extern const int DONE; +struct livebox_buffer; -/*! - * \brief - * Contents is updated - */ -extern const int OUTPUT_UPDATED; +extern const int DONE;/**=0) of added block, which can be used by livebox_desc_set_id - * \pre Must be called after create a handle using livebox_desc_open. - * \post N/A - * \see livebox_desc_set_id +/** + * @brief Sets the category information of current description data. + * @details Creates a new description block for updating category information of layout object. + * @param[in] handle Handle which is created by livebox_desc_open function + * @param[in] id Id string of target object + * @param[in] category Category string that will be used by layout object + * @return int type + * @retval LB_STATUS_ERROR_INVALID Invalid handle + * @retval LB_STATUS_ERROR_MEMORY Memory is not enough to add this block + * @retval index Index(>=0) of added block, which can be used by livebox_desc_set_id + * @pre Must be called after create a handle using livebox_desc_open. + * @see livebox_desc_set_id */ extern int livebox_desc_set_category(struct livebox_desc *handle, const char *id, const char *category); -/*! - * \brief - * Set the content size - * \details - * Set the content size of layout - * \remarks N/A - * \param[in] handle Handle which is created by livebox_desc_open function - * \param[in] id Id string of target object. - * \param[in] w Width in pixel - * \param[in] h Height in pixel - * \return int - * \retval LB_STATUS_ERROR_INVALID Invalid argument - * \retval LB_STATUS_ERROR_MEMORY Not enough memory to add a new block - * \retval index Index(>=0) of added block Successfully added - * \pre N/A - * \post N/A - * \see livebox_desc_open - * \see livebox_desc_set_id +/** + * @brief Sets the content size. + * @details Sets the content size of layout. + * @param[in] handle Handle which is created by livebox_desc_open function + * @param[in] id Id string of target object + * @param[in] w Width in pixel + * @param[in] h Height in pixel + * @return int type + * @retval LB_STATUS_ERROR_INVALID Invalid argument + * @retval LB_STATUS_ERROR_MEMORY Not enough memory to add a new block + * @retval index Index(>=0) of added block Successfully added + * @see livebox_desc_open + * @see livebox_desc_set_id */ extern int livebox_desc_set_size(struct livebox_desc *handle, const char *id, int w, int h); -/*! - * \brief - * Set the target id of given block - * Only available for the script block - * \details - * N/A - * \remarks N/A - * \param[in] handle Handle which is created by livebox_desc_open function - * \param[in] idx Index of target block - * \param[in] id Id String which will be used by other livebox_desc_XXX functions - * \return int - * \retval LB_STATUS_SUCCESS Id is successfully updated for given idx of desc block - * \retval LB_STATUS_ERROR_INVALID Invalid argument - * \retval LB_STATUS_ERROR_NOT_EXIST Given index of desc block is not exists - * \pre desc block should be exists which has given index "idx" - * \post specified Id string("id") can be used by other livebox_desc_XXXX functions - * \see livebox_desc_open - * \see livebox_desc_set_id +/** + * @brief Sets the target id of the given block. + * @details Only available for the script block. + * @param[in] handle Handle which is created by livebox_desc_open function + * @param[in] idx Index of target block + * @param[in] id Id String which will be used by other livebox_desc_XXX functions + * @return int type + * @retval LB_STATUS_SUCCESS Id is successfully updated for given idx of desc block + * @retval LB_STATUS_ERROR_INVALID Invalid argument + * @retval LB_STATUS_ERROR_NOT_EXIST Given index of desc block is not exists + * @pre Desc block should be exists which has given index "idx". + * @post Specified Id string("id") can be used by other livebox_desc_XXXX functions. + * @see livebox_desc_open + * @see livebox_desc_set_id */ extern int livebox_desc_set_id(struct livebox_desc *handle, int idx, const char *id); -/*! - * \brief Add a new block - * \details N/A - * \remarks N/A - * \param[in] handle Handle which is created by livebox_desc_open function - * \param[in] id ID of source script object - * \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] option option for the block. (script: group, image: option, ...) - * \return idx Index of current description block - * \retval LB_STATUS_ERROR_INVALID Invalid argument - * \retval LB_STATUS_ERROR_MEMORY Not enough memory to add a new desc block - * \retval Index index(>=0) of added desc block - * \pre handle must be created using livebox_desc_open - * \post N/A - * \see livebox_desc_set_id - * \see livebox_desc_del_block +/** + * @brief Adds a new block. + * @param[in] handle Handle which is created by the livebox_desc_open() function + * @param[in] id ID of source script object + * @param[in] type Type (image|text|script|signal|.. etc) + * @param[in] part Target part to update with given content(data) + * @param[in] data Content for specified part + * @param[in] option Option for the block. (script: group, image: option, ...) + * @return Index of current description block + * @retval LB_STATUS_ERROR_INVALID Invalid argument + * @retval LB_STATUS_ERROR_MEMORY Not enough memory to add a new desc block + * @retval index Index(>=0) of added desc block + * @pre Handle must be created using livebox_desc_open. + * @see livebox_desc_set_id + * @see livebox_desc_del_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 *option); -/*! - * \brief Delete a added block - * \details - * If you discard the added desc block, use this API and the index of created desc block. - * \remarks N/A - * \param[in] handle Handle which is created by livebox_desc_open function - * \param[in] idx Index of added block, returned from livebox_desc_add_block, livebox_desc_set_size, livebox_desc_set_category, ... - * \return int - * \retval LB_STATUS_SUCCESS Successfully deleted - * \retval LB_STATUS_ERROR_NOT_EXIST Given index of desc block is not exists - * \pre index must be exists. - * \post N/A - * \see livebox_desc_add_block - * \see livebox_desc_open +/** + * @brief Deletes an added block. + * @details If you discard the added desc block, use this API and the index of the created desc block. + * @param[in] handle Handle which is created by livebox_desc_open function + * @param[in] idx Index of added block, returned from livebox_desc_add_block, livebox_desc_set_size, livebox_desc_set_category, etc + * @return int type + * @retval LB_STATUS_SUCCESS Successfully deleted + * @retval LB_STATUS_ERROR_NOT_EXIST Given index of desc block is not exists + * @pre Index must be exists. + * @see livebox_desc_add_block + * @see livebox_desc_open */ extern int livebox_desc_del_block(struct livebox_desc *handle, int idx); -/*! - * \brief Notify the updated content to the provider. - * \details - * Forcely notify the updated contents. +/** + * @brief Notifies the updated content to the provider. + * @details Forcedly notifies the updated contents. * This function can be used from async callback function to notify the updated content. - * \remarks N/A - * \param[in] id Instance Id which is passed to you via the first parameter of every livebox_XXXX interface functions. - * \param[in] is_pd 1 for updating content of PD or 0(for content of LB). - * \return int - * \retval LB_STATUS_ERROR_MEMORY Not enough memory - * \retval LB_STATUS_ERROR_INVALID Invalid argument - * \retval LB_STATUS_ERROR_IO I/O failed, Cannot access given resource file(id) - * \retval LB_STATUS_SUCCESS Successfully notified - * \pre This API only can be used after loaded into the data-provider-slave process. - * \post N/A - * \see N/A + * @param[in] id Instance Id which is passed to you via the first parameter of every livebox_XXXX interface functions + * @param[in] is_pd 1 for updating content of PD or 0(for content of LB) + * @return int type + * @retval LB_STATUS_ERROR_MEMORY Not enough memory + * @retval LB_STATUS_ERROR_INVALID Invalid argument + * @retval LB_STATUS_ERROR_IO I/O failed, Cannot access given resource file(id) + * @retval LB_STATUS_SUCCESS Successfully notified + * @pre This API only can be used after loaded into the data-provider-slave process. */ extern int livebox_content_is_updated(const char *id, int is_pd); -/*! - * \brief Replace "\n"(new line character) with <br> - * \details - * This utility function is used to replace all NEW LINE CHARACTER("\n") with <br> tag. - * \remarks N/A - * \param[in] str Source string - * \return char * - * \retval String that is allocted in the heap - * \retval NULL if it fails to replace string - * \pre N/A - * \post Returned string must has to be free'd by user manually. - * \see N/A +/** + * @brief Replaces "\n" (new line character) with <br> tag. + * @details This utility function is used to replace all NEW LINE CHARACTER ("\n") with <br> tag. + * @param[in] str Source string + * @return char * type + * @retval string Allocted in the heap + * @retval NULL If it fails to replace string + * @post Returned string must has to be free'd by user manually. */ extern char *livebox_util_nl2br(const char *str); -/*! - * \brief - * Interfaces for direct buffer management (Available only for the PD area) +/* + * Interfaces for direct buffer management (Available only for the PD area). */ #ifndef __PROVIDER_BUFFER_H -/*! - * \note - * This enumeration value should be sync'd with provider +/** + * @brief Enumeration for value should be sync'd with provider. */ enum buffer_event { - BUFFER_EVENT_ENTER, /*!< Mouse cursor enter */ - BUFFER_EVENT_LEAVE, /*!< Mouse cursor leave */ - BUFFER_EVENT_DOWN, /*!< Mouse down */ - BUFFER_EVENT_MOVE, /*!< Mouse move */ - BUFFER_EVENT_UP, /*!< Mouse up */ - - BUFFER_EVENT_KEY_DOWN, /*!< Key down */ - BUFFER_EVENT_KEY_UP, /*!< Key up */ - BUFFER_EVENT_KEY_FOCUS_IN, /*!< Key focus in */ - BUFFER_EVENT_KEY_FOCUS_OUT, /*!< Key focus out */ - - BUFFER_EVENT_HIGHLIGHT, /*!< Accessibility - Highlight */ - BUFFER_EVENT_HIGHLIGHT_NEXT, /*!< Accessibility - Move highlight to next */ - BUFFER_EVENT_HIGHLIGHT_PREV, /*!< Accessibility - Move highlight to prev */ - BUFFER_EVENT_ACTIVATE, /*!< Accessibility - Activate the highlighted object */ - BUFFER_EVENT_ACTION_UP, /*!< Accessibility - Make UP action */ - BUFFER_EVENT_ACTION_DOWN, /*!< Accessibility - Make Down action */ - BUFFER_EVENT_SCROLL_UP, /*!< Accessibility - Scroll up */ - BUFFER_EVENT_SCROLL_MOVE, /*!< Accessibility - Scroll move */ - BUFFER_EVENT_SCROLL_DOWN, /*!< Accessibility - Scroll down */ - BUFFER_EVENT_UNHIGHLIGHT, /*!< Accessibility - Remove highlight */ - - BUFFER_EVENT_ON_HOLD, /*!< To prevent from generating mouse clicked event */ - BUFFER_EVENT_OFF_HOLD, /*!< Stopped holding. */ - BUFFER_EVENT_ON_SCROLL, /*!< On scrolling */ - BUFFER_EVENT_OFF_SCROLL /*!< Scrolling stopped */ + BUFFER_EVENT_ENTER, /**< Mouse cursor enter */ + BUFFER_EVENT_LEAVE, /**< Mouse cursor leave */ + BUFFER_EVENT_DOWN, /**< Mouse down */ + BUFFER_EVENT_MOVE, /**< Mouse move */ + BUFFER_EVENT_UP, /**< Mouse up */ + + BUFFER_EVENT_KEY_DOWN, /**< Key down */ + BUFFER_EVENT_KEY_UP, /**< Key up */ + BUFFER_EVENT_KEY_FOCUS_IN, /**< Key focus in */ + BUFFER_EVENT_KEY_FOCUS_OUT, /**< Key focus out */ + + BUFFER_EVENT_HIGHLIGHT, /**< Accessibility - Highlight */ + BUFFER_EVENT_HIGHLIGHT_NEXT, /**< Accessibility - Move highlight to next */ + BUFFER_EVENT_HIGHLIGHT_PREV, /**< Accessibility - Move highlight to prev */ + BUFFER_EVENT_ACTIVATE, /**< Accessibility - Activate the highlighted object */ + BUFFER_EVENT_ACTION_UP, /**< Accessibility - Make UP action */ + BUFFER_EVENT_ACTION_DOWN, /**< Accessibility - Make Down action */ + BUFFER_EVENT_SCROLL_UP, /**< Accessibility - Scroll up */ + BUFFER_EVENT_SCROLL_MOVE, /**< Accessibility - Scroll move */ + BUFFER_EVENT_SCROLL_DOWN, /**< Accessibility - Scroll down */ + BUFFER_EVENT_UNHIGHLIGHT, /**< Accessibility - Remove highlight */ + + BUFFER_EVENT_ON_HOLD, /**< To prevent from generating mouse clicked event */ + BUFFER_EVENT_OFF_HOLD, /**< Stopped holding. */ + BUFFER_EVENT_ON_SCROLL, /**< On scrolling */ + BUFFER_EVENT_OFF_SCROLL /**< Scrolling stopped */ }; struct buffer_event_data { - enum buffer_event type; /*!< Mouse, Keyboard, Accessibility event type */ - double timestamp; /*!< Timestamp of events */ + enum buffer_event type; /**< Mouse, Keyboard, Accessibility event type */ + double timestamp; /**< Timestamp of events */ union input_data { struct mouse { - int x; /*!< If the event type is for accessibility or mouse, coordinates of X for pointer */ - int y; /*!< If the event type is for accessibility or mouse, coordinates of Y for pointer */ + int x; /**< If the event type is for accessibility or mouse, coordinates of X for pointer */ + int y; /**< If the event type is for accessibility or mouse, coordinates of Y for pointer */ } pointer; - unsigned int keycode; /*!< If the event type is for keyboard, the value of keycode */ + unsigned int keycode; /**< If the event type is for keyboard, the value of keycode */ } info; }; #endif -/*! - * \brief - * Acquire a buffer for PD or LB, Currently, we only supporting the PD. - * \details N/A - * \remarks N/A - * \param[in] id Id of a livebox instance - * \param[in] is_pd 1 for PD or 0 for livebox - * \param[in] width Width in pixel - * \param[in] height Height in pixel - * \param[in] handler Event handling callback - * \param[in] data user data for event handling callback - * \return handler Buffer handle - * \retval NULL Failed to acquire buffer - * \retval Handle object - * \pre - * Given instance must be specify its type as buffer. or this API will be fail - * \post - * Allocated buffer object must be released via livebox_release_Buffer - * \see livebox_release_buffer - * \sa livebox_acquire_buffer_NEW +/** + * @brief Acquires a buffer for PD or LB, currently only the PD is supported. + * @param[in] id Id of a livebox instance + * @param[in] is_pd 1 for PD or 0 for livebox + * @param[in] width Width in pixel + * @param[in] height Height in pixel + * @param[in] handler Event handling callback + * @param[in] data User data for event handling callback + * @return Buffer handle + * @retval NULL Failed to acquire buffer + * @retval handler Handle object + * @pre Given instance must be specify its type as buffer. or this API will be fail. + * @post Allocated buffer object must be released via livebox_release_Buffer. + * @see 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); + +/** + * @brief Acquires a buffer for PD or LB, currently only the PD is supported. + * @param[in] id Id of a livebox instance + * @param[in] is_pd 1 for PD or 0 for livebox + * @param[in] width Width in pixel + * @param[in] height Height in pixel + * @param[in] pixels Size of a pixel in bytes + * @param[in] handler Event handling callback + * @param[in] data User data for event handling callback + * @return Buffer handle + * @retval NULL Failed to acquire buffer + * @retval handler Handle object + * @pre Given instance must be specify its type as buffer. or this API will be fail. + * @post Allocated buffer object must be released via livebox_release_Buffer. + * @see livebox_acquire_buffer_NEW + */ extern struct livebox_buffer *livebox_acquire_buffer_NEW(const char *id, int is_pd, int width, int height, int pixels, int auto_align, int (*handler)(struct livebox_buffer *, struct buffer_event_data *, void *), void *data); -/*! - * \brief Acquire the ID of pixmap resource - * Only if the provider uses pixmap for providing render buffer. - * \details N/A - * \remarks Pixmap Id can be destroyed if you call the livebox_release_buffer. than this pixmap Id is not guaranteed to use. - * \param[in] handle Buffer handle - * \return unsigned - * \retval positive Pixmap Id - * \retval 0 failed to get pixmap Id. - * \pre The system must be set to use the pixmap method for content sharing - * \post N/A - * \see livebox_acquire_buffer +/** + * @brief Acquires the ID of pixmap resource. + * @details Only if the provider uses pixmap for providing render buffer. + * @remarks Pixmap Id can be destroyed if you call the livebox_release_buffer. Then this pixmap Id is not guaranteed to use. + * @param[in] handle Buffer handle + * @return unsigned log type + * @retval positive Pixmap Id + * @retval 0 Failed to get pixmap Id + * @pre The system must be set to use the pixmap method for content sharing. + * @see livebox_acquire_buffer */ extern unsigned long livebox_pixmap_id(struct livebox_buffer *handle); -/*! - * \brief Release the buffer of livebox - * \details N/A - * \remarks N/A - * \param[in] handle Buffer handle - * \return int - * \retval LB_STATUS_ERROR_INVALID Invalid argument - * \retval LB_STATUS_SUCCESS Successfully released - * \pre handle must be created using livebox_acquire_buffer. - * \post N/A - * \see livebox_acquire_buffer - * \sa livebox_release_buffer_NEW +/** + * @brief Releases the buffer of livebox. + * @param[in] handle Buffer handle + * @return int type + * @retval LB_STATUS_ERROR_INVALID Invalid argument + * @retval LB_STATUS_SUCCESS Successfully released + * @pre Handle must be created using livebox_acquire_buffer. + * @see livebox_acquire_buffer */ extern int livebox_release_buffer(struct livebox_buffer *handle); + +/** + * @brief Releases the buffer of livebox. + * @param[in] handle Buffer handle + * @return int type + * @retval LB_STATUS_ERROR_INVALID Invalid argument + * @retval LB_STATUS_SUCCESS Successfully released + * @pre Handle must be created using livebox_acquire_buffer. + * @see livebox_acquire_buffer_NEW + */ extern int livebox_release_buffer_NEW(struct livebox_buffer *handle); -/*! - * \brief Get the address of S/W render buffer. - * If you try to use this, after create_hw_buffer, you will get NULL - * \details N/A - * \remarks N/A - * \param[in] handle Buffer handle - * \return void* address of the render buffer - * \retval NULL if it falis to get buffer address - * \retval address if it succeed to get the buffer address - * \pre N/A - * \post N/A - * \see livebox_unref_buffer +/** + * @brief Gets the address of S/W render buffer. + * @details 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 + * @retval NULL If it falis to get buffer address + * @retval address If it succeed to get the buffer address + * @see livebox_unref_buffer */ extern void *livebox_ref_buffer(struct livebox_buffer *handle); -/*! - * \brief Release the S/W render buffer. - * \details N/A - * \remarks N/A - * \param[in] buffer Address of render buffer - * \return int - * \retval LB_STATUS_ERROR_INVALID Invalid handle - * \retval LB_STATUS_SUCCESS Successfully unref'd - * \pre livebox_ref_buffer must be called - * \post N/A - * \see livebox_ref_buffer +/** + * @brief Releases the S/W render buffer. + * @param[in] buffer Address of render buffer + * @return int type + * @retval LB_STATUS_ERROR_INVALID Invalid handle + * @retval LB_STATUS_SUCCESS Successfully unreference + * @pre livebox_ref_buffer must be called. + * @see 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 - * \details N/A - * \remarks N/A - * \param[in] handle Buffer handle - * \return int - * \retval LB_STATUS_SUCCESS Successfully sync'd - * \retval LB_STATUS_ERROR_INVALID Invalid argument - * \pre N/A - * \post N/A - * \see livebox_acquire_buffer +/** + * @brief Synchronizes the updated buffer. + * @details This is only needed for non-H/W accelerated buffer. + * @param[in] handle Buffer handle + * @return int type + * @retval LB_STATUS_SUCCESS Successfully sync'd + * @retval LB_STATUS_ERROR_INVALID Invalid argument + * @see livebox_acquire_buffer */ extern int livebox_sync_buffer(struct livebox_buffer *handle); -/*! - * \brief Request schedule the update operation to a provider. - * \details - * \remarks N/A - * \param[in] id Livebox Id - * \return int 0 if succeed or errno < 0 - * \retval LB_STATUS_SUCCESS Successfully triggered - * \retval LB_STATUS_ERROR_INVALID Invalid argument - * \retval LB_STATUS_ERROR_MEMORY Not enough memory - * \retval LB_STATUS_ERROR_NOT_EXIST Given id instance is not exist - * \pre N/A - * \post N/A - * \see N/A +/** + * @brief Requests to schedule the update operation to a provider. + * @param[in] id Livebox Id + * @return If succes returns 0 or return less than 0 + * @retval LB_STATUS_SUCCESS Successfully triggered + * @retval LB_STATUS_ERROR_INVALID Invalid argument + * @retval LB_STATUS_ERROR_MEMORY Not enough memory + * @retval LB_STATUS_ERROR_NOT_EXIST Given id instance is not exist */ extern int livebox_request_update(const char *id); -/*! - * \brief Checking wether the livebox support H/W acceleration or not. - * \details - * \remarks N/A - * \param[in] handle Buffer handle. - * \return int - * \retval 1 if the buffer handle support the H/W acceleration buffer - * \retval 0 if it doesn not supported - * \pre N/A - * \post N/A - * \see livebox_acquire_buffer +/** + * @brief Checks whether the livebox supports H/W acceleration or not. + * @param[in] handle Buffer handle + * @return int type + * @retval 1 If the buffer handle support the H/W acceleration buffer + * @retval 0 If it doesn not supported + * @see livebox_acquire_buffer */ extern int livebox_support_hw_buffer(struct livebox_buffer *handle); -/*! - * \brief Create the H/W accelerated buffer. - * \details Create the H/W accelerated buffer - * \remarks N/A - * \param[in] handle Buffer handle - * \return int - * \retval LB_STATUS_ERROR_ALREADY H/W buffer is already created - * \retval LB_STATUS_ERROR_INVALID Invalid argument - * \retval LB_STATUS_SUCCESS Successfully created - * \pre Must be checked whether the H/W buffer is supported or not. - * \post Must be destroyed if it is not necessary - * \see livebox_support_hw_buffer +/** + * @brief Creates the H/W accelerated buffer. + * @param[in] handle Buffer handle + * @return int type + * @retval LB_STATUS_ERROR_ALREADY H/W buffer is already created + * @retval LB_STATUS_ERROR_INVALID Invalid argument + * @retval LB_STATUS_SUCCESS Successfully created + * @pre Must be checked whether the H/W buffer is supported or not. + * @post Must be destroyed if it is not necessary. + * @see livebox_support_hw_buffer */ extern int livebox_create_hw_buffer(struct livebox_buffer *handle); -/*! - * \brief Destroy the H/W accelerated buffer. - * \details N/A - * \remarks N/A - * \param[in] handle Buffer handle - * \return int - * \retval LB_STATUS_SUCCESS Successfully destroyed - * \retval LB_STATUS_ERROR_INVALID Invalid argument - * \pre Must be created h/w buffer using livebox_create_hw_buffer - * \post N/A - * \see livebox_create_hw_buffer +/** + * @brief Destroys the H/W accelerated buffer. + * @param[in] handle Buffer handle + * @return int type + * @retval LB_STATUS_SUCCESS Successfully destroyed + * @retval LB_STATUS_ERROR_INVALID Invalid argument + * @pre Must be created h/w buffer using livebox_create_hw_buffer. + * @see livebox_create_hw_buffer */ extern int livebox_destroy_hw_buffer(struct livebox_buffer *handle); -/*! - * \brief Get the address of accelerated H/W buffer - * \details N/A - * \remarks N/A - * \param[in] handle Buffer handle - * \return void * - * \retval NULL failed to get H/W accelerated buffer address - * \retval addr H/W accelerated buffer address - * \pre N/A - * \post N/A - * \see livebox_create_hw_buffer +/** + * @brief Gets the address of the accelerated H/W buffer. + * @param[in] handle Buffer handle + * @return void* type + * @retval NULL Failed to get H/W accelerated buffer address + * @retval addr H/W accelerated buffer address + * @see livebox_create_hw_buffer */ extern void *livebox_buffer_hw_buffer(struct livebox_buffer *handle); -/*! - * \brief Get the stride information from the buffer info - * \details N/A - * \remarks N/A - * \param[in] handle - * \return int - * \retval positive_value length of stride - * \return LB_STATUS_ERROR_INVALID Invalid parameter - * \return LB_STATUS_ERROR_FAULT Unrecoverable error - * \pre N/A - * \post N/A - * \see livebox_create_hw_buffer +/** + * @brief Get the stride information from the buffer info + * @param[in] handle Buffer handle + * @return int stride size + * @retval positive_value length of stride + * @return LB_STATUS_ERROR_INVALID Invalid parameter + * @return LB_STATUS_ERROR_FAULT Unrecoverable error + * @see livebox_create_hw_buffer */ extern int livebox_buffer_stride(struct livebox_buffer *handle); -/*! - * \brief Pre-processing for rendering content. - * This is only needed for accessing H/W accelerated buffer. - * \details N/A - * \remarks N/A - * \param[in] handle Buffer handle - * \return int - * \retval LB_STATUS_ERROR_INVALID Invalid handle - * \retval LB_STATUS_SUCCESS Successfully done - * \pre N/A - * \post livebox_buffer_post_render must be called after the rendering (accessing buffer) is completed. - * \see livebox_support_hw_buffer - * \see livebox_buffer_post_render +/** + * @brief Pre-processes for rendering content. + * @details This is only needed for accessing H/W accelerated buffer. + * @param[in] handle Buffer handle + * @return int type + * @retval LB_STATUS_ERROR_INVALID Invalid handle + * @retval LB_STATUS_SUCCESS Successfully done + * @post livebox_buffer_post_render must be called after the rendering (accessing buffer) is completed. + * @see livebox_support_hw_buffer + * @see livebox_buffer_post_render */ extern int livebox_buffer_pre_render(struct livebox_buffer *handle); -/*! - * \brief Post-processing for rendering content. - * \details N/A - * \remarks N/A - * \param[in] handle Buffer handle - * \return integer 0 if succeed or errno < 0 - * \retval LB_STATUS_SUCCESS if succeed - * \retval LB_STATUS_ERROR_INVALID Invalid argument - * \pre livebox_buffer_pre_render must be called - * \post N/A - * \see livebox_support_hw_buffer - * \see livebox_buffer_pre_render +/** + * @brief Post-processes for rendering content. + * @param[in] handle Buffer handle + * @return If succes returns 0 or return less than 0 + * @retval LB_STATUS_SUCCESS If succeed + * @retval LB_STATUS_ERROR_INVALID Invalid argument + * @pre livebox_buffer_pre_render must be called. + * @see livebox_support_hw_buffer + * @see livebox_buffer_pre_render */ extern int livebox_buffer_post_render(struct livebox_buffer *handle); -/*! - * \brief - * Deprecated API set. -extern Evas_Object *livebox_snapshot_window_add(const char *id, int size_type); -extern int livebox_snapshot_window_flush(Evas_Object *snapshot_win, double timeout, void (*flush_cb)(Evas_Object *snapshot_window, const char *id, int status, void *data), void *data); -extern int livebox_snapshot_window_del(Evas_Object *snapshot_win); -*/ - -/*! - * \brief Create an Evas_Object to create a elm_win object - * \details Creating a new Evas_Object using livebox frame buffer. - * \remarks N/A - * \param[in] id Instance Id - * \param[in] is_pd 1 if this object is created for PD or 0 (for LB) - * \return Evas_Object* Evas Object - * \retval Address Valid evas object - * \retval NULL failed to create - * \pre N/A - * \post N/A - * \see livebox_set_elm_window +/** + * @brief Creates an Evas_Object to create an elm_win object. + * @details Creating a new Evas_Object using livebox frame buffer. + * @param[in] id Instance Id + * @param[in] is_pd 1 if this object is created for PD or 0 (for LB) + * @return Evas_Object* Evas Object type + * @retval Address Valid evas object + * @retval NULL failed to create + * @see livebox_set_elm_window */ extern Evas_Object *livebox_get_evas_object(const char *id, int is_pd); -/*! - * \brief Send a request to the viewer (homescreen) to close the PD. - * \details Even though you call this function. the homescreen can ignore it. - * \remarks - * \param[in] pkgname Livebox Package Id - * \param[in] id Livebox Instance Id - * \param[in] reason LB_STATUS_SUCCESS(0) - * \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 a request - * \retval LB_STATUS_SUCCESS Successfully requested - * \pre N/A - * \post N/A - * \see +/** + * @brief Sends a request to the viewer (homescreen) to close the PD. + * @details Even though you call this function. the homescreen can ignore it. + * @param[in] pkgname Livebox Package Id + * @param[in] id Livebox Instance Id + * @param[in] reason LB_STATUS_SUCCESS(0) + * @return int type + * @retval LB_STATUS_ERROR_INVALID Invalid parameters + * @retval LB_STATUS_ERROR_MEMORY Out of memory + * @retval LB_STATUS_ERROR_FAULT Failed to send a request + * @retval LB_STATUS_SUCCESS Successfully requested + * @see */ extern int livebox_request_close_pd(const char *pkgname, const char *id, int reason); -/*! - * \brief Send a freeze request to the viewer (homescreen) - * \details +/** + * @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 + * @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 +/** + * @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 + * @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); -/*! - * \brief Get the configuration status of premultiplied alpha. - * \details +/** + * @brief Get the configuration status of premultiplied alpha. + * @details * If the system uses the premultiplied alpha for content, * This function will returns 1. - * \remarks This function only works with the inhouse provider. - * \return status of premultiplied alpha. - * \retval 1 Content rendered with premultiplied alpha. - * \retval 0 Content doesn't rendered with premultiplied alpha. + * @remarks This function only works with the inhouse provider. + * @return status of premultiplied alpha. + * @retval 1 Content rendered with premultiplied alpha. + * @retval 0 Content doesn't rendered with premultiplied alpha. */ extern int livebox_conf_premultiplied_alpha(void); -/*! - * \} +/** + * @} */ #ifdef __cplusplus -- 2.7.4