Revert "[3.0] Exclude internal tag module in Public API reference"

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

diff --git a/dali/public-api/object/type-info.h b/dali/public-api/object/type-info.h
index 625f0bf..fbdcfab 100644 (file)
--- a/dali/public-api/object/type-info.h
+++ b/dali/public-api/object/type-info.h
@@ -26,7 +26,7 @@
 namespace Dali
 {
 /**
- * @addtogroup dali-core-object
+ * @addtogroup dali_core_object
  * @{
  */
 
@@ -43,17 +43,19 @@ namespace Internal DALI_INTERNAL
  * their actions and signals.
  *
  * See TypeRegistry for methods of type registration and TypeInfo retrieval.
+ * @SINCE_1_0.0
  */
 class DALI_IMPORT_API TypeInfo : public BaseHandle
 {
 public:
-  typedef BaseHandle (*CreateFunction)(); ///< Function signature for creating an instance of the associated object type.
+  typedef BaseHandle (*CreateFunction)(); ///< Function signature for creating an instance of the associated object type. @SINCE_1_0.0
 
-  typedef bool (*ActionFunction)(BaseObject*, const std::string&, const Property::Map&); ///< Function signature for creating scriptable actions
+  typedef bool (*ActionFunction)(BaseObject*, const std::string&, const Property::Map&); ///< Function signature for creating scriptable actions @SINCE_1_0.0
 
   /**
    * @brief Connects a callback function with the object's signals.
    *
+   * @SINCE_1_0.0
    * @param[in] object The object providing the signal.
    * @param[in] tracker Used to disconnect the signal.
    * @param[in] signalName The signal to connect to.
@@ -66,25 +68,28 @@ public:
   /**
    * @brief Callback to set an event-thread only property.
    *
-   * @see PropertyRegistration.
+   * @SINCE_1_0.0
    * @param[in] object The object whose property should be set.
    * @param[in] index The index of the property being set.
    * @param[in] value The new value of the property for the object specified.
+   * @see PropertyRegistration.
    */
   typedef void (*SetPropertyFunction)( BaseObject* object, Property::Index index, const Property::Value& value );
 
   /**
    * @brief Callback to get the value of an event-thread only property.
    *
-   * @see PropertyRegistration.
+   * @SINCE_1_0.0
    * @param[in] object The object whose property value is required.
    * @param[in] index The index of the property required.
    * @return The current value of the property for the object specified.
+   * @see PropertyRegistration.
    */
   typedef Property::Value (*GetPropertyFunction)( BaseObject* object, Property::Index index );
 
   /**
    * @brief Allows the creation of an empty TypeInfo handle.
+   * @SINCE_1_0.0
    */
   TypeInfo();
 
@@ -92,12 +97,14 @@ public:
    * @brief Destructor
    *
    * This is non-virtual since derived Handle types must not contain data or virtual methods.
+   * @SINCE_1_0.0
    */
   ~TypeInfo();
 
   /**
    * @brief This copy constructor is required for (smart) pointer semantics.
    *
+   * @SINCE_1_0.0
    * @param [in] handle A reference to the copied handle
    */
   TypeInfo(const TypeInfo& handle);
@@ -105,6 +112,7 @@ public:
   /**
    * @brief This assignment operator is required for (smart) pointer semantics.
    *
+   * @SINCE_1_0.0
    * @param [in] rhs  A reference to the copied handle
    * @return A reference to this
    */
@@ -113,6 +121,7 @@ public:
   /**
    * @brief Retrieve the type name for this type.
    *
+   * @SINCE_1_0.0
    * @return string name
    */
   const std::string& GetName() const;
@@ -120,6 +129,7 @@ public:
   /**
    * @brief Retrieve the base type name for this type.
    *
+   * @SINCE_1_0.0
    * @return string of base name
    */
   const std::string& GetBaseName() const;
@@ -127,6 +137,7 @@ public:
   /**
    * @brief Create an object from this type.
    *
+   * @SINCE_1_0.0
    * @return the BaseHandle for the newly created object
    */
   BaseHandle CreateInstance() const;
@@ -134,6 +145,7 @@ public:
   /**
    * @brief Retrieve the creator function for this type.
    *
+   * @SINCE_1_0.0
    * @return the creator function
    */
   CreateFunction GetCreator() const;
@@ -141,6 +153,7 @@ public:
   /**
    * @brief Retrieve the number of actions for this type.
    *
+   * @SINCE_1_0.0
    * @return The count
    */
   size_t GetActionCount() const;
@@ -148,6 +161,7 @@ public:
   /**
    * @brief Retrieve the action name for the index.
    *
+   * @SINCE_1_0.0
    * @param[in] index Index to lookup
    * @return action name or empty string where index is invalid
    */
@@ -156,6 +170,7 @@ public:
   /**
    * @brief Retrieve the number of signals for this type.
    *
+   * @SINCE_1_0.0
    * @return The count
    */
   size_t GetSignalCount() const;
@@ -163,6 +178,7 @@ public:
   /**
    * @brief Retrieve the signal name for the index.
    *
+   * @SINCE_1_0.0
    * @param[in] index Index to lookup
    * @return signal name or empty string where index is invalid
    */
@@ -172,6 +188,7 @@ public:
    * @brief Retrieve the number of event side type registered properties for this type.
    *
    * This count does not include all properties
+   * @SINCE_1_0.0
    * @return The count
    */
   size_t GetPropertyCount() const;
@@ -181,6 +198,7 @@ public:
   /**
    * @brief Retrieve all the property indices for this type.
    *
+   * @SINCE_1_0.0
    * @param[out] indices Container of property indices
    * @note The container will be cleared
    */
@@ -189,10 +207,11 @@ public:
   /**
    * @brief Given a property index, retrieve the property name associated with it.
    *
-   * @exception DaliException If index is not valid.
-   *
+   * @SINCE_1_0.0
    * @param[in] index The property index.
    * @return The name of the property at the given index.
+   * @exception DaliException If index is not valid.
+   *
    */
   const std::string& GetPropertyName( Property::Index index ) const;
 
@@ -201,6 +220,7 @@ public: // Not intended for application developers
   /**
    * @brief This constructor is used by Dali Get() method.
    *
+   * @SINCE_1_0.0
    * @param [in] typeInfo A pointer to a Dali resource
    */
   explicit DALI_INTERNAL TypeInfo(Internal::TypeInfo* typeInfo);