Skip to content
Snippets Groups Projects
Commit 6e2c3cc1 authored by Nina Džugasová's avatar Nina Džugasová
Browse files

Modified the ParameterContainer documentation.

parent 34c6fc36
No related branches found
No related tags found
1 merge request!15Nina
......@@ -82,6 +82,17 @@ class ParameterContainer
bool setParameter( const String& name,
const String& value );
/**
* \brief Checks whether the parameter \e name is given the \e value.
*
* Returns \e true if the parameter \e name is given the \e value.
* If the parameter does not have any value or has different value then the given
* \e value the method returns \e false and shows message when \e verbose is \e true.
*
* @param name Name of parameter.
* @param value Value of type T we want to check whether is assigned to the parameter.
* @param verbose Boolean value defining whether to show error message (when true) or not (when false).
*/
template< class T > bool getParameter( const String& name,
T& value,
bool verbose = true ) const
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment