* size 0 is treated as aspect ratio 1:1.
*
* @SINCE_1_0.0
- * @param width Width to use
+ * @param[in] width Width to use
* @return Return the height based on the width.
*/
float GetHeightForWidth( float width );
* size 0 is treated as aspect ratio 1:1.
*
* @SINCE_1_0.0
- * @param height Height to use
+ * @param[in] height Height to use
* @return Return the width based on the height.
*/
float GetWidthForHeight( float height );
* @brief Return the value of negotiated dimension for the given dimension.
*
* @SINCE_1_0.0
- * @param dimension The dimension to retrieve
+ * @param[in] dimension The dimension to retrieve
* @return Return the value of the negotiated dimension. If more than one dimension is requested, just return the first one found.
*/
float GetRelayoutSize( Dimension::Type dimension ) const;
* @brief Return the value of the padding.
*
* @SINCE_1_0.0
- * @param paddingOut The returned padding data
+ * @param[in] paddingOut The returned padding data
*/
void GetPadding( Padding& paddingOut ) const;
* Derived classes should override this if they wish to customize the height returned.
*
* @SINCE_1_0.0
- * @param width Width to use.
+ * @param[in] width Width to use.
* @return The height based on the width.
*/
virtual float GetHeightForWidth( float width ) = 0;
* Derived classes should override this if they wish to customize the width returned.
*
* @SINCE_1_0.0
- * @param height Height to use.
+ * @param[in] height Height to use.
* @return The width based on the width.
*/
virtual float GetWidthForHeight( float height ) = 0;
* @brief Determine if this actor is dependent on it's children for relayout.
*
* @SINCE_1_0.0
- * @param dimension The dimension(s) to check for
+ * @param[in] dimension The dimension(s) to check for
* @return Return if the actor is dependent on it's children.
*/
virtual bool RelayoutDependentOnChildren( Dimension::Type dimension = Dimension::ALL_DIMENSIONS ) = 0;
* met and the size for this object is about to be calculated for the given dimension
*
* @SINCE_1_0.0
- * @param dimension The dimension that is about to be calculated
+ * @param[in] dimension The dimension that is about to be calculated
*/
virtual void OnCalculateRelayoutSize( Dimension::Type dimension ) = 0;
/**
* @brief Provides the Actor implementation of GetHeightForWidth.
* @SINCE_1_0.0
- * @param width Width to use.
+ * @param[in] width Width to use.
* @return The height based on the width.
*/
float GetHeightForWidthBase( float width );
/**
* @brief Provides the Actor implementation of GetWidthForHeight.
* @SINCE_1_0.0
- * @param height Height to use.
+ * @param[in] height Height to use.
* @return The width based on the height.
*/
float GetWidthForHeightBase( float height );
* @brief Determine if this actor is dependent on it's children for relayout from the base class.
*
* @SINCE_1_0.0
- * @param dimension The dimension(s) to check for
+ * @param[in] dimension The dimension(s) to check for
* @return Return if the actor is dependent on it's children.
*/
bool RelayoutDependentOnChildrenBase( Dimension::Type dimension = Dimension::ALL_DIMENSIONS );
/**
* @brief Subscript operator.
* @SINCE_1_0.0
- * @param[in] index of the element.
+ * @param[in] index Index of the element.
* @return reference to the element for given index.
* @pre index must be in the vector's range.
*/
/**
* @brief Copy constructor
* @SINCE_1_0.0
- * @param rhs A reference to the copied handle
+ * @param[in] rhs A reference to the copied handle
*/
TapGesture( const TapGesture& rhs );
/**
* @brief Assignment operator
* @SINCE_1_0.0
- * @param rhs A reference to the copied handle
+ * @param[in] rhs A reference to the copied handle
* @return A reference to this
*/
TapGesture& operator=( const TapGesture& rhs );
PixelData();
/**
- * Destructor
+ * @brief Destructor.
*
* @SINCE_1_1.43
*/
PixelData& operator=(const PixelData& rhs);
/**
- * Get the width of the buffer in pixels.
+ * @brief Get the width of the buffer in pixels.
*
* @SINCE_1_1.43
* @return The width of the buffer in pixels
unsigned int GetWidth() const;
/**
- * Get the height of the buffer in pixels
+ * @brief Get the height of the buffer in pixels.
*
* @SINCE_1_1.43
* @return The height of the buffer in pixels
unsigned int GetHeight() const;
/**
- * Get the pixel format
+ * @brief Get the pixel format.
*
* @SINCE_1_1.43
* @return The pixel format
}
/**
- * @brief @returns the x dimension stored in this 2-tuple.
+ * @brief Get the width.
* @SINCE_1_0.0
+ * @return the x dimension stored in this 2-tuple
*/
uint16_t GetWidth() const
{
* @brief Pass Assert message
*
* @SINCE_1_0.0
- * @param assertMessage Assert message to report
+ * @param[in] assertMessage Assert message to report
*/
DALI_IMPORT_API static void AssertAlways( const char* assertMessage );
/**
* @brief Copy Constructor.
* @SINCE_1_0.0
- * @param [in] any Any to be copied.
+ * @param[in] any Any to be copied.
*/
Any( const Any& any )
{
* @brief Get a value of type Type from container
*
* @SINCE_1_0.0
- * @param type destination of type Type to write to
+ * @param[in] type destination of type Type to write to
*/
template<typename Type>
void Get( Type& type ) const
* @brief Constructor of base container
*
* @SINCE_1_0.0
- * @param type typeid of container
- * @param cloneFunc Cloning function to replicate this container type
- * @param deleteFunc Deleting function to destroy this container type
+ * @param[in] type typeid of container
+ * @param[in] cloneFunc Cloning function to replicate this container type
+ * @param[in] deleteFunc Deleting function to destroy this container type
*/
AnyContainerBase( const std::type_info& type, CloneFunc cloneFunc, DeleteFunc deleteFunc )
: mType( type ),
* @brief Templated Clone function from container base
*
* @SINCE_1_0.0
- * @param base reference to container
+ * @param[in] base reference to container
*/
template<typename Type>
struct AnyContainerImplCloner
* @brief Templated Delete function from container base
*
* @SINCE_1_0.0
- * @param base pointer to container
+ * @param[in] base pointer to container
*/
template<typename Type>
struct AnyContainerImplDelete
* @brief Constructor to create container holding value of type Type
*
* @SINCE_1_0.0
- * @param value Value of Type
+ * @param[in] value Value of Type
*/
AnyContainerImpl( const Type& value )
: AnyContainerBase( typeid( Type ),
* @brief Constructor to create new container of type from and existing container (cloning)
*
* @SINCE_1_0.0
- * @param base reference to base container to copy from
+ * @param[in] base reference to base container to copy from
*/
AnyContainerImpl( const AnyContainerBase& base )
: AnyContainerBase( typeid( Type ),
* @brief Set the container's stored value
*
* @SINCE_1_0.0
- * @param value of type Type
+ * @param[in] value of type Type
*/
void SetValue( const Type& value )
{
* @brief Extract a pointer to the held type of an Any object from a pointer to that Any object (NULL if empty )
*
* @SINCE_1_0.0
- * @param any Pointer to an Any object
+ * @param[in] any Pointer to an Any object
*
* @return Pointer to the Type held
*/
* @brief Extract a const pointer to the held type of an Any object from a pointer to that Any object (NULL if empty )
*
* @SINCE_1_0.0
- * @param any const Pointer to an Any object
+ * @param[in] any const Pointer to an Any object
*
* @return const Pointer to the Type held
*/
* @brief Extract a held value of type Type from an Any object from a reference to that Any object
*
* @SINCE_1_0.0
- * @param any reference to an Any object
+ * @param[in] any reference to an Any object
*
* @return Type value of type Type
*/
* @brief Extract a held value of type Type from an Any object from a const reference to that Any object
*
* @SINCE_1_0.0
- * @param any reference to an Any object
+ * @param[in] any reference to an Any object
*
* @return Type value of type Type
*/
* @brief Extract a reference to the held value of type Type from an Any object from a reference to that Any object
*
* @SINCE_1_0.0
- * @param any reference to an Any object
+ * @param[in] any reference to an Any object
*
* @return A reference to the Type value of type Type
*/
* @brief Extract a const reference to the held value of type Type from an Any object from a const reference to that Any object
*
* @SINCE_1_0.0
- * @param any reference to an Any object
+ * @param[in] any reference to an Any object
*
* @return A const reference to the Type value of type Type
*/
* @brief Template wrapper to downcast a base object handle to derived class handle.
*
* @SINCE_1_0.0
- * @param handle to a base object
+ * @param[in] handle to a base object
* @return handle pointer to either a valid deriving handle or an uninitialized handle
* @pre The BaseHandle has been initialized.
*/
*
* Does not check for duplicates
* @SINCE_1_0.0
- * @param key to insert
- * @param value to insert
+ * @param[in] key to insert
+ * @param[in] value to insert
*/
void Insert( const char* key, const Value& value );
*
* Does not check for duplicates
* @SINCE_1_0.0
- * @param key to insert
- * @param value to insert
+ * @param[in] key to insert
+ * @param[in] value to insert
*/
void Insert( const std::string& key, const Value& value );
*
* Does not check for duplicates
* @SINCE_1_1.39
- * @param key to insert
- * @param value to insert
+ * @param[in] key to insert
+ * @param[in] value to insert
*/
void Insert( Property::Index key, const Value& value );