From d24adfe7051e62ca7956ffcfa4bdbdb16d1269e5 Mon Sep 17 00:00:00 2001 From: Seoyeon Kim Date: Wed, 3 Aug 2016 13:21:15 +0900 Subject: [PATCH] [3.0] Add descriptions and example codes Change-Id: I31918f8b48745042cb3513b60fc2a4120efda8a7 Signed-off-by: Seoyeon Kim --- dali/public-api/actors/actor-enumerations.h | 2 +- dali/public-api/actors/actor.h | 8 +------- dali/public-api/actors/camera-actor.h | 2 +- dali/public-api/common/view-mode.h | 1 + .../events/long-press-gesture-detector.h | 1 - dali/public-api/events/tap-gesture-detector.h | 3 ++- dali/public-api/object/base-handle.h | 9 +++++++++ doc/dali-core-doc.h | 16 ++++++++-------- 8 files changed, 23 insertions(+), 19 deletions(-) diff --git a/dali/public-api/actors/actor-enumerations.h b/dali/public-api/actors/actor-enumerations.h index fea5c33f6..bed10d240 100644 --- a/dali/public-api/actors/actor-enumerations.h +++ b/dali/public-api/actors/actor-enumerations.h @@ -82,7 +82,7 @@ namespace ResizePolicy enum Type { FIXED, ///< Size is fixed as set by SetSize @SINCE_1_0.0 - USE_NATURAL_SIZE, ///< Size is to use the actor's natural size @SINCE_1_0.0 + USE_NATURAL_SIZE, ///< Size is to use the actor's natural size @SINCE_1_0.0 @see Actor::GetNaturalSize() FILL_TO_PARENT, ///< Size is to fill up to the actor's parent's bounds. Aspect ratio is not maintained. @SINCE_1_0.0 SIZE_RELATIVE_TO_PARENT, ///< The actors size will be ( ParentSize * SizeRelativeToParentFactor ). @SINCE_1_0.0 SIZE_FIXED_OFFSET_FROM_PARENT, ///< The actors size will be ( ParentSize + SizeRelativeToParentFactor ). @SINCE_1_0.0 diff --git a/dali/public-api/actors/actor.h b/dali/public-api/actors/actor.h index 2008faf1c..10402188b 100644 --- a/dali/public-api/actors/actor.h +++ b/dali/public-api/actors/actor.h @@ -147,13 +147,7 @@ typedef Rect Padding; ///< Padding definition @SINCE_1_0.0 * * Hit Priority of above Actor tree (all overlays): 1 - Lowest. 6 - Highest. * @endcode - * - Stencil Actors can be used to influence the result of hits on renderable actors within a layer. - * If a Stencil Actor exists on a layer and that Actor is marked visible then a successful - * hit on a renderable actor can only take place in the area that the stencil Actor marks as visible. - * The hit can be in any Stencil Actor in that layer, but must be in the region of one of them. - * Stencil Actor inheritance behaves as with rendering in that any child of a Stencil Actor will - * also be considered a Stencil Actor. - * Non-renderable actors can be hit regardless of whether a stencil actor is hit or not. + * For more information, see SetDrawMode(). * * Touch or hover Event Delivery: * diff --git a/dali/public-api/actors/camera-actor.h b/dali/public-api/actors/camera-actor.h index 8e1967394..8cf1cd26c 100644 --- a/dali/public-api/actors/camera-actor.h +++ b/dali/public-api/actors/camera-actor.h @@ -61,7 +61,7 @@ enum ProjectionMode } // namespace Camera /** - * @brief Controls a camera. + * @brief CameraActor controls a camera. * * Allows the developer to use actor semantics to control a camera. * diff --git a/dali/public-api/common/view-mode.h b/dali/public-api/common/view-mode.h index 0bab312c9..12438ae38 100644 --- a/dali/public-api/common/view-mode.h +++ b/dali/public-api/common/view-mode.h @@ -28,6 +28,7 @@ namespace Dali /** * @brief Stereoscopic view modes * @SINCE_1_0.0 + * @remarks Viewmode is supported in mobile applications only. */ enum ViewMode { diff --git a/dali/public-api/events/long-press-gesture-detector.h b/dali/public-api/events/long-press-gesture-detector.h index 7c3cc1fdc..8a884d599 100644 --- a/dali/public-api/events/long-press-gesture-detector.h +++ b/dali/public-api/events/long-press-gesture-detector.h @@ -39,7 +39,6 @@ struct LongPressGesture; /** * @brief This class emits a signals when a long press gesture occurs that meets the requirements set by the application. * @SINCE_1_0.0 - * @see LongPressGestureDetector::SetTouchesRequired. * * For any valid long press, two signals will be emitted: * - First identifying the beginning (state = Started) i.e. when fingers held down for the required time. diff --git a/dali/public-api/events/tap-gesture-detector.h b/dali/public-api/events/tap-gesture-detector.h index 537aa5e0d..8d5587158 100644 --- a/dali/public-api/events/tap-gesture-detector.h +++ b/dali/public-api/events/tap-gesture-detector.h @@ -54,7 +54,8 @@ struct TapGesture; * @endcode * * @SINCE_1_0.0 - * @note Multi-touch taps are not currently supported. However, multiple taps (double & triple tap etc.) are supported. + * @note Multi-touch taps (two or more points of contact with the surface) are not currently + * supported. However, multiple taps (double & triple tap etc.) are supported. * * Signals * | %Signal Name | Method | diff --git a/dali/public-api/object/base-handle.h b/dali/public-api/object/base-handle.h index 1cafbc1a3..75a0c1b8e 100644 --- a/dali/public-api/object/base-handle.h +++ b/dali/public-api/object/base-handle.h @@ -129,6 +129,13 @@ public: /** * @brief Perform action on this object with the given action name and attributes. * + * Usage example: - + * @code + * BaseHandle handle = SomeClass::New(); // Initialized with New() method + * + * Property::Map attributes; // Use empty Property::Map because "show" action doesn't need parameter + * handle.DoAction("show", attributes); + * @endcode * @SINCE_1_0.0 * @param [in] actionName The command for the action. * @param [in] attributes The list of attributes for the action. @@ -248,6 +255,8 @@ protected: /** * @brief Used by the safe bool idiom. * + * The safe bool idiom basically provides a Boolean test for classes. It validates objects + * in a boolean context without the usual harmful side effects. * @SINCE_1_0.0 */ void ThisIsSaferThanReturningVoidStar() const {} diff --git a/doc/dali-core-doc.h b/doc/dali-core-doc.h index 561c847dc..788d16f1e 100644 --- a/doc/dali-core-doc.h +++ b/doc/dali-core-doc.h @@ -40,7 +40,7 @@ * * * @ref dali_core_animation - * Animation allows your objects to move around / change their properties for a specified duration. + * Classes for animation which allows your objects to move around / change their properties for a specified duration. * * * @ref dali_core_common @@ -48,7 +48,7 @@ * * * @ref dali_core_events - * Input events and gestures supported by DALi. + * Classes for input events and gestures supported by DALi. * * * @ref dali_core_images @@ -56,7 +56,7 @@ * * * @ref dali_core_math - * Basic math classes. + * Classes for basic math. * * * @ref dali_core_object @@ -64,7 +64,7 @@ * * * @ref dali_core_rendering_effects - * Render task and shader effect classes. + * Classes for render task and shader effect. * * * @ref dali_core_signals @@ -94,25 +94,25 @@ * @brief Actor is the primary object for interaction in DALi applications. * @defgroup dali_core_animation Animation - * @brief Animation allows your objects to move around / change their properties for a specified duration. + * @brief Classes for animation which allows your objects to move around / change their properties for a specified duration. * @defgroup dali_core_common Common * @brief Common classes for using DALi. * @defgroup dali_core_events Events - * @brief Input events and gestures supported by DALi. + * @brief Classes for input events and gestures supported by DALi. * @defgroup dali_core_images Images * @brief Classes for handling resource images. * @defgroup dali_core_math Math - * @brief Basic math classes. + * @brief Classes for basic math. * @defgroup dali_core_object Object * @brief Classes for the handle/body pattern and property system. * @defgroup dali_core_rendering_effects Rendering & Effect - * @brief Render task and shader effect classes. + * @brief Classes for render task and shader effect. * @defgroup dali_core_signals Signal * @brief Classes for the signal and slot structure. -- 2.34.1