1. Update doxygen comments

2. Include widget_service_internal.h

Change-Id: Ibe17960b638642e5089ddcc2f8b1c9e6eb4f1593
Signed-off-by: Kyuho Jo <kyuho.jo@samsung.com>

diff --git a/widget_viewer/doc/image/PD.png b/widget_viewer_evas/doc/image/PD.png
similarity index 100%
rename from widget_viewer/doc/image/PD.png
rename to widget_viewer_evas/doc/image/PD.png

diff --git a/widget_viewer/doc/image/download_folder.png b/widget_viewer_evas/doc/image/download_folder.png
similarity index 100%
rename from widget_viewer/doc/image/download_folder.png
rename to widget_viewer_evas/doc/image/download_folder.png

diff --git a/widget_viewer/doc/image/front.jpg b/widget_viewer_evas/doc/image/front.jpg
similarity index 100%
rename from widget_viewer/doc/image/front.jpg
rename to widget_viewer_evas/doc/image/front.jpg

diff --git a/widget_viewer/doc/image/image_format.png b/widget_viewer_evas/doc/image/image_format.png
similarity index 100%
rename from widget_viewer/doc/image/image_format.png
rename to widget_viewer_evas/doc/image/image_format.png

diff --git a/widget_viewer/doc/image/message.png b/widget_viewer_evas/doc/image/message.png
similarity index 100%
rename from widget_viewer/doc/image/message.png
rename to widget_viewer_evas/doc/image/message.png

diff --git a/widget_viewer/doc/image/preload_folder.png b/widget_viewer_evas/doc/image/preload_folder.png
similarity index 100%
rename from widget_viewer/doc/image/preload_folder.png
rename to widget_viewer_evas/doc/image/preload_folder.png

diff --git a/widget_viewer/doc/image/script_format.png b/widget_viewer_evas/doc/image/script_format.png
similarity index 100%
rename from widget_viewer/doc/image/script_format.png
rename to widget_viewer_evas/doc/image/script_format.png

diff --git a/widget_viewer/doc/image/stock.png b/widget_viewer_evas/doc/image/stock.png
similarity index 100%
rename from widget_viewer/doc/image/stock.png
rename to widget_viewer_evas/doc/image/stock.png

diff --git a/widget_viewer/doc/image/text_format.png b/widget_viewer_evas/doc/image/text_format.png
similarity index 100%
rename from widget_viewer/doc/image/text_format.png
rename to widget_viewer_evas/doc/image/text_format.png

diff --git a/widget_viewer/doc/image/twitter.png b/widget_viewer_evas/doc/image/twitter.png
similarity index 100%
rename from widget_viewer/doc/image/twitter.png
rename to widget_viewer_evas/doc/image/twitter.png

diff --git a/widget_viewer/doc/image/weather.png b/widget_viewer_evas/doc/image/weather.png
similarity index 100%
rename from widget_viewer/doc/image/weather.png
rename to widget_viewer_evas/doc/image/weather.png

