[3.0] Update doxygen comments

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

diff --git a/dali/public-api/object/base-object.h b/dali/public-api/object/base-object.h
index 67172c3..01e5a27 100644 (file)
--- a/dali/public-api/object/base-object.h
+++ b/dali/public-api/object/base-object.h
@@ -27,7 +27,7 @@
 namespace Dali
 {
 /**
- * @addtogroup dali-core-object
+ * @addtogroup dali_core_object
  * @{
  */
 
@@ -35,6 +35,7 @@ class BaseHandle;
 
 /**
  * @brief A base class for objects.
+ * @SINCE_1_0.0
  */
 class DALI_IMPORT_API BaseObject : public Dali::RefObject
 {
@@ -43,11 +44,12 @@ public:
   /**
    * @brief Connects a void() functor to a specified signal.
    *
+   * @SINCE_1_0.0
+   * @param[in] connectionTracker A connection tracker which can be used to disconnect
+   * @param[in] signalName Name of the signal to connect to
+   * @param[in] functor The functor to copy
+   * @return True if the signal was available
    * @pre The signal must be available in this object.
-   * @param [in] connectionTracker A connection tracker which can be used to disconnect.
-   * @param [in] signalName Name of the signal to connect to.
-   * @param [in] functor The functor to copy.
-   * @return True if the signal was available.
    */
   template <class T>
   bool ConnectSignal( ConnectionTrackerInterface* connectionTracker, const std::string& signalName, const T& functor )
@@ -73,7 +75,13 @@ public:
 public: // Not intended for application developers
 
   /**
-   * @copydoc Dali::BaseHandle::DoConnectSignal
+   * @brief Not intended for application developers.
+   *
+   * @SINCE_1_0.0
+   * @param[in] connectionTracker A connection tracker which can be used to disconnect
+   * @param[in] signalName Name of the signal to connect to
+   * @param[in] functorDelegate A newly allocated functor delegate (takes ownership)
+   * @return True if the signal was available
    */
   bool DoConnectSignal( ConnectionTrackerInterface* connectionTracker, const std::string& signalName, FunctorDelegate* functorDelegate );
 
@@ -81,21 +89,25 @@ protected:
 
   /**
    * @brief Default constructor.
+   * @SINCE_1_0.0
    */
   BaseObject();
 
   /**
    * @brief A reference counted object may only be deleted by calling Unreference().
+   * @SINCE_1_0.0
    */
   virtual ~BaseObject();
 
   /**
    * @brief Registers the object as created with the Object registry.
+   * @SINCE_1_0.0
    */
   void RegisterObject();
 
   /**
    * @brief Unregisters the object from Object registry.
+   * @SINCE_1_0.0
    */
   void UnregisterObject();
 
@@ -111,10 +123,11 @@ private:
 // Helpers for public-api forwarding methods
 
 /**
- * @brief Get the implementation of a handle.
+ * @brief Gets the implementation of a handle.
  *
+ * @SINCE_1_0.0
  * @param[in] handle The handle
- * @return A reference to the object the handle points at.
+ * @return A reference to the object the handle points at
  */
 inline BaseObject& GetImplementation(Dali::BaseHandle& handle)
 {
@@ -124,10 +137,11 @@ inline BaseObject& GetImplementation(Dali::BaseHandle& handle)
 }
 
 /**
- * @brief Get the implementation of a handle.
+ * @brief Gets the implementation of a handle.
  *
+ * @SINCE_1_0.0
  * @param[in] handle The handle
- * @return A reference to the object the handle points at.
+ * @return A reference to the object the handle points at
  */
 inline const BaseObject& GetImplementation(const Dali::BaseHandle& handle)
 {