- * @param [in] name The name of the property.
- * @return The index of the property, or Property::INVALID_INDEX if no property exists with the given name.
+ * @param[in] name The name of the property
+ * @return The index of the property, or Property::INVALID_INDEX if no property exists with the given name
- * @param [in] index The index of the property.
- * @return True if the property can be used as a constraint input.
+ * @param[in] index The index of the property
+ * @return True if the property can be used as a constraint input
- * @param [in] index The index of the property.
- * @param [in] propertyValue The new value of the property.
+ * @param[in] index The index of the property
+ * @param[in] propertyValue The new value of the property
* @pre The property types match i.e. propertyValue.GetType() is equal to GetPropertyType(index).
*/
void SetProperty( Property::Index index, const Property::Value& propertyValue );
/**
* @pre The property types match i.e. propertyValue.GetType() is equal to GetPropertyType(index).
*/
void SetProperty( Property::Index index, const Property::Value& propertyValue );
/**
- * @param [in] name The name of the property.
- * @param [in] propertyValue The new value of the property.
+ * @param[in] name The name of the property
+ * @param[in] propertyValue The new value of the property
* @return The index of the property or Property::INVALID_INDEX if registration failed
* @pre The object supports dynamic properties i.e. Supports(Handle::DYNAMIC_PROPERTIES) returns true.
* Property names are expected to be unique, but this is not enforced.
* @return The index of the property or Property::INVALID_INDEX if registration failed
* @pre The object supports dynamic properties i.e. Supports(Handle::DYNAMIC_PROPERTIES) returns true.
* Property names are expected to be unique, but this is not enforced.
- * @param [in] name The name of the property.
- * @param [in] propertyValue The new value of the property.
- * @param [in] accessMode The property access mode (writable, animatable etc).
+ * @param[in] name The name of the property
+ * @param[in] propertyValue The new value of the property
+ * @param[in] accessMode The property access mode (writable, animatable etc)
* @return The index of the property
* @pre The handle supports dynamic properties i.e. Supports(Handle::DYNAMIC_PROPERTIES) returns true.
* @pre name is unused i.e. GetPropertyIndex(name) returns PropertyIndex::INVALID.
* @return The index of the property
* @pre The handle supports dynamic properties i.e. Supports(Handle::DYNAMIC_PROPERTIES) returns true.
* @pre name is unused i.e. GetPropertyIndex(name) returns PropertyIndex::INVALID.
Property::Index RegisterProperty( const std::string& name, const Property::Value& propertyValue, Property::AccessMode accessMode );
/**
Property::Index RegisterProperty( const std::string& name, const Property::Value& propertyValue, Property::AccessMode accessMode );
/**
- * @param[out] indices A container of property indices for this object.
- * @note the added container is cleared
+ * @param[out] indices A container of property indices for this object
+ * @note The added container is cleared.
- * @param [in] index The index of the property.
- * @param [in] condition The notification will be triggered when this condition is satisfied.
- *
+ * @param[in] index The index of the property
+ * @param[in] condition The notification will be triggered when this condition is satisfied
* @return A handle to the newly created PropertyNotification
*/
PropertyNotification AddPropertyNotification( Property::Index index,
const PropertyCondition& condition );
/**
* @return A handle to the newly created PropertyNotification
*/
PropertyNotification AddPropertyNotification( Property::Index index,
const PropertyCondition& condition );
/**
- * @param [in] index The index of the property.
- * @param [in] componentIndex Index to the component of a complex property such as a Vector
- * @param [in] condition The notification will be triggered when this condition is satisfied.
- *
+ * @param[in] index The index of the property
+ * @param[in] componentIndex Index to the component of a complex property such as a Vector
+ * @param[in] condition The notification will be triggered when this condition is satisfied
* @return A handle to the newly created PropertyNotification
*/
PropertyNotification AddPropertyNotification( Property::Index index,
* @return A handle to the newly created PropertyNotification
*/
PropertyNotification AddPropertyNotification( Property::Index index,