Update internal tag for doxygen
authorSung-jae Park <nicesj.park@samsung.com>
Mon, 17 Nov 2014 06:08:15 +0000 (15:08 +0900)
committerSung-jae Park <nicesj.park@samsung.com>
Mon, 17 Nov 2014 06:08:15 +0000 (15:08 +0900)
[model] Redwood,Kiran,B3(Wearable)
[binary_type] AP
[customer] Docomo/Orange/ATT/Open
[issue#] N/A
[problem]
[cause]
[solution]
[team] HomeTF
[request]
[horizontal_expansion]

Change-Id: Ia6941ad34890bf6ef5431232a6bc12e5216b346f

include/dynamicbox.h

index 6dc16a9..a2fe240 100644 (file)
@@ -39,90 +39,105 @@ extern "C" {
  */
 
 /**
+ * @internal
  * @brief Definition for COLOR BLOCK.
  * @since_tizen 2.3
  */
 #define DBOX_DESC_TYPE_COLOR "color"
 
 /**
+ * @internal
  * @brief Definition for TEXT BLOCK.
  * @since_tizen 2.3
  */
 #define DBOX_DESC_TYPE_TEXT "text"
 
 /**
+ * @internal
  * @brief Definition for IMAGE BLOCK.
  * @since_tizen 2.3
  */
 #define DBOX_DESC_TYPE_IMAGE "image"
 
 /**
+ * @internal
  * @brief Definition for SIGNAL BLOCK.
  * @since_tizen 2.3
  */
 #define DBOX_DESC_TYPE_SIGNAL "signal"
 
 /**
+ * @internal
  * @brief Definition for INFO BLOCK.
  * @since_tizen 2.3
  */
 #define DBOX_DESC_TYPE_INFO "info"
 
 /**
+ * @internal
  * @brief Definition for DRAG BLOCK.
  * @since_tizen 2.3
  */
 #define DBOX_DESC_TYPE_DRAG "drag"
 
 /**
+ * @internal
  * @brief Definition for SCRIPT SCRIPT.
  * @since_tizen 2.3
  */
 #define DBOX_DESC_TYPE_SCRIPT "script"
 
 /**
+ * @internal
  * @brief Definition for ACCESSIBILITY INFORMATION BLOCK.
  * @since_tizen 2.3
  */
 #define DBOX_DESC_TYPE_ACCESS "access"
 
 /**
+ * @internal
  * @brief Definition for accessibility operation.
  * @since_tizen 2.3
  */
 #define DBOX_DESC_TYPE_ACCESS_OPERATION "access,operation"
 
 /**
+ * @internal
  * @brief Definition for set highlight on specified part.
  * @since_tizen 2.3
  */
 #define DBOX_DESC_DATA_ACCESS_OPERATION_HL_SET "set,hl"
 
 /**
+ * @internal
  * @brief Definition for remove highlight from specified part.
  * @since_tizen 2.3
  */
 #define DBOX_DESC_DATA_ACCESS_OPERATION_HL_UNSET "unset,hl"
 
 /**
+ * @internal
  * @brief Definition for move the highlight to next part.
  * @since_tizen 2.3
  */
 #define DBOX_DESC_DATA_ACCESS_OPERATION_HL_NEXT "next,hl"
 
 /**
+ * @internal
  * @brief Definition for move the highlight to previous part.
  * @since_tizen 2.3
  */
 #define DBOX_DESC_DATA_ACCESS_OPERATION_HL_PREV "prev,hl"
 
 /**
+ * @internal
  * @brief Definition for reset the chain of accessibility highlight list.
  * @since_tizen 2.3
  */
 #define DBOX_DESC_DATA_ACCESS_OPERATION_RESET "reset,focus"
 
 /**
+ * @internal
  * @brief Definition for specify the highlight move option.
  * @details If the highlight list reaches to the last object, move back to the first object.
  * @since_tizen 2.3
@@ -130,6 +145,7 @@ extern "C" {
 #define DBOX_DESC_OPTION_ACCESS_HL_LOOP "cycle"
 
 /**
+ * @internal
  * @brief Definition for specify the highlight move option.
  * @details If the highlight list reaches to the last object(or the first object),
  * the "prev,hl", "next,hl" will be failed.
@@ -138,6 +154,7 @@ extern "C" {
 #define DBOX_DESC_OPTION_ACCESS_HL_NOLOOP "no,cycle"
 
 /**
+ * @internal
  * @brief Dynamic Box description data handle.
  * @since_tizen 2.3
  */
@@ -151,6 +168,7 @@ typedef struct dynamicbox_desc *dynamicbox_desc_h;
 typedef void (*dynamicbox_flush_cb)(void *snapshot_window, const char *id, int status, void *data);
 
 /**
+ * @internal
  * @brief Updates a description file.
  * @since_tizen 2.3
  * @remarks Must be used only by Inhouse Dynamic Box.
@@ -166,6 +184,7 @@ typedef void (*dynamicbox_flush_cb)(void *snapshot_window, const char *id, int s
 extern dynamicbox_desc_h dynamicbox_desc_open(const char *id, int gbar);
 
 /**
+ * @internal
  * @brief Completes the description file update.
  * @details Only if this API is called, the description data will be applied to the content of Dynamic Box (or GBar).
  * @since_tizen 2.3
@@ -183,6 +202,7 @@ extern dynamicbox_desc_h dynamicbox_desc_open(const char *id, int gbar);
 extern int dynamicbox_desc_close(dynamicbox_desc_h handle);
 
 /**
+ * @internal
  * @brief Sets the category information of current description data.
  * @details Creates a new description block for updating category information of layout object.
  * @since_tizen 2.3
@@ -199,6 +219,7 @@ extern int dynamicbox_desc_close(dynamicbox_desc_h handle);
 extern int dynamicbox_desc_set_category(dynamicbox_desc_h handle, const char *id, const char *category);
 
 /**
+ * @internal
  * @brief Sets the content size.
  * @details Sets the content size of layout.
  * @since_tizen 2.3
@@ -216,6 +237,7 @@ extern int dynamicbox_desc_set_category(dynamicbox_desc_h handle, const char *id
 extern int dynamicbox_desc_set_size(dynamicbox_desc_h handle, const char *id, int w, int h);
 
 /**
+ * @internal
  * @brief Sets the target id of the given block.
  * @details Only available for the script block.
  * @since_tizen 2.3
@@ -234,6 +256,7 @@ extern int dynamicbox_desc_set_size(dynamicbox_desc_h handle, const char *id, in
 extern int dynamicbox_desc_set_id(dynamicbox_desc_h handle, int idx, const char *id);
 
 /**
+ * @internal
  * @brief Adds a new block.
  * @since_tizen 2.3
  * @param[in] handle Handle which is created by the dynamicbox_desc_open() function
@@ -253,6 +276,7 @@ extern int dynamicbox_desc_set_id(dynamicbox_desc_h handle, int idx, const char
 extern int dynamicbox_desc_add_block(dynamicbox_desc_h handle, const char *id, const char *type, const char *part, const char *data, const char *option);
 
 /**
+ * @internal
  * @brief Deletes an added block.
  * @since_tizen 2.3
  * @details If you discard the added desc block, use this API and the index of the created desc block.
@@ -275,6 +299,8 @@ extern int dynamicbox_desc_del_block(dynamicbox_desc_h handle, int idx);
  * @param[in] gbar 1 if this object is created for Glance Bar or 0 (for Dynamic Box)
  * @privlevel public
  * @privilege %http://tizen.org/privilege/core/dynamicbox
+ * @feature http://developer.samsung.com/tizen/feature/samsung_extension
+ * @feature http://tizen.org/feature/shell.appwidget
  * @return void* Object type
  * @retval Address Valid evas object
  * @retval @c NULL failed to create
@@ -296,6 +322,8 @@ extern void *dynamicbox_get_evas_object(const char *id, int gbar);
  * @param[in] icon Path of icon image file - alternative image content
  * @param[in] name Name of a box - alternative text content
  * @return int type
+ * @feature http://developer.samsung.com/tizen/feature/samsung_extension
+ * @feature http://tizen.org/feature/shell.appwidget
  * @retval #DBOX_STATUS_ERROR_OUT_OF_MEMORY Out of memory
  * @retval #DBOX_STATUS_ERROR_INVALID_PARAMETER Invalid parameters
  * @retval #DBOX_STATUS_ERROR_FAULT Unrecoverable error
@@ -312,28 +340,24 @@ extern int dynamicbox_set_extra_info(const char *id, const char *content, const
 typedef struct dynamicbox_buffer *dynamicbox_buffer_h;
 
 /**
- * @internal
  * @brief Return values of dynamicbox programming interfaces: Operation is successfully done.
  * @since_tizen 2.3
  */
 extern const int DBOX_DONE;
 
 /**
- * @internal
  * @brief Return values of dynamicbox programming interfaces: Contents are updated.
  * @since_tizen 2.3
  */
 extern const int DBOX_OUTPUT_UPDATED;
 
 /**
- * @internal
  * @brief Return values of dynamicbox programming interfaces: Need to call the dynamicbox_need_to_update and dynamicbox_update_content.
  * @since_tizen 2.3
  */
 extern const int DBOX_NEED_TO_SCHEDULE;
 
 /**
- * @internal
  * @brief Return values of dynamicbox programming interfaces: Need to do force update.
  * @since_tizen 2.3
  */
@@ -347,14 +371,12 @@ extern const int DBOX_FORCE_TO_SCHEDULE;
 extern const int DBOX_NEED_TO_CREATE;
 
 /**
- * @internal
  * @brief Return values of dynamicbox programming interfaces: Need to destroy this instance.
  * @since_tizen 2.3
  */
 extern const int DBOX_NEED_TO_DESTROY;
 
 /**
- * @internal
  * @brief Return values of dynamicbox programming interfaces: Need to update.
  * @since_tizen 2.3
  */
@@ -368,49 +390,42 @@ extern const int DBOX_NEED_TO_UPDATE;
 extern const int DBOX_USE_NET;
 
 /**
- * @internal
  * @brief System event type: System font is changed.
  * @since_tizen 2.3
  */
 extern const int DBOX_SYS_EVENT_FONT_CHANGED;
 
 /**
- * @internal
  * @brief System event type: System language is changed.
  * @since_tizen 2.3
  */
 extern const int DBOX_SYS_EVENT_LANG_CHANGED;
 
 /**
- * @internal
  * @brief System event type: System time is changed.
  * @since_tizen 2.3
  */
 extern const int DBOX_SYS_EVENT_TIME_CHANGED;
 
 /**
- * @internal
  * @brief System event type: Region changed.
  * @since_tizen 2.3
  */
 extern const int DBOX_SYS_EVENT_REGION_CHANGED;
 
 /**
- * @internal
  * @brief System event type: Accessibility mode changed.
  * @since_tizen 2.3
  */
 extern const int DBOX_SYS_EVENT_TTS_CHANGED;
 
 /**
- * @internal
  * @brief System event type: Dynamic Box is paused.
  * @since_tizen 2.3
  */
 extern const int DBOX_SYS_EVENT_PAUSED;
 
 /**
- * @internal
  * @brief System event type: Dynamic Box is resumed.
  * @since_tizen 2.3
  */
@@ -424,7 +439,6 @@ extern const int DBOX_SYS_EVENT_RESUMED;
 extern const int DBOX_SYS_EVENT_MMC_STATUS_CHANGED;
 
 /**
- * @internal
  * @brief System event type: Dynamic Box instance is removed from a viewer.
  * @since_tizen 2.3
  */
@@ -584,7 +598,6 @@ extern int dynamicbox_unref_buffer(void *buffer);
 extern int dynamicbox_sync_buffer(dynamicbox_buffer_h handle);
 
 /**
- * @internal
  * @brief Requests to schedule the update operation to a provider.
  *        Your DBox will get the update request, if the @a id is specified, specific box only will get it.
  * @since_tizen 2.3
@@ -727,7 +740,6 @@ extern int dynamicbox_buffer_post_render(dynamicbox_buffer_h handle);
 extern int dynamicbox_request_close_glance_bar(const char *dboxid, const char *id, int reason);
 
 /**
- * @internal
  * @brief Send a freeze request to the viewer (homescreen)
  * @details
  *        The viewer will get this request via event callback.
@@ -738,6 +750,8 @@ extern int dynamicbox_request_close_glance_bar(const char *dboxid, const char *i
  * @param[in] id Instance Id which is passed to you via the first parameter of every dynamicbox_XXXX interface functions
  * @privlevel public
  * @privilege %http://tizen.org/privilege/core/dynamicbox
+ * @feature http://developer.samsung.com/tizen/feature/samsung_extension
+ * @feature http://tizen.org/feature/shell.appwidget
  * @return int type
  * @retval #DBOX_STATUS_ERROR_INVALID_PARAMETER Invalid parameters
  * @retval #DBOX_STATUS_ERROR_OUT_OF_MEMORY Out of memory
@@ -748,7 +762,6 @@ extern int dynamicbox_request_close_glance_bar(const char *dboxid, const char *i
 extern int dynamicbox_freeze_scroller(const char *dboxid, const char *id);
 
 /**
- * @internal
  * @brief Send a release request to the viewer (homescreen)
  * @details
  *        The viewer will get this request via event callback.
@@ -759,6 +772,8 @@ extern int dynamicbox_freeze_scroller(const char *dboxid, const char *id);
  * @param[in] id Instance Id which is passed to you via the first parameter of every dynamicbox_XXXX interface functions
  * @privlevel public
  * @privilege %http://tizen.org/privilege/core/dynamicbox
+ * @feature http://developer.samsung.com/tizen/feature/samsung_extension
+ * @feature http://tizen.org/feature/shell.appwidget
  * @return int type
  * @retval #DBOX_STATUS_ERROR_INVALID_PARAMETER Invalid parameters
  * @retval #DBOX_STATUS_ERROR_OUT_OF_MEMORY Out of memory