* @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.
- * @param[in] functor A newly allocated FunctorDelegate.
- * @return True if the signal was connected.
+ * @param[in] object The object providing the signal
+ * @param[in] tracker Used to disconnect the signal
+ * @param[in] signalName The signal to connect to
+ * @param[in] functor A newly allocated FunctorDelegate
+ * @return True if the signal was connected
* @post If a signal was connected, ownership of functor was passed to CallbackBase. Otherwise the caller is responsible for deleting the unused functor.
*/
typedef bool (*SignalConnectorFunction)(BaseObject* object, ConnectionTrackerInterface* tracker, const std::string& signalName, FunctorDelegate* functor);
* @brief Callback to set an event-thread only property.
*
* @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.
+ * @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.
*
* @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.
+ * @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 );
TypeInfo();
/**
- * @brief Destructor
+ * @brief Destructor.
*
* This is non-virtual since derived Handle types must not contain data or virtual methods.
* @SINCE_1_0.0
* @brief This copy constructor is required for (smart) pointer semantics.
*
* @SINCE_1_0.0
- * @param [in] handle A reference to the copied handle
+ * @param[in] handle A reference to the copied handle
*/
TypeInfo(const TypeInfo& handle);
* @brief This assignment operator is required for (smart) pointer semantics.
*
* @SINCE_1_0.0
- * @param [in] rhs A reference to the copied handle
+ * @param[in] rhs A reference to the copied handle
* @return A reference to this
*/
TypeInfo& operator=(const TypeInfo& rhs);
/**
- * @brief Retrieve the type name for this type.
+ * @brief Retrieves the type name for this type.
*
* @SINCE_1_0.0
- * @return string name
+ * @return String name
*/
const std::string& GetName() const;
/**
- * @brief Retrieve the base type name for this type.
+ * @brief Retrieves the base type name for this type.
*
* @SINCE_1_0.0
- * @return string of base name
+ * @return String of base name
*/
const std::string& GetBaseName() const;
/**
- * @brief Create an object from this type.
+ * @brief Creates an object from this type.
*
* @SINCE_1_0.0
- * @return the BaseHandle for the newly created object
+ * @return The BaseHandle for the newly created object
*/
BaseHandle CreateInstance() const;
/**
- * @brief Retrieve the creator function for this type.
+ * @brief Retrieves the creator function for this type.
*
* @SINCE_1_0.0
- * @return the creator function
+ * @return The creator function
*/
CreateFunction GetCreator() const;
/**
- * @brief Retrieve the number of actions for this type.
+ * @brief Retrieves the number of actions for this type.
*
* @SINCE_1_0.0
* @return The count
size_t GetActionCount() const;
/**
- * @brief Retrieve the action name for the index.
+ * @brief Retrieves 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
+ * @return Action name or empty string where index is invalid
*/
std::string GetActionName(size_t index);
/**
- * @brief Retrieve the number of signals for this type.
+ * @brief Retrieves the number of signals for this type.
*
* @SINCE_1_0.0
* @return The count
size_t GetSignalCount() const;
/**
- * @brief Retrieve the signal name for the index.
+ * @brief Retrieves 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
+ * @return Signal name or empty string where index is invalid
*/
std::string GetSignalName(size_t index);
/**
- * @brief Retrieve the number of event side type registered properties for this type.
+ * @brief Retrieves the number of event side type registered properties for this type.
*
- * This count does not include all properties
+ * This count does not include all properties.
* @SINCE_1_0.0
* @return The count
*/
// Properties
/**
- * @brief Retrieve all the property indices for this type.
+ * @brief Retrieves all the property indices for this type.
*
* @SINCE_1_0.0
* @param[out] indices Container of property indices
* @brief Given a property index, retrieve the property name associated with it.
*
* @SINCE_1_0.0
- * @param[in] index The property index.
- * @return The name of the property at the given index.
+ * @param[in] index The property index
+ * @return The name of the property at the given index
* @exception DaliException If index is not valid.
*
*/
* @brief This constructor is used by Dali Get() method.
*
* @SINCE_1_0.0
- * @param [in] typeInfo A pointer to a Dali resource
+ * @param[in] typeInfo A pointer to a Dali resource
*/
explicit DALI_INTERNAL TypeInfo(Internal::TypeInfo* typeInfo);