From 49620162c841e19d7a3a64e2cb8a0208867bdb38 Mon Sep 17 00:00:00 2001 From: wolf Date: Sun, 18 Apr 2004 22:27:34 +0000 Subject: [PATCH] Convert a number of more places to doxygen. git-svn-id: https://svn.dealii.org/trunk@9044 0785d39b-7218-0410-832d-ea1e28bc413d --- deal.II/base/include/base/data_out_base.h | 32 +++++++++---------- deal.II/base/include/base/exceptions.h | 6 ++-- deal.II/base/include/base/function_lib.h | 2 +- deal.II/base/include/base/function_time.h | 4 +-- deal.II/base/include/base/logstream.h | 8 ++--- deal.II/base/include/base/parameter_handler.h | 22 ++++++------- deal.II/base/include/base/polynomial.h | 10 +++--- deal.II/base/include/base/polynomial_space.h | 4 +-- deal.II/base/include/base/polynomials_p.h | 2 +- deal.II/base/include/base/quadrature.h | 4 +-- deal.II/base/include/base/quadrature_lib.h | 2 +- .../base/include/base/quadrature_selector.h | 10 +++--- .../base/include/base/template_constraints.h | 16 +++++----- deal.II/base/include/base/tensor_function.h | 2 +- .../include/base/tensor_product_polynomials.h | 6 ++-- deal.II/base/include/base/thread_management.h | 6 ++-- 16 files changed, 68 insertions(+), 68 deletions(-) diff --git a/deal.II/base/include/base/data_out_base.h b/deal.II/base/include/base/data_out_base.h index ef128ab337..35cf1b2480 100644 --- a/deal.II/base/include/base/data_out_base.h +++ b/deal.II/base/include/base/data_out_base.h @@ -169,10 +169,10 @@ class ParameterHandler; * * Given the lines as described above, a cut through this data in Gnuplot * can then be achieved like this: - * @begin{verbatim} + * @verbatim * set data style lines * splot [:][:][0:] "T" using 1:2:($3==.5 ? $4 : -1) - * @end{verbatim} + * @endverbatim * This command plots data in x- and y-direction unbounded, but in z-direction * only those data points which are above the x-y-plane (we assume here a * positive solution, if it has negative values, you might want to decrease the @@ -197,7 +197,7 @@ class ParameterHandler; * * The output uses two different povray-objects: * - * @begin{itemize} + * * * All objects get one texture definition called Tex. This texture has to be * declared somewhere before the object data. This may be in an external @@ -226,9 +226,9 @@ class ParameterHandler; * * You need povray (>=3.0) to render the scene. The minimum options for povray * are: - * @begin{verbatim} + * @verbatim * povray +I +W +H +L - * @end{verbatim} + * @endverbatim * If the external file "data.inc" is used, the path to this file has to be * included in the povray options. * @@ -359,7 +359,7 @@ class DataOutBase * n_subdivision = 4 because * the number of cells is * equal to 2^dim. - * @begin{verbatim} + * @verbatim * __ __ __ __ * | | | | | * |__|__|__|__| @@ -369,7 +369,7 @@ class DataOutBase * |__|__|__|__| * | | | | | * |__|__|__|__| - * @end{verbatim} + * @endverbatim * @author Wolfgang Bangerth */ template @@ -454,7 +454,7 @@ class DataOutBase * (0, 3, 1,2) in 2d, and * (0, 4, 3, 7, 1, 5, 2, 6) * in 3d as following: - * @begin{verbatim} + * @verbatim * * 7________6 * / /| @@ -465,7 +465,7 @@ class DataOutBase * | / | / * | / | / * 0|/______1/ - * @end{verbatim} + * @endverbatim * * For exemple in 2d: If * subdivisions==2 the @@ -473,7 +473,7 @@ class DataOutBase * given by the following * numeration: * - * @begin{verbatim} + * @verbatim * 2 ____5 ____8 * | | | * | | | @@ -483,7 +483,7 @@ class DataOutBase * | | | * | | | * 0|____3|____6| - * @end{verbatim} + * @endverbatim * * Since the number of data vectors * is usually the same for all @@ -876,7 +876,7 @@ class DataOutBase * Gnuplot-default of 0 is * the following: * - * @begin{verbatim} + * @verbatim * * 3________7 * / /| @@ -888,7 +888,7 @@ class DataOutBase * | / | / * 1|/______5/ * - * @end{verbatim} + * @endverbatim */ double turn_angle; @@ -1876,7 +1876,7 @@ class DataOutInterface : private DataOutBase * suffix with a given output format * usually has. At present the following * formats are defined: - * @begin{itemize} + *
    * @item dx: .dx * @item ucd: .inp * @item gnuplot: .gnuplot @@ -1884,7 +1884,7 @@ class DataOutInterface : private DataOutBase * @item eps: .eps * @item gmv: .gmv * @item vtk: .vtk. - * @end{itemize} + *
