Commit 8baf2486 authored by Nina Džugasová's avatar Nina Džugasová Committed by Tomáš Oberhuber
Browse files

Modified the ParameterContainer documentation.

parent 95eeae92
Loading
Loading
Loading
Loading
+11 −0
Original line number Diff line number Diff line
@@ -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