[3.0] Update doxygen tags

[platform/core/uifw/dali-core.git] / dali / public-api / object / base-handle.h

diff --git a/dali/public-api/object/base-handle.h b/dali/public-api/object/base-handle.h
index 5fe45df..8acba6d 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; // 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.
@@ -151,7 +158,8 @@ public:
    * @brief Returns the type info for the Handle.
    *
    * @SINCE_1_0.0
-   * @return The type info.
+   * @param[in] info The type information
+   * @return The type info
    */
   bool GetTypeInfo(Dali::TypeInfo& info) const;
 
@@ -248,6 +256,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 {}
@@ -259,10 +269,10 @@ private:
 };
 
 /**
- * @brief Template wrapper to downcast an base object handle to derived class handle.
+ * @brief Template wrapper to downcast a base object handle to derived class handle.
  *
  * @SINCE_1_0.0
- * @param handle to a base object
+ * @param[in] handle to a base object
  * @return handle pointer to either a valid deriving handle or an uninitialized handle
  * @pre The BaseHandle has been initialized.
  */
@@ -277,6 +287,9 @@ inline T DownCast( BaseHandle handle )
 /**
  * @brief Equality operator
  * @SINCE_1_0.0
+ * @param[in] lhs A reference to compare
+ * @param[in] rhs A reference to compare to
+ * @return true if the handle handles point to the same Dali resource, or if both are NULL
  */
 template <typename T>
 inline bool operator==(const BaseHandle& lhs, const T& rhs)
@@ -288,6 +301,9 @@ inline bool operator==(const BaseHandle& lhs, const T& rhs)
 /**
  * @brief Equality operator
  * @SINCE_1_0.0
+ * @param[in] lhs A reference to compare
+ * @param[in] rhs A reference to compare to
+ * @return true if the handle handles point to the different Dali resources
  */
 template <typename T>
 inline bool operator!=(const BaseHandle& lhs, const T& rhs)
@@ -299,6 +315,9 @@ inline bool operator!=(const BaseHandle& lhs, const T& rhs)
 /**
  * @brief Less than operator
  * @SINCE_1_0.0
+ * @param[in] lhs A reference to compare
+ * @param[in] rhs A reference to compare to
+ * @return true if lhs less than rhs
  */
 inline bool operator<(const BaseHandle& lhs, const BaseHandle& rhs)
 {