* * If this function is called * with no argument or diff --git a/deal.II/base/include/base/exceptions.h b/deal.II/base/include/base/exceptions.h index 999208548f..64e47cb560 100644 --- a/deal.II/base/include/base/exceptions.h +++ b/deal.II/base/include/base/exceptions.h @@ -170,9 +170,9 @@ * than that the program flow should not have reached a certain point, * e.g. a default section of a switch statement. In this case, * raise the exception by the following construct: - * @begin{verbatim} + * @verbatim * Assert (false, ExcInternalError()); - * @end{verbatim} + * @endverbatim * * As mentioned above, the program is terminated once a call to * Assert fails. However, there is one case where we do not want @@ -507,7 +507,7 @@ namespace deal_II_exceptions /** * Relay exceptions from the Assert macro to the * __IssueError_Assert function. Used to convert the last - * argument from arbitrary type to @ref{ExceptionBase} which is not + * argument from arbitrary type to ExceptionBase which is not * possible inside the Assert macro due to syntactical * difficulties in connection with the way we use the macro and the * declaration of the exception classes. diff --git a/deal.II/base/include/base/function_lib.h b/deal.II/base/include/base/function_lib.h index 49a0cba819..ea5bc65697 100644 --- a/deal.II/base/include/base/function_lib.h +++ b/deal.II/base/include/base/function_lib.h @@ -21,7 +21,7 @@ /** * Namespace implementing some concrete classes derived from the - * @ref{Function} class that describe actual functions. This is rather + * Function class that describe actual functions. This is rather * a collection of classes that we have needed for our own programs * once and thought they might be useful to others as well at some * point. diff --git a/deal.II/base/include/base/function_time.h b/deal.II/base/include/base/function_time.h index 54e0ba19e1..d44a481372 100644 --- a/deal.II/base/include/base/function_time.h +++ b/deal.II/base/include/base/function_time.h @@ -30,11 +30,11 @@ * for time dependent problems. * * Access to the time goes through the following functions: - * @begin{verbatim} + * @verbatim * @item get_time: return the present value of the time variable. * @item set_time: set the time value to a specific value. * @item advance_time: increase the time by a certain time step. - * @end{verbatim} + * @endverbatim * The latter two functions are virtual, so that derived classes can * perform computations which need only be done once for every new time. * For example, if a time dependent function had a factor sin(t), then diff --git a/deal.II/base/include/base/logstream.h b/deal.II/base/include/base/logstream.h index 042de4b1b0..761a009c04 100644 --- a/deal.II/base/include/base/logstream.h +++ b/deal.II/base/include/base/logstream.h @@ -32,15 +32,15 @@ /** * A class that simplifies the process of execution logging. It does so by * providing - * @begin{itemize} + *
    * @item a push and pop mechanism for prefixes, and * @item the possibility of distributing information to files and the * console. - * @end{itemize} + *
* * The usual usage of this class is through the pregenerated object * deallog. Typical steps are - * @begin{itemize} + *
    * @item deallog.attach(std::ostream): write logging information into a file. * @item deallog.depth_console(n): restrict output on screen to outer loops. * @item Before entering a new phase of your program, e.g. a new loop, @@ -48,7 +48,7 @@ * @item deallog << anything << std::endl; to write logging information * (Usage of std::endl is mandatory!). * @item deallog.pop() when leaving that stage entered with push. - * @end{itemize} + *
* * @author Guido Kanschat, Wolfgang Bangerth, 1999, 2003 */ diff --git a/deal.II/base/include/base/parameter_handler.h b/deal.II/base/include/base/parameter_handler.h index d618160a48..50920c0f25 100644 --- a/deal.II/base/include/base/parameter_handler.h +++ b/deal.II/base/include/base/parameter_handler.h @@ -867,7 +867,7 @@ namespace Patterns * be recognised if in the declaration multiple whitespace is used. * * In entry names and values the following characters are not allowed: \#, {, - * }, |. Their use is reserved for the @ref{MultipleParameterLoop} class. + * }, |. Their use is reserved for the MultipleParameterLoop class. * * Comments starting with \# are skipped. * @@ -1148,10 +1148,10 @@ namespace Patterns * set Maximum number of iterations = 100 * end * end - * @end{verbatim} + * @endverbatim * * And here is the ouput of the program: - * @begin{verbatim} + * @verbatim * Line 8: * The entry value * Gauss-Seidel @@ -1314,7 +1314,7 @@ class ParameterHandler * a comment when this class is * asked to write out all * declarations to a stream using - * the @ref{print_parameters} + * the print_parameters() * function. * * The function generates an @@ -1407,7 +1407,7 @@ class ParameterHandler * from the actual value, as well * as the documenting string * given to the - * @ref{declare_entry} function + * declare_entry() function * if available. */ std::ostream & print_parameters (std::ostream &out, @@ -1421,8 +1421,8 @@ class ParameterHandler * variable. This variable is * controlled by entering and * leaving subsections through - * the @ref{enter_subsection} and - * @ref{leave_subsection} + * the enter_subsection() and + * leave_subsection() * functions. * * In most cases, you will not @@ -1453,8 +1453,8 @@ class ParameterHandler * variable. This variable is * controlled by entering and * leaving subsections through - * the @ref{enter_subsection} and - * @ref{leave_subsection} + * the enter_subsection() and + * leave_subsection() * functions. * * In most cases, you will not @@ -1675,9 +1675,9 @@ class ParameterHandler * of the two solvers. * * Opposite to a variant entry, an array entry looks like this: - * @begin{verbatim} + * @verbatim * set Output file = ofile.{{ 1 | 2 | 3 | 4 }} - * @end{verbatim} + * @endverbatim * This indicates that if there are variant entries producing a total of four * different runs will write their results to the files ofile.1, ofile.2, * ofile.3 and ofile.4, respectively. Array entries do not generate multiple diff --git a/deal.II/base/include/base/polynomial.h b/deal.II/base/include/base/polynomial.h index 3d5e21f811..8898d898ce 100644 --- a/deal.II/base/include/base/polynomial.h +++ b/deal.II/base/include/base/polynomial.h @@ -409,7 +409,7 @@ namespace Polynomials * constructor. This way, it can * use the non-standard * constructor of - * @ref{Polynomial}. + * Polynomial. */ static const std::vector & get_coefficients (const unsigned int k); @@ -482,9 +482,9 @@ namespace Polynomials * * This function may be * used to initialize the - * @ref{TensorProductPolynomials}, - * @ref{AnisotropicPolynomials}, - * and @ref{PolynomialSpace} + * TensorProductPolynomials, + * AnisotropicPolynomials, + * and PolynomialSpace * classes. */ static @@ -502,7 +502,7 @@ namespace Polynomials * constructor. This way, it can * use the non-standard * constructor of - * @ref{Polynomial}. + * Polynomial. */ static const std::vector & get_coefficients (const unsigned int p); diff --git a/deal.II/base/include/base/polynomial_space.h b/deal.II/base/include/base/polynomial_space.h index 0360d9283d..239e38114d 100644 --- a/deal.II/base/include/base/polynomial_space.h +++ b/deal.II/base/include/base/polynomial_space.h @@ -36,12 +36,12 @@ * Pi(x)Pj(y)Pk(z), where the sum * of i, j and k is less than or equal n. * - * The @ref{output_indices} function prints the ordering of the + * The output_indices() function prints the ordering of the * polynomials, i.e. for each dim-dimensional polynomial in the * polynomial space it gives the indices i,j,k of the one-dimensional * polynomials in x,y and z direction. The ordering of the * dim-dimensional polynomials can be changed by using the - * @p{set_polynomial_ordering} function. + * set_polynomial_ordering() function. * * @author Guido Kanschat, 2002, Wolfgang Bangerth, 2003, Ralf Hartmann 2004 */ diff --git a/deal.II/base/include/base/polynomials_p.h b/deal.II/base/include/base/polynomials_p.h index e24b8b0097..05e84e5f28 100644 --- a/deal.II/base/include/base/polynomials_p.h +++ b/deal.II/base/include/base/polynomials_p.h @@ -60,7 +60,7 @@ class PolynomialsP: public PolynomialSpace * Note, that this number is * PolynomialSpace::degree()-1, * compare definition in - * @ref{PolynomialSpace}. + * PolynomialSpace. */ unsigned int degree() const; diff --git a/deal.II/base/include/base/quadrature.h b/deal.II/base/include/base/quadrature.h index 3fa7d8b7f9..b01f35ae9a 100644 --- a/deal.II/base/include/base/quadrature.h +++ b/deal.II/base/include/base/quadrature.h @@ -132,7 +132,7 @@ class Quadrature : public Subscriptor * is therefore not meant to * actually perform integrations, * but rather to be used with - * @ref{FEValues} objects in + * FEValues objects in * order to find the position of * some points (the quadrature * points in this object) on the @@ -373,7 +373,7 @@ class QProjector * cell, one set of which will * then be selected at each * time. This is used in the - * @ref{FEFaceValues} class, + * FEFaceValues class, * where we initialize the * values, derivatives, etc on * all faces at once, while diff --git a/deal.II/base/include/base/quadrature_lib.h b/deal.II/base/include/base/quadrature_lib.h index da05e878a6..30ee033800 100644 --- a/deal.II/base/include/base/quadrature_lib.h +++ b/deal.II/base/include/base/quadrature_lib.h @@ -24,7 +24,7 @@ * The coefficients of these quadrature rules are computed by the * function found in Numerical Recipies. For lower order * quadrature rules, the use of this class is thus equivalent to the - * use of the @ref{QGauss1} through @ref{QGauss7} classes, for which + * use of the QGauss1 through QGauss7 classes, for which * the coefficients are hardcoded, but this class can provide higher * order formulae as well. * diff --git a/deal.II/base/include/base/quadrature_selector.h b/deal.II/base/include/base/quadrature_selector.h index c5966f6ae1..dd94a8c280 100644 --- a/deal.II/base/include/base/quadrature_selector.h +++ b/deal.II/base/include/base/quadrature_selector.h @@ -23,12 +23,12 @@ /** * This class implements the quadrature rule passed to its constructor - * as a string. Supported quadratures are @ref{QGauss} (of all - * orders), @ref{QMidpoint}, @ref{QMilne}, @ref{QSimpson}, - * @ref{QTrapez} and @ref{QWeddle}. + * as a string. Supported quadratures are QGauss (of all + * orders), QMidpoint, QMilne, QSimpson, + * QTrapez and QWeddle. * * This class is useful if you want to use flexible quadrature rules, - * that are read from a parameter file (see @ref{ParameterHandler} for + * that are read from a parameter file (see ParameterHandler for * this). * * @author Ralf Schulz, 2003 @@ -54,7 +54,7 @@ class QuadratureSelector : public Quadrature * as a list separated by |, * so that you can use it for the * definition of parameter files - * (see @ref{ParameterHandler} for + * (see ParameterHandler for * details). */ static std::string get_quadrature_names(); diff --git a/deal.II/base/include/base/template_constraints.h b/deal.II/base/include/base/template_constraints.h index 8388d61956..381d655adb 100644 --- a/deal.II/base/include/base/template_constraints.h +++ b/deal.II/base/include/base/template_constraints.h @@ -32,12 +32,12 @@ template struct constraint_and_return_value; * is only considered in a call, if all parts of its signature can be * instantiated with the template parameter replaced by the respective * types/values in this particular call. Example: - * @begin{verbatim} + * @verbatim * template * typename T::type foo(T) {...}; * ... * foo(1); - * @end{verbatim} + * @endverbatim * The compiler should detect that in this call, the template * parameter T must be identified with the type "int". However, * the return type T::type does not exist. The trick now is @@ -47,27 +47,27 @@ template struct constraint_and_return_value; * * The idea is then to make the return type un-instantiatable if * certain constraints on the template types are not satisfied: - * @begin{verbatim} + * @verbatim * template struct constraint_and_return_value; * template struct constraint_and_return_value { * typedef T type; * }; - * @end{verbatim} + * @endverbatim * constraint_and_return_value is not defined. Given something like - * @begin{verbatim} + * @verbatim * template * struct int_or_double { static const bool value = false;}; * template <> * struct int_or_double { static const bool value = true; }; * template <> * struct int_or_double { static const bool value = true; }; - * @end{verbatim} + * @endverbatim * we can write a template - * @begin{verbatim} + * @verbatim * template * typename constraint_and_return_value::value,void>::type * f (T); - * @end{verbatim} + * @endverbatim * which can only be instantiated if T=int or T=double. A call to * f('c') will just fail with a compiler error: "no instance of * f(char) found". On the other hand, if the predicate in the first diff --git a/deal.II/base/include/base/tensor_function.h b/deal.II/base/include/base/tensor_function.h index fa9c0bd32a..1624cd782c 100644 --- a/deal.II/base/include/base/tensor_function.h +++ b/deal.II/base/include/base/tensor_function.h @@ -27,7 +27,7 @@ /** * This class is a model for a tensor valued function. The interface - * of the class is mostly the same as that for the @ref{Function} + * of the class is mostly the same as that for the Function * class, with the exception that it does not support vector-valued * functions with several components, but that the return type is * always tensor-valued. The returned values of the evaluation of diff --git a/deal.II/base/include/base/tensor_product_polynomials.h b/deal.II/base/include/base/tensor_product_polynomials.h index d8f0662e00..903b35c951 100644 --- a/deal.II/base/include/base/tensor_product_polynomials.h +++ b/deal.II/base/include/base/tensor_product_polynomials.h @@ -43,12 +43,12 @@ * P2(x)P2(y), P3(x)P2(y), * ... and likewise in 3d. * - * The @ref{output_indices} function prints the ordering of the + * The output_indices() function prints the ordering of the * dim-dimensional polynomials, i.e. for each polynomial in the * polynomial space it gives the indices i,j,k of the one-dimensional * polynomials in x,y and z direction. The ordering of the * dim-dimensional polynomials can be changed by using the - * @p{set_renumbering} function. + * set_renumbering() function. * * @author Ralf Hartmann, 2000, 2004, Guido Kanschat, 2000, Wolfgang Bangerth 2003 */ @@ -553,7 +553,7 @@ TensorProductPolynomials(const std::vector &pols) // per default set this index map // to identity. This map can be // changed by the user through the - // set_renumbering function + // set_renumbering() function for (unsigned int i=0; i