Update doxygen comments

- For document public release, Native API reference is checked by Lionbridge.

Change-Id: I4a6786a2fc2dcbd62d97161d1ac24c99971af909
Signed-off-by: Seoyeon Kim <seoyeon2.kim@samsung.com>

diff --git a/widget_viewer_dali/public_api/widget_view/widget_view.h b/widget_viewer_dali/public_api/widget_view/widget_view.h
index 2ac21f3..6d153c3 100644 (file)
--- a/widget_viewer_dali/public_api/widget_view/widget_view.h
+++ b/widget_viewer_dali/public_api/widget_view/widget_view.h
@@ -58,7 +58,7 @@ class DALI_IMPORT_API WidgetView : public Toolkit::Control
 public:
 
   /**
-   * @brief The start and end property ranges for this control.
+   * @brief Enumeration for the start and end property ranges for this control.
    * @SINCE_1_0.0
    */
   enum PropertyRange
@@ -68,7 +68,7 @@ public:
   };
 
   /**
-   * @brief An enumeration of properties belonging to the WidgetView class.
+   * @brief Enumeration for the instance of properties belonging to the WidgetView class.
    * @privlevel public
    * @privilege %http://tizen.org/privilege/widget.viewer
    * @SINCE_1_0.0
@@ -86,55 +86,55 @@ public:
       // Event side properties
 
       /**
-       * @brief name "widgetId", Get the id of the widget, type string, read-only
+       * @brief name "widgetId", Get the id of the widget, type string, read-only.
        * @SINCE_1_0.0
        */
       WIDGET_ID = PROPERTY_START_INDEX,
 
       /**
-       * @brief name "instanceId", type string, read-only
+       * @brief name "instanceId", type string, read-only.
        * @SINCE_1_0.0
        */
       INSTANCE_ID,
 
       /**
-       * @brief name "contentInfo", type string, read-only
+       * @brief name "contentInfo", type string, read-only.
        * @SINCE_1_0.0
        */
       CONTENT_INFO,
 
       /**
-       * @brief name "title", type string, read-only
+       * @brief name "title", type string, read-only.
        * @SINCE_1_0.0
        */
       TITLE,
 
       /**
-       * @brief name "updatePeriod", type float, read-only
+       * @brief name "updatePeriod", type float, read-only.
        * @SINCE_1_0.0
        */
       UPDATE_PERIOD,
 
       /**
-       * @brief name "preview", type boolean if it is a show/hide flag, map otherwise
+       * @brief name "preview", type boolean if it is a show/hide flag, map otherwise.
        * @SINCE_1_0.0
        */
       PREVIEW,
 
       /**
-       * @brief name "loadingText", type boolean if it is a show/hide flag, map otherwise
+       * @brief name "loadingText", type boolean if it is a show/hide flag, map otherwise.
        * @SINCE_1_0.0
        */
       LOADING_TEXT,
 
       /**
-       * @brief name "widgetStateFaulted", type boolean
+       * @brief name "widgetStateFaulted", type boolean.
        * @SINCE_1_0.0
        */
       WIDGET_STATE_FAULTED,
 
       /**
-       * @brief name "permanentDelete", type boolean
+       * @brief name "permanentDelete", type boolean.
        * @SINCE_1_0.0
        */
       PERMANENT_DELETE,
@@ -144,29 +144,29 @@ public:
 
 
   /**
-   * @brief Create widget view.
+   * @brief Creates a widget view.
    *
    * @since_tizen 3.0
    * @privlevel public
    * @privilege %http://tizen.org/privilege/widget.viewer
-   * @param[in] widgetId The widget id.
-   * @param[in] contentInfo Contents that will be given to the widget instance.
-   * @param[in] width The widget width.
-   * @param[in] height The widget height.
-   * @param[in] updatePeriod The period of updating contents of the widget.
-   * @return A handle to WidgetView.
+   * @param[in] widgetId The widget id
+   * @param[in] contentInfo Contents that will be given to the widget instance
+   * @param[in] width The widget width
+   * @param[in] height The widget height
+   * @param[in] updatePeriod The period of updating contents of the widget
+   * @return A handle to WidgetView
    */
   static WidgetView New( const std::string& widgetId, const std::string& contentInfo, int width, int height, float updatePeriod );
 
   /**
-   * @brief Downcast a handle to WidgetView handle.
+   * @brief Downcasts a handle to WidgetView handle.
    *
-   * If the BaseHandle points is a WidgetView the downcast returns a valid handle.
-   * If not the returned handle is left empty.
+   * If the BaseHandle points is a WidgetView, the downcast returns a valid handle.
+   * If not, the returned handle is left empty.
    *
    * @since_tizen 3.0
    * @param[in] handle Handle to an object
-   * @return handle to a WidgetView or an empty handle
+   * @return Handle to a WidgetView or an empty handle
    */
   static WidgetView DownCast( BaseHandle handle );
 
