[3.0] Add missed doxygen documentation

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

diff --git a/dali/public-api/object/type-registry.h b/dali/public-api/object/type-registry.h
index 64dd738..a44f376 100644 (file)
--- a/dali/public-api/object/type-registry.h
+++ b/dali/public-api/object/type-registry.h
@@ -2,7 +2,7 @@
 #define __DALI_TYPE_REGISTRY_H__
 
 /*
- * Copyright (c) 2015 Samsung Electronics Co., Ltd.
+ * Copyright (c) 2016 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.
@@ -163,6 +163,7 @@ public:
    * @brief Get type names by index.
    *
    * @SINCE_1_0.0
+   * @param[in] index The index to get the type name
    * @return The type name or an empty string when index is not valid
    */
   std::string GetTypeName(size_t index) const;
@@ -170,6 +171,7 @@ public:
 public: // Not intended for application developers
 
   /**
+   * @internal
    * @brief This constructor is used by Dali Get() method.
    *
    * @SINCE_1_0.0
@@ -383,6 +385,30 @@ public:
 };
 
 /**
+ * @brief Register a child property for the given type.
+ * @SINCE_1_1.35
+ */
+class DALI_IMPORT_API ChildPropertyRegistration
+{
+public:
+
+  /**
+   * @brief This constructor registers an event-thread only child property (i.e. a property
+   * that the parent supports in its children) with the registered type.
+   *
+   * @SINCE_1_1.35
+   * @param [in] registered The TypeRegistration object
+   * @param [in] name The name of the property
+   * @param [in] index The property index. Must be a value between CHILD_PROPERTY_REGISTRATION_START_INDEX and CHILD_PROPERTY_REGISTRATION_MAX_INDEX inclusive.
+   * @param [in] type The property value type.
+   *
+   * @pre "registered" must be registered with the TypeRegistry.
+   */
+  ChildPropertyRegistration( TypeRegistration& registered, const std::string& name, Property::Index index, Property::Type type );
+};
+
+
+/**
  * @}
  */
 } // namespace Dali