[3.0] Update doxygen tags
[platform/core/uifw/dali-core.git] / dali / public-api / object / base-handle.h
index 75a0c1b..8acba6d 100644 (file)
@@ -158,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;
 
@@ -271,7 +272,7 @@ private:
  * @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.
  */
@@ -286,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)
@@ -297,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)
@@ -308,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)
 {