@@ -180,7 +180,7 @@ public:
    * @brief Copy constructor.
    *
    * @since_tizen 3.0
-   * @param[in] handle The handle to copy from.
+   * @param[in] handle The handle to copy from
    */
   WidgetView( const WidgetView& handle );
 
@@ -188,13 +188,13 @@ public:
    * @brief Assignment operator.
    *
    * @since_tizen 3.0
-   * @param[in] handle The handle to copy from.
-   * @return A reference to this.
+   * @param[in] handle The handle to copy from
+   * @return A reference to this
    */
   WidgetView& operator=( const WidgetView& handle );
 
   /**
-   * @brief Destructor
+   * @brief Destructor.
    *
    * This is non-virtual since derived Handle types must not contain data or virtual methods.
    * @since_tizen 3.0
@@ -207,17 +207,17 @@ public:
    * @since_tizen 3.0
    * @privlevel public
    * @privilege %http://tizen.org/privilege/widget.viewer
-   * @return true on success, false otherwise.
+   * @return @c true on success, @c false otherwise
    */
   bool PauseWidget();
 
   /**
-   * @brief Resume a given widget.
+   * @brief Resumes a given widget.
    *
    * @since_tizen 3.0
    * @privlevel public
    * @privilege %http://tizen.org/privilege/widget.viewer
-   * @return true on success, false otherwise.
+   * @return @c true on success, @c false otherwise
    */
   bool ResumeWidget();
 
@@ -229,12 +229,12 @@ public:
    * @since_tizen 3.0
    * @privlevel public
    * @privilege %http://tizen.org/privilege/widget.viewer
-   * @return true on success, false otherwise.
+   * @return @c true on success, @c false otherwise
    */
   bool CancelTouchEvent();
 
   /**
-   * @brief Activate a widget in faulted state.
+   * @brief Activates a widget in faulted state.
    * A widget in faulted state MUST be activated before adding the widget.
    *
    * @since_tizen 3.0
@@ -253,7 +253,7 @@ public: //Signals
    * @since_tizen 3.0
    * @privlevel public
    * @privilege %http://tizen.org/privilege/widget.viewer
-   * @return The signal to connect to.
+   * @return The signal to connect to
    */
   WidgetViewSignalType& WidgetAddedSignal();
 
@@ -263,7 +263,7 @@ public: //Signals
    * @since_tizen 3.0
    * @privlevel public
    * @privilege %http://tizen.org/privilege/widget.viewer
-   * @return The signal to connect to.
+   * @return The signal to connect to
    */
   WidgetViewSignalType& WidgetDeletedSignal();
 
@@ -273,7 +273,7 @@ public: //Signals
    * @since_tizen 3.0
    * @privlevel public
    * @privilege %http://tizen.org/privilege/widget.viewer
-   * @return The signal to connect to.
+   * @return The signal to connect to
    */
   WidgetViewSignalType& WidgetCreationAbortedSignal();
 
@@ -283,7 +283,7 @@ public: //Signals
    * @since_tizen 3.0
    * @privlevel public
    * @privilege %http://tizen.org/privilege/widget.viewer
-   * @return The signal to connect to.
+   * @return The signal to connect to
    */
   WidgetViewSignalType& WidgetContentUpdatedSignal();
 
@@ -293,7 +293,7 @@ public: //Signals
    * @since_tizen 3.0
    * @privlevel public
    * @privilege %http://tizen.org/privilege/widget.viewer
-   * @return The signal to connect to.
+   * @return The signal to connect to
    */
   WidgetViewSignalType& WidgetUpdatePeriodChangedSignal();
 
@@ -303,7 +303,7 @@ public: //Signals
    * @since_tizen 3.0
    * @privlevel public
    * @privilege %http://tizen.org/privilege/widget.viewer
-   * @return The signal to connect to.
+   * @return The signal to connect to
    */
   WidgetViewSignalType& WidgetFaultedSignal();
 
@@ -314,7 +314,7 @@ public: // Not intended for application developers
    * @brief Creates a handle using the WidgetView::Internal implementation.
    *
    * @since_tizen 3.0
-   * @param[in] implementation The WidgetView implementation.
+   * @param[in] implementation The WidgetView implementation
    */
   DALI_INTERNAL WidgetView( Internal::WidgetView& implementation );
 
