From 8012303630e32792e3f8acd1318244932fa0e81c Mon Sep 17 00:00:00 2001 From: Seoyeon Kim Date: Tue, 22 Nov 2016 17:17:11 +0900 Subject: [PATCH] Prevent API generate warning log - The doxygen warning log said some Property enumerations of class are not documented. Change-Id: I698f527d78557ad512e3a84d7a92142cba2a23ab Signed-off-by: Seoyeon Kim --- dali/public-api/actors/actor.h | 4 ++++ dali/public-api/actors/camera-actor.h | 6 ++++++ dali/public-api/actors/layer.h | 7 ++++++- dali/public-api/animation/linear-constrainer.h | 4 ++++ dali/public-api/animation/path.h | 4 ++++ dali/public-api/events/pan-gesture-detector.h | 4 ++++ dali/public-api/render-tasks/render-task.h | 4 ++++ dali/public-api/rendering/renderer.h | 5 +++++ dali/public-api/rendering/shader.h | 4 ++++ 9 files changed, 41 insertions(+), 1 deletion(-) diff --git a/dali/public-api/actors/actor.h b/dali/public-api/actors/actor.h index 79344e5..a3a0a20 100644 --- a/dali/public-api/actors/actor.h +++ b/dali/public-api/actors/actor.h @@ -248,6 +248,10 @@ public: */ struct Property { + /** + * @brief An enumeration of properties belonging to the Actor class. + * @SINCE_1_0.0 + */ enum { PARENT_ORIGIN = DEFAULT_ACTOR_PROPERTY_START_INDEX, ///< name "parentOrigin", type Vector3 (constraint-input) @SINCE_1_0.0 diff --git a/dali/public-api/actors/camera-actor.h b/dali/public-api/actors/camera-actor.h index adbba61..1350f2a 100644 --- a/dali/public-api/actors/camera-actor.h +++ b/dali/public-api/actors/camera-actor.h @@ -88,6 +88,12 @@ public: */ struct Property { + /** + * @brief An enumeration of properties belonging to the CameraActor class. + * + * Properties additional to Actor. + * @SINCE_1_0.0 + */ enum { TYPE = DEFAULT_DERIVED_ACTOR_PROPERTY_START_INDEX, ///< name "type", type std::string @SINCE_1_0.0 diff --git a/dali/public-api/actors/layer.h b/dali/public-api/actors/layer.h index 13d038d..1480db4 100644 --- a/dali/public-api/actors/layer.h +++ b/dali/public-api/actors/layer.h @@ -85,11 +85,16 @@ public: * @brief An enumeration of properties belonging to the Layer class. * * Properties additional to Actor. - * * @SINCE_1_0.0 */ struct Property { + /** + * @brief An enumeration of properties belonging to the Layer class. + * + * Properties additional to Actor. + * @SINCE_1_0.0 + */ enum { CLIPPING_ENABLE = DEFAULT_DERIVED_ACTOR_PROPERTY_START_INDEX, ///< name "clippingEnable", type bool @SINCE_1_0.0 diff --git a/dali/public-api/animation/linear-constrainer.h b/dali/public-api/animation/linear-constrainer.h index a0aa186..39956c0 100644 --- a/dali/public-api/animation/linear-constrainer.h +++ b/dali/public-api/animation/linear-constrainer.h @@ -64,6 +64,10 @@ public: */ struct Property { + /** + * @brief An enumeration of properties belonging to the LinearConstrainer class. + * @SINCE_1_0.0 + */ enum { VALUE = DEFAULT_OBJECT_PROPERTY_START_INDEX, ///< name "value" type Array of float @SINCE_1_0.0 diff --git a/dali/public-api/animation/path.h b/dali/public-api/animation/path.h index 6827d65..a0a5bfd 100644 --- a/dali/public-api/animation/path.h +++ b/dali/public-api/animation/path.h @@ -51,6 +51,10 @@ public: */ struct Property { + /** + * @brief An enumeration of properties belonging to the Path class. + * @SINCE_1_0.0 + */ enum { POINTS = DEFAULT_OBJECT_PROPERTY_START_INDEX, ///< name "points", type Vector3 @SINCE_1_0.0 diff --git a/dali/public-api/events/pan-gesture-detector.h b/dali/public-api/events/pan-gesture-detector.h index 9eb7d73..13e7678 100644 --- a/dali/public-api/events/pan-gesture-detector.h +++ b/dali/public-api/events/pan-gesture-detector.h @@ -73,6 +73,10 @@ public: */ struct Property { + /** + * @brief An enumeration of properties belonging to the PanGestureDetector class. + * @SINCE_1_0.0 + */ enum { SCREEN_POSITION = DEFAULT_GESTURE_DETECTOR_PROPERTY_START_INDEX, ///< name "screenPosition", type Vector2 @SINCE_1_0.0 diff --git a/dali/public-api/render-tasks/render-task.h b/dali/public-api/render-tasks/render-task.h index ac9f97a..52830e8 100644 --- a/dali/public-api/render-tasks/render-task.h +++ b/dali/public-api/render-tasks/render-task.h @@ -91,6 +91,10 @@ public: */ struct Property { + /** + * @brief An enumeration of properties belonging to the RenderTask class. + * @SINCE_1_0.0 + */ enum { /** diff --git a/dali/public-api/rendering/renderer.h b/dali/public-api/rendering/renderer.h index c5a0d8c..87f852b 100644 --- a/dali/public-api/rendering/renderer.h +++ b/dali/public-api/rendering/renderer.h @@ -234,9 +234,14 @@ public: /** * @brief An enumeration of properties belonging to the Renderer class. + * @SINCE_1_1.43 */ struct Property { + /** + * @brief An enumeration of properties belonging to the Renderer class. + * @SINCE_1_1.43 + */ enum { /** diff --git a/dali/public-api/rendering/shader.h b/dali/public-api/rendering/shader.h index 7fffc68..15eb161 100644 --- a/dali/public-api/rendering/shader.h +++ b/dali/public-api/rendering/shader.h @@ -96,6 +96,10 @@ public: */ struct Property { + /** + * @brief An enumeration of properties belonging to the Shader class. + * @SINCE_1_1.43 + */ enum { /** -- 2.7.4