diff --git a/widget_viewer/doc/widget_viewer_doc.h b/widget_viewer_evas/doc/widget_viewer_evas_doc.h
similarity index 90%
rename from widget_viewer/doc/widget_viewer_doc.h
rename to widget_viewer_evas/doc/widget_viewer_evas_doc.h
index e4d9cbd..bfd007a 100644 (file)
--- a/widget_viewer/doc/widget_viewer_doc.h
+++ b/widget_viewer_evas/doc/widget_viewer_evas_doc.h
@@ -15,19 +15,17 @@
  */
 
 /**
+ * @defgroup WIDGET_VIEWER_EVAS_MODULE widget-viewer-evas
  * @ingroup CAPI_WIDGET_FRAMEWORK
- * @defgroup WIDGET_VIEWER_MODULE widget Viewer
  * @brief API for widget viewer (widget screen, home screen, ...)
- * @section WIDGET_VIEWER_MODULE_HEADER Required Header
- * \#include <widget.h>
- * @section WIDGET_VIEWER_MODULE_OVERVIEW Overview
- * Tizen homescreen S/W framework is supporing the widget. (aka widget which is similiar with the android widget)
+ * @section WIDGET_VIEWER_EVAS_MODULE_HEADER Required Header
+ * \#include <widget_viewer_evas.h>
+ * @section WIDGET_VIEWER_EVAS_MODULE_OVERVIEW Overview
+ * Tizen homescreen S/W framework is supporting the widget. (aka widget which is similar with the android widget)
  *
  * @image html front.jpg
  *
- * @subsection WhatIsTheDynamicBox 1. What is the widget
- * The widget is the widget of the TIZEN.
- *
+ * @subsection WhatIsTheWidget 1. What is the widget
  * It works as a small application displayed on other applications' (such as homescreen, lockscreen, etc ...) view.
  * Each widget can have (not a mandatory option) a Glance Bar (Glance Bar) in which more detailed information can be found.
  * The content of Glance Bar can be exposed when a certain gesture (e.g., flick-down) has been applied to the widget.
@@ -68,10 +66,10 @@
  *
  * @subsubsection ClusterCategory 1.3 What is the "cluster" and "category"
  * The cluster and the sub-cluster is just like the grouping concept.
- * It is used for creating/destorying your widget instance when the data provider receives any context event from the context engine.
+ * It is used for creating/destroying your widget instance when the data provider receives any context event from the context engine.
  * You will only get "user,created" cluster and "default" category(sub cluster) info.
  *
- * @subsection DynamicBoxContent 2. How the widget can draw contents for viewer?
+ * @subsection WidgetContent 2. How the widget can draw contents for viewer?
  * There are several ways to update the content of a widget.
  *
  * @li Image file based content updating
@@ -111,22 +109,22 @@
  * This type is only supported for 3rd party widget such as OSP and WEB.
  * Inhouse(EFL) widget is not able to use this buffer type for the box content.
  *
- * @subsection DynamicBoxDirectory 3. widget directory hierachy
+ * @subsection WidgetDirectory 3. widget directory hierarchy
  * @image html preload_folder.png
  * @image html download_folder.png
  *
  * @subsection WritingViewerApp 4. Writing a new application for displaying Widgets
- * If you want install dynamic boxes on your application screen, you should initialize the viewer system first.
+ * If you want install widgets on your application screen, you should initialize the viewer system first.
  *
  * @code
  * extern int widget_init(void *disp, int prevent_overwrite, double event_filter, int use_thread);
  * @endcode
  *
  * @a disp should be current display object. if we are on X11 based windowing system, it will give you a Display Object, when you connect to X Server.
- * Viewer application also needs it to preparing rendering buffer to display contents of dynamic boxes.
+ * Viewer application also needs it to preparing rendering buffer to display contents of widgets.
  *
- * @a prevent_overwirte flag is used for image or script type dynamic boxes.
- * If this option is turn on, the viewer library will copy the image file of dyanmic box content to "reader" folder.
+ * @a prevent_overwirte flag is used for image or script type widgets.
+ * If this option is turn on, the viewer library will copy the image file of widget content to "reader" folder.
  * To prevent from overwriting content image file.
  *
  * @a event_filter is used for feeding events.
@@ -185,7 +183,7 @@
  *     
  *     return ui_app_main(&argc, &argv, &event_callback, &main_info);
  * }
- * @endocde
+ * @endcode
  *
  * If you want add a new widget, you can call "widget_add()" function.
  *

diff --git a/widget_viewer_evas/include/widget_viewer_evas.h b/widget_viewer_evas/include/widget_viewer_evas.h
index d45dd0d..85c8134 100644 (file)
--- a/widget_viewer_evas/include/widget_viewer_evas.h
+++ b/widget_viewer_evas/include/widget_viewer_evas.h
@@ -26,12 +26,25 @@
 extern "C" {
 #endif
 
+
+/**
+ * @file widget_viewer_evas.h
+ * @brief  This file declares API of libwidget-viewer-evas library
+ * @since_tizen 2.3.1
+ */
+
+/**
+ * @addtogroup WIDGET_VIEWER_EVAS_MODULE
+ * @{
+ */
+
 /**
  * @since_tizen 2.3.1
  * @brief Default refresh interval of widgets.
  * @see #widget_viewer_evas_add_widget
+ * @see #widget_viewer_evas_get_period
  */
-#define WIDGET_VIEWER_EVAS_DEFAULT_PERIOD                -1.0f                   /**< Default Update Period */
+#define WIDGET_VIEWER_EVAS_DEFAULT_PERIOD                -1.0f
 
 /**
  * @since_tizen 2.3.1
@@ -108,8 +121,8 @@ typedef enum widget_evas_conf {
  * @since_tizen 2.3.1
  * @param[in] win Window object
  * @return 0 on success, otherwise a negative error value
- * @retval #WIDGET_STATUS_ERROR_NONE If success
- * @retval #WIDGET_STATUS_ERROR_INVALID_PARAMETER
+ * @retval #WIDGET_ERROR_NONE If success
+ * @retval #WIDGET_ERROR_INVALID_PARAMETER
  * @retval #WIDGET_ERROR_PERMISSION_DENIED Permission denied
  * @see #widget_viewer_evas_fini
  */