@@ -323,7 +323,7 @@ public: // Not intended for application developers
    * @brief Allows the creation of this control from an Internal::CustomActor pointer.
    *
    * @since_tizen 3.0
-   * @param[in] internal A pointer to the internal CustomActor.
+   * @param[in] internal A pointer to the internal CustomActor
    */
   DALI_INTERNAL WidgetView( Dali::Internal::CustomActor* internal );
 };

diff --git a/widget_viewer_dali/public_api/widget_view_manager/widget_view_manager.h b/widget_viewer_dali/public_api/widget_view_manager/widget_view_manager.h
index c00ac94..5ca0ae7 100644 (file)
--- a/widget_viewer_dali/public_api/widget_view_manager/widget_view_manager.h
+++ b/widget_viewer_dali/public_api/widget_view_manager/widget_view_manager.h
@@ -52,26 +52,26 @@ class DALI_IMPORT_API WidgetViewManager : public BaseHandle
 public:
 
   /**
-   * @brief Create widget view manager.
+   * @brief Creates widget view manager.
    *
    * @since_tizen 3.0
    * @privlevel public
    * @privilege %http://tizen.org/privilege/widget.viewer
-   * @param[in] application Application class for the widget view manager.
-   * @param[in] appId App ID of app with widget viewer dali.
-   * @return A handle to WidgetViewManager.
+   * @param[in] application Application class for the widget view manager
+   * @param[in] appId App ID of app with widget viewer dali
+   * @return A handle to WidgetViewManager
    */
   static WidgetViewManager New( Application application, const std::string& appId );
 
   /**
-   * @brief Downcast a handle to WidgetViewManager handle.
+   * @brief Downcasts a handle to WidgetViewManager handle.
    *
-   * If the BaseHandle points is a WidgetViewManager the downcast returns a valid handle.
-   * If not the returned handle is left empty.
+   * If the BaseHandle points is a WidgetViewManager, the downcast returns a valid handle.
+   * If not, the returned handle is left empty.
    *
    * @since_tizen 3.0
    * @param[in] handle Handle to an object
-   * @return handle to a WidgetViewManager or an empty handle
+   * @return Handle to a WidgetViewManager or an empty handle
    */
   static WidgetViewManager DownCast( BaseHandle handle );
 
@@ -87,7 +87,7 @@ public:
    * @brief Copy constructor.
    *
    * @since_tizen 3.0
-   * @param[in] handle The handle to copy from.
+   * @param[in] handle The handle to copy from
    */
   WidgetViewManager( const WidgetViewManager& handle );
 
@@ -95,13 +95,13 @@ public:
    * @brief Assignment operator.
    *
    * @since_tizen 3.0
-   * @param[in] handle The handle to copy from.
-   * @return A reference to this.
+   * @param[in] handle The handle to copy from
+   * @return A reference to this
    */
   WidgetViewManager& operator=( const WidgetViewManager& handle );
 
   /**
-   * @brief Destructor
+   * @brief Destructor.
    *
    * This is non-virtual since derived Handle types must not contain data or virtual methods.
    * @since_tizen 3.0
@@ -109,17 +109,17 @@ public:
   ~WidgetViewManager();
 
   /**
-   * @brief Creates a new widget view object
+   * @brief Creates a new widget view object.
    *
    * @since_tizen 3.0
    * @privlevel public
    * @privilege %http://tizen.org/privilege/widget.viewer
-   * @param[in] widgetId The widget id.
-   * @param[in] contentInfo Contents that will be given to the widget instance.
-   * @param[in] width The widget width.
-   * @param[in] height The widget height.
-   * @param[in] updatePeriod The period of updating contents of the widget.
-   * @return A handle to WidgetView.
+   * @param[in] widgetId The widget id
+   * @param[in] contentInfo Contents that will be given to the widget instance
+   * @param[in] width The widget width
+   * @param[in] height The widget height
+   * @param[in] updatePeriod The period of updating contents of the widget
+   * @return A handle to WidgetView
    */
   WidgetView AddWidget( const std::string& widgetId, const std::string& contentInfo, int width, int height, float updatePeriod );
 
@@ -130,7 +130,7 @@ public: // Not intended for application developers
    * @brief Creates a handle using the WidgetView::Internal implementation.
    *
    * @since_tizen 3.0
-   * @param[in] implementation The WidgetViewManager implementation.
+   * @param[in] implementation The WidgetViewManager implementation
    */
   explicit DALI_INTERNAL WidgetViewManager( Internal::WidgetViewManager* implementation );
 };