]> https://gitweb.dealii.org/ - dealii.git/commitdiff
Move the ParameterHandler classes into the 'input' doxygen module
authorWolfgang Bangerth <bangerth@math.tamu.edu>
Fri, 13 Jan 2006 23:23:43 +0000 (23:23 +0000)
committerWolfgang Bangerth <bangerth@math.tamu.edu>
Fri, 13 Jan 2006 23:23:43 +0000 (23:23 +0000)
git-svn-id: https://svn.dealii.org/trunk@12020 0785d39b-7218-0410-832d-ea1e28bc413d

deal.II/base/include/base/parameter_handler.h
deal.II/doc/doxygen/headers/io.h

index 068a9e124fadbb9de3dbcbe035b6cb886661d8f8..c9f1e617396840787d3bc6dac2a7a86be0522b45 100644 (file)
@@ -40,6 +40,8 @@ class LogStream;
 /**
  * Declare some regexps which
  * may be used to define patterns.
+ *
+ * @ingroup input
  */ 
 namespace Patterns
 {
@@ -839,13 +841,15 @@ namespace Patterns
  *     };
  *   @endcode
  *
- *   For class member functions which declare the different entries we propose to use the
- *   common name <tt>declare_parameters</tt>. In normal cases this method can be <tt>static</tt> since the
- *   entries will not depend on any previous knowledge. Classes for which entries should
- *   logically be grouped into subsections should declare these subsections themselves. If
- *   a class has two or more member variables of the same type both of which should have
- *   their own parameters, this parent class' method <tt>declare_parameters</tt> is responsible to
- *   group them into different subsections:
+ *   For class member functions which declare the different entries we propose
+ *   to use the common name <tt>declare_parameters</tt>. In normal cases this
+ *   method can be <tt>static</tt> since the entries will not depend on any
+ *   previous knowledge. Classes for which entries should logically be grouped
+ *   into subsections should declare these subsections themselves. If a class
+ *   has two or more member variables of the same type both of which should
+ *   have their own parameters, this parent class' method
+ *   <tt>declare_parameters</tt> is responsible to group them into different
+ *   subsections:
  *   @code
  *     void NonLinEq::declare_parameters (ParameterHandler &prm) {
  *       prm.enter_subsection ("Nonlinear solver");
@@ -1198,6 +1202,8 @@ namespace Patterns
  *
  *   This class is inspired by the <tt>MenuSystem</tt> class of <tt>DiffPack</tt>.
  *
+ *   @ingroup input
+ *
  *   @author Wolfgang Bangerth, October 1997, revised February 1998
   */
 class ParameterHandler
@@ -1956,6 +1962,8 @@ class ParameterHandler
  *
  *   This class is inspired by the <tt>Multipleloop</tt> class of <tt>DiffPack</tt>.
  *
+ *   @ingroup input
+ *
  *   @author Wolfgang Bangerth, October 1997
  */
 class MultipleParameterLoop : public ParameterHandler
index ff69adc2fb3ad2a7db64a560f3ceb1c92cefda6f..4a67a567ab549208800629ff81637f06cd3038e9 100644 (file)
  * DataOutReader class reads this data back in, and it can then be converted
  * to any of a number of data formats supported by visualization programs.
  *
+ * Finally, the ParameterHandler and MultipleParameterLoop classes (and the
+ * associated Patterns namespace) are used to deal with parameter files
+ * describing run-time parameters to a program that one doesn't want to
+ * hard-code within the program source.
+ * 
  * @ingroup IO
  */
 

In the beginning the Universe was created. This has made a lot of people very angry and has been widely regarded as a bad move.

Douglas Adams


Typeset in Trocchi and Trocchi Bold Sans Serif.