@@ -119,8 +132,8 @@ extern int widget_viewer_evas_init(Evas_Object *win);
  * @brief Finalizes the widget system
  * @since_tizen 2.3.1
  * @return 0 on success, otherwise a negative error value
- * @retval #WIDGET_STATUS_ERROR_NONE If success
- * @retval #WIDGET_STATUS_ERROR_FAULT Unrecoverable error occurred
+ * @retval #WIDGET_ERROR_NONE If success
+ * @retval #WIDGET_ERROR_FAULT Unrecoverable error occurred
  * @see #widget_viewer_evas_init
  */
 extern int widget_viewer_evas_fini(void);
@@ -135,8 +148,6 @@ extern int widget_viewer_evas_fini(void);
  * @return Widget Object
  * @retval NULL if it fails to create a new widget object and you can get the reason of failure using get_last_result()
  * @see #widget_service_get_widget_id
- * @see #widget_service_get_content_string
- * @see #widget_service_get_category
  */
 extern Evas_Object *widget_viewer_evas_add_widget(Evas_Object *parent, const char *widget_id, const char *content_info, double period);
 
@@ -147,7 +158,7 @@ extern Evas_Object *widget_viewer_evas_add_widget(Evas_Object *parent, const cha
  * @privlevel public
  * @privilege %http://tizen.org/privilege/widget.viewer
  * @return 0 on success, otherwise a negative error value
- * @retval #WIDGET_STATUS_ERROR_NONE if success
+ * @retval #WIDGET_ERROR_NONE if success
  * @retval #WIDGET_ERROR_FAULT if it failed to send state (paused) info
  * @retval #WIDGET_ERROR_PERMISSION_DENIED Permission denied
  * @see widget_viewer_evas_notify_paused_status_of_viewer()
@@ -161,7 +172,7 @@ extern int widget_viewer_evas_notify_resumed_status_of_viewer(void);
  * @privlevel public
  * @privilege %http://tizen.org/privilege/widget.viewer
  * @return 0 on success, otherwise a negative error value
- * @retval #WIDGET_STATUS_ERROR_NONE if success
+ * @retval #WIDGET_ERROR_NONE if success
  * @retval #WIDGET_ERROR_FAULT if it failed to send state (resumed) info
  * @retval #WIDGET_ERROR_PERMISSION_DENIED Permission denied
  * @see widget_viewer_evas_notify_resumed_status_of_viewer()
@@ -176,7 +187,7 @@ extern int widget_viewer_evas_notify_paused_status_of_viewer(void);
  * @privilege %http://tizen.org/privilege/widget.viewer
  * @param[in] orientation orientation of viewer
  * @return 0 on success, otherwise a negative error value
- * @retval #WIDGET_STATUS_ERROR_NONE if success
+ * @retval #WIDGET_ERROR_NONE if success
  * @retval #WIDGET_ERROR_FAULT if it failed to send state (resumed) info
  * @retval #WIDGET_ERROR_PERMISSION_DENIED Permission denied
  */
@@ -189,8 +200,8 @@ extern int widget_viewer_evas_notify_orientation_of_viewer(int orientation);
  * @privilege %http://tizen.org/privilege/widget.viewer
  * @param[in] widget a widget object
  * @return 0 on success, otherwise a negative error value
- * @retval #WIDGET_STATUS_ERROR_NONE if success
- * @retval #WIDGET_STATUS_ERROR_INVALID_PARAMETER Invalid argument
+ * @retval #WIDGET_ERROR_NONE if success
+ * @retval #WIDGET_ERROR_INVALID_PARAMETER Invalid argument
  * @retval #WIDGET_ERROR_PERMISSION_DENIED Permission denied
  * @retval #WIDGET_ERROR_FAULT if it failed to send state (resumed) info
  */
@@ -203,8 +214,8 @@ extern int widget_viewer_evas_pause_widget(Evas_Object *widget);
  * @privilege %http://tizen.org/privilege/widget.viewer
  * @param[in] widget a widget object
  * @return 0 on success, otherwise a negative error value
- * @retval #WIDGET_STATUS_ERROR_NONE if success
- * @retval #WIDGET_STATUS_ERROR_INVALID_PARAMETER Invalid argument
+ * @retval #WIDGET_ERROR_NONE if success
+ * @retval #WIDGET_ERROR_INVALID_PARAMETER Invalid argument
  * @retval #WIDGET_ERROR_FAULT if it failed to send state (resumed) info
  * @retval #WIDGET_ERROR_PERMISSION_DENIED Permission denied
  */
@@ -216,8 +227,8 @@ extern int widget_viewer_evas_resume_widget(Evas_Object *widget);
  * @param[in] type Configuration item
  * @param[in] value Its value
  * @return 0 on success, otherwise a negative error value
- * @retval #WIDGET_STATUS_ERROR_NONE if success
- * @retval #WIDGET_STATUS_ERROR_INVALID_PARAMETER Invalid argument
+ * @retval #WIDGET_ERROR_NONE if success
+ * @retval #WIDGET_ERROR_INVALID_PARAMETER Invalid argument
  * @see #widget_evas_conf
  */
 extern int widget_viewer_evas_set_option(widget_evas_conf_e type, int value);
@@ -307,8 +318,8 @@ extern void widget_viewer_evas_disable_loading(Evas_Object *widget);
  * @privilege %http://tizen.org/privilege/widget.viewer
  * @param[in] widget a widget object
  * @return 0 on success, otherwise a negative error value
- * @retval #WIDGET_STATUS_ERROR_NONE if success
- * @retval #WIDGET_STATUS_ERROR_INVALID_PARAMETER Invalid argument
+ * @retval #WIDGET_ERROR_NONE if success
+ * @retval #WIDGET_ERROR_INVALID_PARAMETER Invalid argument
  * @retval #WIDGET_ERROR_PERMISSION_DENIED Permission denied
  */
 extern int widget_viewer_evas_feed_mouse_up_event(Evas_Object *widget);
@@ -341,8 +352,8 @@ extern bool widget_viewer_evas_is_faulted(Evas_Object *widget);
  * @param[in] widget a widget object
  * @param[in] status a visibility status of the widget
  * @return 0 on success, otherwise a negative error value
- * @retval #WIDGET_STATUS_ERROR_NONE if success
- * @retval #WIDGET_STATUS_ERROR_INVALID_PARAMETER Invalid argument
+ * @retval #WIDGET_ERROR_NONE if success
+ * @retval #WIDGET_ERROR_INVALID_PARAMETER Invalid argument
  * @see #widget_visibility_status_e
  */
 extern int widget_viewer_evas_freeze_visibility(Evas_Object *widget, widget_visibility_status_e status);
@@ -353,8 +364,8 @@ extern int widget_viewer_evas_freeze_visibility(Evas_Object *widget, widget_visi
  * @since_tizen 2.3.1
  * @param[in] widget a widget object
  * @return 0 on success, otherwise a negative error value
- * @retval #WIDGET_STATUS_ERROR_NONE if success
- * @retval #WIDGET_STATUS_ERROR_INVALID_PARAMETER Invalid argument
+ * @retval #WIDGET_ERROR_NONE if success
+ * @retval #WIDGET_ERROR_INVALID_PARAMETER Invalid argument
  */
 extern int widget_viewer_evas_thaw_visibility(Evas_Object *widget);
 
@@ -386,6 +397,10 @@ extern bool widget_viewer_evas_is_widget(Evas_Object *widget);
  */
 extern void widget_viewer_evas_set_permanent_delete(Evas_Object *widget, int flag);
 
+/**
+ * @}
+ */
+
 #ifdef __cplusplus
 }
 #endif

diff --git a/widget_viewer_evas/include/widget_viewer_evas_internal.h b/widget_viewer_evas/include/widget_viewer_evas_internal.h
index 819723e..0264b41 100644 (file)
--- a/widget_viewer_evas/include/widget_viewer_evas_internal.h
+++ b/widget_viewer_evas/include/widget_viewer_evas_internal.h
@@ -23,6 +23,7 @@ extern "C" {
 #endif
 
 #include "widget_viewer_evas.h"
+#include "widget_service_internal.h"
 
 #define WIDGET_SMART_SIGNAL_GBAR_DESTROYED        "gbar,destroyed"        /**< GBAR is destroyed */
 #define WIDGET_SMART_SIGNAL_GBAR_ABORTED          "gbar,aborted"          /**< GBAR creation is aborted */