Making DALi public API typesafe using guaranteed types; uint8_t, uint32_t

[platform/core/uifw/dali-core.git] / dali / public-api / signals / slot-delegate.h

diff --git a/dali/public-api/signals/slot-delegate.h b/dali/public-api/signals/slot-delegate.h
index 64529b0..8b5f260 100644 (file)
--- a/dali/public-api/signals/slot-delegate.h
+++ b/dali/public-api/signals/slot-delegate.h
@@ -2,7 +2,7 @@
 #define __DALI_SLOT_DELEGATE_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.
@@ -22,8 +22,12 @@
 #include <dali/public-api/common/dali-common.h>
 #include <dali/public-api/signals/connection-tracker.h>
 
-namespace Dali DALI_IMPORT_API
+namespace Dali
 {
+/**
+ * @addtogroup dali_core_signals
+ * @{
+ */
 
 /**
  * @brief SlotDelegates can be used to connect member functions to signals, without inheriting from SlotDelegateInterface.
@@ -66,6 +70,7 @@ namespace Dali DALI_IMPORT_API
  * };
  *
  * @endcode
+ * @SINCE_1_0.0
  */
 template <typename Slot>
 class SlotDelegate
@@ -75,7 +80,8 @@ public:
   /**
    * @brief Constructor.
    *
-   * @param[in] slot The object with a callback.
+   * @SINCE_1_0.0
+   * @param[in] slot The object with a callback
    */
   SlotDelegate( Slot* slot )
   : mSlot( slot )
@@ -85,14 +91,16 @@ public:
   /**
    * @brief Non-virtual destructor.
    *
+   * @SINCE_1_0.0
    */
   ~SlotDelegate()
   {
   }
 
   /**
-   * @brief Disconnect all signals from this object.
+   * @brief Disconnects all signals from this object.
    *
+   * @SINCE_1_0.0
    */
   void DisconnectAll()
   {
@@ -100,7 +108,7 @@ public:
   }
 
   /**
-   * @copydoc ConnectionTrackerInterface::GetConnectionCount
+   * @copydoc ConnectionTracker::GetConnectionCount
    */
   std::size_t GetConnectionCount() const
   {
@@ -108,9 +116,10 @@ public:
   }
 
   /**
-   * @brief Retrieve the slot object.
+   * @brief Retrieves the slot object.
    *
-   * @return The object with a callback.
+   * @SINCE_1_0.0
+   * @return The object with a callback
    */
   Slot* GetSlot()
   {
@@ -118,9 +127,10 @@ public:
   }
 
   /**
-   * @brief Retrieve the connection tracker component.
+   * @brief Retrieves the connection tracker component.
    *
-   * @return The connection tracker component.
+   * @SINCE_1_0.0
+   * @return The connection tracker component
    */
   ConnectionTracker* GetConnectionTracker()
   {
@@ -129,8 +139,8 @@ public:
 
 private:
 
-  SlotDelegate( const SlotDelegate& );            ///< undefined copy constructor
-  SlotDelegate& operator=( const SlotDelegate& ); ///< undefined assignment operator
+  SlotDelegate( const SlotDelegate& );            ///< undefined copy constructor @SINCE_1_0.0
+  SlotDelegate& operator=( const SlotDelegate& ); ///< undefined assignment operator @SINCE_1_0.0
 
 private:
 
@@ -140,6 +150,9 @@ private:
   ConnectionTracker mConnectionTracker; ///< A connection tracker
 };
 
+/**
+ * @}
+ */
 } // namespace Dali
 
 #endif // __DALI_SLOT_DELEGATE_H__