Updated non-capi public API documentation to new style.

[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 d11c991..2ebe192 100644 (file)
--- a/dali/public-api/object/type-info.h
+++ b/dali/public-api/object/type-info.h
@@ -17,6 +17,7 @@
 // limitations under the License.
 //
 
+
 // INTERNAL INCLUDES
 #include <dali/public-api/object/base-handle.h>
 
@@ -32,18 +33,21 @@ namespace Internal DALI_INTERNAL
 };
 
 /**
- * TypeInfo class for instantiation of registered types and introspection of
+ * @brief TypeInfo class for instantiation of registered types and introspection of
  * their actions and signals.
+ *
  * See TypeRegistry for methods of type registration and TypeInfo retrieval.
  */
 class TypeInfo : public BaseHandle
 {
 public:
-  typedef BaseHandle (*CreateFunction)();
-  typedef bool (*ActionFunction)(BaseObject*, const std::string&, const std::vector<Property::Value>&);
+  typedef BaseHandle (*CreateFunction)(); ///< Function signature for creating an instance of the associated object type.
+
+  typedef bool (*ActionFunction)(BaseObject*, const std::string&, const std::vector<Property::Value>&); ///< Function signature for creating scriptable actions
 
   /**
-   * Connects a callback function with the object's signals.
+   * @brief Connects a callback function with the object's signals.
+   *
    * @param[in] object The object providing the signal.
    * @param[in] tracker Used to disconnect the signal.
    * @param[in] signalName The signal to connect to.
@@ -54,7 +58,9 @@ public:
   typedef bool (*SignalConnectorFunctionV2)(BaseObject* object, ConnectionTrackerInterface* tracker, const std::string& signalName, FunctorDelegate* functor);
 
   /**
-   * Callback to set an event-thread only property @see PropertyRegistration
+   * @brief Callback to set an event-thread only property.
+   *
+   * @see PropertyRegistration.
    * @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.
@@ -62,22 +68,24 @@ public:
   typedef void (*SetPropertyFunction)( BaseObject* object, Property::Index index, const Property::Value& value );
 
   /**
-   * Callback to get the value of an event-thread only property @see PropertyRegistration
+   * @brief Callback to get the value of an event-thread only property.
+   *
+   * @see PropertyRegistration.
    * @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.
    */
   typedef Property::Value (*GetPropertyFunction)( BaseObject* object, Property::Index index );
 
-  typedef std::vector<std::string> NameContainer;
+  typedef std::vector<std::string> NameContainer; ///< Container of names for signals and actions
 
   /**
-   * Allows the creation of an empty TypeInfo handle.
+   * @brief Allows the creation of an empty TypeInfo handle.
    */
   TypeInfo();
 
   /**
-   * destructor.
+   * @brief destructor.
    */
   virtual ~TypeInfo();
 
@@ -87,37 +95,43 @@ public:
   using BaseHandle::operator=;
 
   /**
-   * Retrieve the type name for this type
+   * @brief Retrieve the type name for this type.
+   *
    * @return string name
    */
   const std::string& GetName();
 
   /**
-   * Retrieve the base type name for this type
+   * @brief Retrieve the base type name for this type.
+   *
    * @return string of base name
    */
   const std::string& GetBaseName();
 
   /**
-   * Create an object from this type
+   * @brief Create an object from this type.
+   *
    * @return the BaseHandle for the newly created object
    */
   BaseHandle CreateInstance();
 
   /**
-   * Retrieve the creator function for this type
+   * @brief Retrieve the creator function for this type.
+   *
    * @return the creator function
    */
   CreateFunction GetCreator();
 
   /**
-   * Retrieve the actions for this type
+   * @brief Retrieve the actions for this type.
+   *
    * @return Container of action names
    */
   NameContainer GetActions();
 
   /**
-   * Retrieve the signals for this type
+   * @brief Retrieve the signals for this type.
+   *
    * @return Container of signal names
    */
   NameContainer GetSignals();
@@ -125,14 +139,16 @@ public:
   // Properties
 
   /**
-   * Retrieve all the property indices for this type
+   * @brief Retrieve all the property indices for this type.
+   *
    * @param[out] indices Container of property indices
    * @note The container will be cleared
    */
   void GetPropertyIndices( Property::IndexContainer& indices ) const;
 
   /**
-   * Given a property index, retrieve the property name associated with it.
+   * @brief Given a property index, retrieve the property name associated with it.
+   *
    * @param[in] index The property index.
    * @return The name of the property at the given index.
    */
@@ -141,7 +157,8 @@ public:
 public: // Not intended for application developers
 
   /**
-   * This constructor is used by Dali Get() method
+   * @brief This constructor is used by Dali Get() method.
+   *
    * @param [in] typeInfo A pointer to a Dali resource
    */
   explicit DALI_INTERNAL TypeInfo(Internal::TypeInfo* typeInfo);