From: Seoyeon Kim Date: Tue, 28 Nov 2017 05:12:46 +0000 (+0900) Subject: Update doxygen comments X-Git-Tag: dali_1.3.2~9 X-Git-Url: http://review.tizen.org/git/?p=platform%2Fcore%2Fuifw%2Fdali-toolkit.git;a=commitdiff_plain;h=c5348b4691e24b20264fc8ad92a881f0118bb540 Update doxygen comments - Parameters of member Dali::Toolkit::ProgressBar are not documented. - Return type of member Dali::Toolkit::Control::ResourceReadySignal is not documented. - Member Type (enumeration) of namespace Dali::Toolkit::Visual::Transform::Policy is not documented. - To show some Visual Properties, added a comment in doxygen. Change-Id: Ieb5306330aee1bb18dff190863fab4439bad2913 Signed-off-by: Seoyeon Kim --- diff --git a/dali-toolkit/public-api/controls/control.h b/dali-toolkit/public-api/controls/control.h index eee3b91..58f3205 100644 --- a/dali-toolkit/public-api/controls/control.h +++ b/dali-toolkit/public-api/controls/control.h @@ -473,6 +473,7 @@ public: * @endcode * * @SINCE_1_2.60 + * @return The signal to connect to * @note A RelayoutRequest is queued by Control before this signal is emitted */ ResourceReadySignalType& ResourceReadySignal(); diff --git a/dali-toolkit/public-api/controls/progress-bar/progress-bar.h b/dali-toolkit/public-api/controls/progress-bar/progress-bar.h index 4d45740..ed4ceb2 100644 --- a/dali-toolkit/public-api/controls/progress-bar/progress-bar.h +++ b/dali-toolkit/public-api/controls/progress-bar/progress-bar.h @@ -64,11 +64,15 @@ public: }; /** - * @brief An enumeration of properties belonging to the ProgressBar class. + * @brief Enumeration of properties belonging to the ProgressBar class. * @SINCE_1_2.60 */ struct Property { + /** + * @brief Enumeration for the instance of properties belonging to the ProgressBar class. + * @SINCE_1_2.60 + */ enum { /** @@ -171,6 +175,7 @@ public: * * Creates another handle that points to the same real object. * @SINCE_1_2.60 + * @param[in] handle Handle to an object */ ProgressBar( const ProgressBar& handle ); @@ -179,6 +184,8 @@ public: * * Changes this handle to point to another real object. * @SINCE_1_2.60 + * @param[in] handle Handle to an object + * @return A reference to this */ ProgressBar& operator=( const ProgressBar& handle ); diff --git a/dali-toolkit/public-api/visuals/border-visual-properties.h b/dali-toolkit/public-api/visuals/border-visual-properties.h index 84470a9..3b6c99b 100644 --- a/dali-toolkit/public-api/visuals/border-visual-properties.h +++ b/dali-toolkit/public-api/visuals/border-visual-properties.h @@ -40,14 +40,14 @@ namespace BorderVisual { /** - * @brief BorderVisual Property + * @brief BorderVisual Property. * @SINCE_1_1.45 */ namespace Property { /** - * @brief BorderVisual Property + * @brief Enumeration for the instance of properties belonging to the BorderVisual. * @SINCE_1_1.45 */ enum diff --git a/dali-toolkit/public-api/visuals/color-visual-properties.h b/dali-toolkit/public-api/visuals/color-visual-properties.h index fb87e54..5f1aab9 100644 --- a/dali-toolkit/public-api/visuals/color-visual-properties.h +++ b/dali-toolkit/public-api/visuals/color-visual-properties.h @@ -40,14 +40,14 @@ namespace ColorVisual { /** - * @brief ColorVisual Property + * @brief ColorVisual Property. * @SINCE_1_1.45 */ namespace Property { /** - * @brief ColorVisual Property + * @brief Enumeration for the instance of properties belonging to the ColorVisual. * @SINCE_1_1.45 */ enum diff --git a/dali-toolkit/public-api/visuals/gradient-visual-properties.h b/dali-toolkit/public-api/visuals/gradient-visual-properties.h index ae895ca..cdfd624 100644 --- a/dali-toolkit/public-api/visuals/gradient-visual-properties.h +++ b/dali-toolkit/public-api/visuals/gradient-visual-properties.h @@ -40,14 +40,14 @@ namespace GradientVisual { /** - * @brief GradientVisual Property + * @brief GradientVisual Property. * @SINCE_1_1.45 */ namespace Property { /** - * @brief GradientVisual Property + * @brief Enumeration for the instance of properties belonging to the GradientVisual. * @SINCE_1_1.45 */ enum diff --git a/dali-toolkit/public-api/visuals/image-visual-properties.h b/dali-toolkit/public-api/visuals/image-visual-properties.h index 589a188..93902cf 100644 --- a/dali-toolkit/public-api/visuals/image-visual-properties.h +++ b/dali-toolkit/public-api/visuals/image-visual-properties.h @@ -40,14 +40,14 @@ namespace ImageVisual { /** - * @brief ImageVisual Property + * @brief ImageVisual Property. * @SINCE_1_1.45 */ namespace Property { /** - * @brief ImageVisual Property + * @brief Enumeration for the instance of properties belonging to the ImageVisual. * @SINCE_1_1.45 */ enum diff --git a/dali-toolkit/public-api/visuals/mesh-visual-properties.h b/dali-toolkit/public-api/visuals/mesh-visual-properties.h index 765fce7..f431207 100644 --- a/dali-toolkit/public-api/visuals/mesh-visual-properties.h +++ b/dali-toolkit/public-api/visuals/mesh-visual-properties.h @@ -40,14 +40,14 @@ namespace MeshVisual { /** - * @brief MeshVisual Property + * @brief MeshVisual Property. * @SINCE_1_1.45 */ namespace Property { /** - * @brief MeshVisual Property + * @brief Enumeration for the instance of properties belonging to the MeshVisual. * @SINCE_1_1.45 */ enum diff --git a/dali-toolkit/public-api/visuals/primitive-visual-properties.h b/dali-toolkit/public-api/visuals/primitive-visual-properties.h index 12f56e5..30477e8 100644 --- a/dali-toolkit/public-api/visuals/primitive-visual-properties.h +++ b/dali-toolkit/public-api/visuals/primitive-visual-properties.h @@ -40,14 +40,14 @@ namespace PrimitiveVisual { /** - * @brief PrimitiveVisual Property + * @brief PrimitiveVisual Property. * @SINCE_1_1.45 */ namespace Property { /** - * @brief PrimitiveVisual Property + * @brief Enumeration for the instance of properties belonging to the PrimitiveVisual. * @SINCE_1_1.45 */ enum diff --git a/dali-toolkit/public-api/visuals/text-visual-properties.h b/dali-toolkit/public-api/visuals/text-visual-properties.h index 10c4ab7..0eb7fba 100644 --- a/dali-toolkit/public-api/visuals/text-visual-properties.h +++ b/dali-toolkit/public-api/visuals/text-visual-properties.h @@ -32,15 +32,23 @@ namespace Toolkit */ /** - * @brief TextVisual Properties + * @brief TextVisual is to render a text. * @SINCE_1_2.60 */ namespace TextVisual { +/** + * @brief TextVisual Property. + * @SINCE_1_2.60 + */ namespace Property { +/** + * @brief Enumeration for the instance of properties belonging to the TextVisual. + * @SINCE_1_2.60 + */ enum { /** diff --git a/dali-toolkit/public-api/visuals/visual-properties.h b/dali-toolkit/public-api/visuals/visual-properties.h index 54a4350..94b504b 100644 --- a/dali-toolkit/public-api/visuals/visual-properties.h +++ b/dali-toolkit/public-api/visuals/visual-properties.h @@ -33,7 +33,7 @@ namespace Toolkit */ /** - * @brief All the visual types + * @brief All the visual types. * @SINCE_1_1.45 */ namespace Visual @@ -59,14 +59,14 @@ enum Type }; /** - * @brief Visual Property + * @brief Visual Property. * @SINCE_1_1.45 */ namespace Property { /** - * @brief Visual Property + * @brief Enumeration for the instance of properties belonging to the Visual Property. * @SINCE_1_1.45 */ enum @@ -128,28 +128,43 @@ enum } // namespace Property +/** + * @brief Visual Transfrom for the offset or size. + * @SINCE_1_2.60 + */ namespace Transform { /** * @brief Policies used by the transform for the offset or size. * @SINCE_1_2.60 - * */ namespace Policy { +/** + * @brief Enumeration for the type of Transform Policy. + * @SINCE_1_2.60 + */ enum Type { - RELATIVE = 0, ///< Relative to the control (percentage [0.0f to 1.0f] of the control). - ABSOLUTE = 1 ///< Absolute value in world units. + RELATIVE = 0, ///< Relative to the control (percentage [0.0f to 1.0f] of the control). @SINCE_1_2.60 + ABSOLUTE = 1 ///< Absolute value in world units. @SINCE_1_2.60 }; } // namespace Policy +/** + * @brief Visual Transform Property. + * @SINCE_1_2.60 + */ namespace Property { +/** + * @brief Enumeration for the type of Transfrom Property. + * @SINCE_1_2.60 + */ enum Type { /** @@ -237,21 +252,21 @@ enum Type } // namespace Transform /** - * @brief Shader for Visuals + * @brief Shader for Visuals. * @SINCE_1_1.45 */ namespace Shader { /** - * @brief Shader Property + * @brief Shader Property. * @SINCE_1_1.45 */ namespace Property { /** - * @brief The type of Shader + * @brief The type of Shader. * @SINCE_1_1.45 */ enum