Merge branch 'devel/master' into tizen

[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 ac0d786..6bed9d4 100644 (file)
--- a/dali/public-api/object/base-object.h
+++ b/dali/public-api/object/base-object.h
@@ -2,7 +2,7 @@
 #define __DALI_BASE_OBJECT_H__
 
 /*
- * Copyright (c) 2014 Samsung Electronics Co., Ltd.
+ * Copyright (c) 2015 Samsung Electronics Co., Ltd.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -24,26 +24,32 @@
 #include <dali/public-api/object/property.h>
 #include <dali/public-api/signals/functor-delegate.h>
 
-namespace Dali DALI_IMPORT_API
+namespace Dali
 {
+/**
+ * @addtogroup dali_core_object
+ * @{
+ */
 
 class BaseHandle;
 
 /**
  * @brief A base class for objects.
+ * @SINCE_1_0.0
  */
-class BaseObject : public Dali::RefObject
+class DALI_IMPORT_API BaseObject : public Dali::RefObject
 {
 public:
 
   /**
    * @brief Connects a void() functor to a specified signal.
    *
-   * @pre The signal must be available in this object.
+   * @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.
    */
   template <class T>
   bool ConnectSignal( ConnectionTrackerInterface* connectionTracker, const std::string& signalName, const T& functor )
@@ -54,7 +60,7 @@ public:
   /**
    * @copydoc Dali::BaseHandle::DoAction
    */
-  bool DoAction(const std::string& actionName, const std::vector<Property::Value>& attributes);
+  bool DoAction(const std::string& actionName, const Property::Map& attributes);
 
   /**
    * @copydoc Dali::BaseHandle::GetTypeName
@@ -69,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 allocatated functor delegate (takes ownership).
+   * @return True if the signal was available.
    */
   bool DoConnectSignal( ConnectionTrackerInterface* connectionTracker, const std::string& signalName, FunctorDelegate* functorDelegate );
 
@@ -77,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();
 
@@ -109,6 +125,7 @@ private:
 /**
  * @brief Get the implementation of a handle.
  *
+ * @SINCE_1_0.0
  * @param[in] handle The handle
  * @return A reference to the object the handle points at.
  */
@@ -122,6 +139,7 @@ inline BaseObject& GetImplementation(Dali::BaseHandle& handle)
 /**
  * @brief Get the implementation of a handle.
  *
+ * @SINCE_1_0.0
  * @param[in] handle The handle
  * @return A reference to the object the handle points at.
  */
@@ -132,6 +150,9 @@ inline const BaseObject& GetImplementation(const Dali::BaseHandle& handle)
   return handle.GetBaseObject();
 }
 
+/**
+ * @}
+ */
 } // namespace Dali
 
 # endif // __DALI_BASE_OBJECT_H__