From: Guido Kanschat Date: Tue, 18 Jan 2005 19:15:47 +0000 (+0000) Subject: doxygen did not like the section command here X-Git-Tag: v8.0.0~14613 X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=5851ad47d88a09e4329e839ea1196030a9aeee31;p=dealii.git doxygen did not like the section command here git-svn-id: https://svn.dealii.org/trunk@9877 0785d39b-7218-0410-832d-ea1e28bc413d --- diff --git a/deal.II/base/include/base/parameter_handler.h b/deal.II/base/include/base/parameter_handler.h index 0a27eed15f..e190bee639 100644 --- a/deal.II/base/include/base/parameter_handler.h +++ b/deal.II/base/include/base/parameter_handler.h @@ -22,6 +22,10 @@ #include +//TODO: Allow long input lines to be broken by appending a backslash character +//TODO: Provide an "include" command for parameter files + + // public classes; to be declared below class ParameterHandler; class MultipleParameterLoop; @@ -761,11 +765,12 @@ namespace Patterns * structure. * * - * @section ParameterHandlerDeclaration Declaration of entries + *

Declaring entries

* * In order to use the facilities of a ParameterHandler object, one first has * to make known the different entries the input file may or may not contain. This * is done in the following way: + * * @code * ... * ParameterHandler prm; @@ -854,7 +859,7 @@ namespace Patterns * @endcode * * - * @section ParameterHandlerInput Input files and special characters + *

Input files and special characters

* * For the first example above the input file would look like the following: * @verbatim @@ -884,7 +889,7 @@ namespace Patterns * = sign. * * - * @section ParameterHandlerReading Reading data from input sources + *

Reading data from input sources

* * In order to read input you can use three possibilities: reading from an std::istream object, * reading from a file of which the name is given and reading from a string in memory in @@ -914,7 +919,7 @@ namespace Patterns * written to std::cerr. * * - * @section ParameterHandlerAccess Getting entry values out of a ParameterHandler object + *

Getting entry values out of a ParameterHandler object

* * Each class gets its data out of a ParameterHandler object by * calling the get() member functions like this: @@ -953,7 +958,7 @@ namespace Patterns * input file. * * - * @section ParameterHandlerStyle Style guide for data retrieval + *

Style guide for data retrieval

* * We propose that every class which gets data out of a * ParameterHandler object provides a function named @@ -962,7 +967,7 @@ namespace Patterns * should call the BaseClass::get_parameters function. * * - * @section ParameterHandlerLarge Experience with large parameter lists + *

Experience with large parameter lists

* * Experience has shown that in programs defining larger numbers of parameters (more than, * say, fifty) it is advantageous to define an additional class holding these parameters. @@ -976,18 +981,8 @@ namespace Patterns * up your main class with dozens or more variables denoting the parameters. * * - * @section ParameterHandlerFuture Possible future extensions - * - * - * - * * - * @section Example Worked Example + *

Worked Example

* * This is the code: * @code @@ -1197,8 +1192,7 @@ namespace Patterns * Matrix1=Sparse, Matrix2=Full * @endverbatim * - * - * @section References References + *

References

* * This class is inspired by the MenuSystem class of DiffPack. * @@ -1696,7 +1690,7 @@ class ParameterHandler * program. * * - * @section ParameterHandlerUsage Usage + *

Usage

* * The usage of this class is similar to the ParameterHandler class. First the * entries and subsections have to be declared, then a loop is performed in which @@ -1786,7 +1780,7 @@ class ParameterHandler * run. * * - * @section ParameterHandlerUsageSyntax Syntax for variant and array entry values + *

Syntax for variant and array entry values

* * Variant values are specified like prefix{ v1 | v2 | v3 | ... }postfix. Whitespace * to the right of the opening brace { is ignored as well as to the left of the @@ -1799,7 +1793,7 @@ class ParameterHandler * prefix{{ v1 | v2 | v3 }}postfix. * * - * @section ParameterHandlerExample Worked example + *

Worked example

* * Given the above extensions to the example program for the ParameterHandler and the * following input file @@ -1861,7 +1855,8 @@ class ParameterHandler * the number of the run. * * - * @section ParameterHandlerReferences References + *

References

+ * * This class is inspired by the Multipleloop class of DiffPack. * * @author Wolfgang Bangerth, October 1997