Add descriptions and example codes

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

diff --git a/dali/public-api/actors/actor-enumerations.h b/dali/public-api/actors/actor-enumerations.h
index fea5c33f6b5eb1c42f3d1f01134f1ea72939206a..bed10d24042f91c4ecba745288625ecf5b0b9bfc 100644 (file)
--- 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 3ebf27690ed2285608bbd4f660621156db0a4d0b..a34cc75b2dbb03f84a983d01270dd62826d0b02d 100644 (file)
--- a/dali/public-api/actors/actor.h
+++ b/dali/public-api/actors/actor.h
@@ -147,13 +147,7 @@ typedef Rect<float> 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().
  *
  * <i>Touch or hover Event Delivery:</i>
  *

diff --git a/dali/public-api/actors/camera-actor.h b/dali/public-api/actors/camera-actor.h
index 8a48292a1a0718afaa8773c37c3186f58186304d..adbba61020568c42c69878404f7596c5ff1db67d 100644 (file)
--- 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/events/long-press-gesture-detector.h b/dali/public-api/events/long-press-gesture-detector.h
index 2fa4e3939f4184e00036f43b10e62af2d89f0b25..a0502c50ab49f86244badc676a64718dee2c967c 100644 (file)
--- 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 6f8c294ad0eb58fd80f6ad1cca311cf501fcccef..aa1bfc299b96b2867c159b031e34561e54b4a95b 100644 (file)
--- 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 1cafbc1a3829fe030a1b6ca423d72eb4a32075b3..087e7ba4eba75b160c6828772a711d1e4cda6cd9 100644 (file)
--- 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; // Type is Property Map
+   * 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 561c847dc0eef5aa47f277afffd358bac327910c..788d16f1e1a00b0d2c383b76d36e1d2c6c38cf20 100644 (file)
--- a/doc/dali-core-doc.h
+++ b/doc/dali-core-doc.h
@@ -40,7 +40,7 @@
  * </tr>
  * <tr>
  *    <td>@ref dali_core_animation</td>
- *    <td>Animation allows your objects to move around / change their properties for a specified duration.</td>
+ *    <td>Classes for animation which allows your objects to move around / change their properties for a specified duration.</td>
  * </tr>
  * <tr>
  *    <td>@ref dali_core_common</td>
@@ -48,7 +48,7 @@
  * </tr>
  * <tr>
  *    <td>@ref dali_core_events</td>
- *    <td>Input events and gestures supported by DALi.</td>
+ *    <td>Classes for input events and gestures supported by DALi.</td>
  * </tr>
  * <tr>
  *    <td>@ref dali_core_images</td>
@@ -56,7 +56,7 @@
  * </tr>
  * <tr>
  *    <td>@ref dali_core_math</td>
- *    <td>Basic math classes.</td>
+ *    <td>Classes for basic math.</td>
  * </tr>
  * <tr>
  *    <td>@ref dali_core_object</td>
@@ -64,7 +64,7 @@
  * </tr>
  * <tr>
  *    <td>@ref dali_core_rendering_effects</td>
- *    <td>Render task and shader effect classes.</td>
+ *    <td>Classes for render task and shader effect.</td>
  * </tr>
  * <tr>
  *    <td>@ref dali_core_signals</td>
@@ -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.