From 05dae052e1c0c0e863a4b285fe895f1aed65cc27 Mon Sep 17 00:00:00 2001 From: Wolfgang Bangerth Date: Fri, 13 Jan 2006 23:23:43 +0000 Subject: [PATCH] Move the ParameterHandler classes into the 'input' doxygen module git-svn-id: https://svn.dealii.org/trunk@12020 0785d39b-7218-0410-832d-ea1e28bc413d --- deal.II/base/include/base/parameter_handler.h | 22 +++++++++++++------ deal.II/doc/doxygen/headers/io.h | 5 +++++ 2 files changed, 20 insertions(+), 7 deletions(-) diff --git a/deal.II/base/include/base/parameter_handler.h b/deal.II/base/include/base/parameter_handler.h index 068a9e124f..c9f1e61739 100644 --- a/deal.II/base/include/base/parameter_handler.h +++ b/deal.II/base/include/base/parameter_handler.h @@ -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 declare_parameters. In normal cases this method can be static 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 declare_parameters is responsible to - * group them into different subsections: + * For class member functions which declare the different entries we propose + * to use the common name declare_parameters. In normal cases this + * method can be static 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 + * declare_parameters 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 MenuSystem class of DiffPack. * + * @ingroup input + * * @author Wolfgang Bangerth, October 1997, revised February 1998 */ class ParameterHandler @@ -1956,6 +1962,8 @@ class ParameterHandler * * This class is inspired by the Multipleloop class of DiffPack. * + * @ingroup input + * * @author Wolfgang Bangerth, October 1997 */ class MultipleParameterLoop : public ParameterHandler diff --git a/deal.II/doc/doxygen/headers/io.h b/deal.II/doc/doxygen/headers/io.h index ff69adc2fb..4a67a567ab 100644 --- a/deal.II/doc/doxygen/headers/io.h +++ b/deal.II/doc/doxygen/headers/io.h @@ -33,6 +33,11 @@ * 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 */ -- 2.39.5