]> https://gitweb.dealii.org/ - dealii.git/commitdiff
Convert a number of more places to doxygen.
authorWolfgang Bangerth <bangerth@math.tamu.edu>
Sun, 18 Apr 2004 22:27:34 +0000 (22:27 +0000)
committerWolfgang Bangerth <bangerth@math.tamu.edu>
Sun, 18 Apr 2004 22:27:34 +0000 (22:27 +0000)
git-svn-id: https://svn.dealii.org/trunk@9044 0785d39b-7218-0410-832d-ea1e28bc413d

16 files changed:
deal.II/base/include/base/data_out_base.h
deal.II/base/include/base/exceptions.h
deal.II/base/include/base/function_lib.h
deal.II/base/include/base/function_time.h
deal.II/base/include/base/logstream.h
deal.II/base/include/base/parameter_handler.h
deal.II/base/include/base/polynomial.h
deal.II/base/include/base/polynomial_space.h
deal.II/base/include/base/polynomials_p.h
deal.II/base/include/base/quadrature.h
deal.II/base/include/base/quadrature_lib.h
deal.II/base/include/base/quadrature_selector.h
deal.II/base/include/base/template_constraints.h
deal.II/base/include/base/tensor_function.h
deal.II/base/include/base/tensor_product_polynomials.h
deal.II/base/include/base/thread_management.h

index ef128ab337df55d4394409b1bfaa9a06647dcb5c..35cf1b2480faaa2578776f25f1a5057fefacd1f3 100644 (file)
@@ -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}
+ * <ul>
  * @item <tt>BICUBIC_PATCH</tt>
  * A <tt>bicubic_patch</tt> is a 3-dimensional Bezier patch. It consists of 16 Points
  * describing the surface. The 4 corner points are touched by the object,
@@ -214,7 +214,7 @@ class ParameterHandler;
  * 
  * Using the smooth flag povray interpolates the normals on the triangles,
  * imitating a curved surface
- * @end{itemize}
+ * </ul>
  *
  * 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<inputfile> +W<horiz. size> +H<ver. size> +L<include path>
- * @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
                                      * <tt>n_subdivision</tt> = 4 because
                                      * the number of cells is
                                      * equal to <tt>2^dim</tt>.
-                                     * @begin{verbatim}
+                                     * @verbatim
                                      *  __ __ __ __
                                      * |  |  |  |  |
                                      * |__|__|__|__| 
@@ -369,7 +369,7 @@ class DataOutBase
                                      * |__|__|__|__| 
                                      * |  |  |  |  |
                                      * |__|__|__|__|
-                                     * @end{verbatim}
+                                     * @endverbatim
                                      * @author Wolfgang Bangerth
                                      */
     template <int dim, int spacedim=dim>
@@ -454,7 +454,7 @@ class DataOutBase
                                          * <tt>(0, 3, 1,2)</tt> in 2d, and 
                                          * <tt>(0, 4, 3, 7, 1, 5, 2, 6)</tt>
                                          * 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
                                          * <tt>subdivisions==2</tt> 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}
+                                     * <ul>
                                      * @item <tt>dx</tt>: <tt>.dx</tt>
                                      * @item <tt>ucd</tt>: <tt>.inp</tt>
                                      * @item <tt>gnuplot</tt>: <tt>.gnuplot</tt>
@@ -1884,7 +1884,7 @@ class DataOutInterface : private DataOutBase
                                      * @item <tt>eps</tt>: <tt>.eps</tt>
                                      * @item <tt>gmv</tt>: <tt>.gmv</tt>
                                      * @item <tt>vtk</tt>: <tt>.vtk</tt>.
-                                     * @end{itemize}
+                                     * </ul>
                                      *
                                      * If this function is called
                                      * with no argument or
index 999208548f3df6fd56298626688625fbf1227307..64e47cb56029c67de9fe353f4747c76ae73d509d 100644 (file)
  *  than that the program flow should not have reached a certain point,
  *  e.g. a <tt>default</tt> section of a <tt>switch</tt> 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
  *  <tt>Assert</tt> fails. However, there is one case where we do not want
@@ -507,7 +507,7 @@ namespace deal_II_exceptions
 /**
  *  Relay exceptions from the <tt>Assert</tt> macro to the
  *  <tt>__IssueError_Assert</tt> 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 <tt>Assert</tt> macro due to syntactical
  *  difficulties in connection with the way we use the macro and the
  *  declaration of the exception classes.
index 49a0cba819f9b66db6b7c6d9dc114b61cbf6d704..ea5bc656973ce8bcde247efb2d8df7c6f10c78d5 100644 (file)
@@ -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.
index 54e0ba19e1838bb4e785605a6ff89ef7e055ef18..d44a4813721f0baa2eb296865bf5757daccfbf12 100644 (file)
  *  for time dependent problems.
  *
  *  Access to the time goes through the following functions:
- *  @begin{verbatim}
+ *  @verbatim
  *  @item <tt>get_time</tt>: return the present value of the time variable.
  *  @item <tt>set_time</tt>: set the time value to a specific value.
  *  @item <tt>advance_time</tt>: 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 <tt>sin(t)</tt>, then
index 042de4b1b0a23eddc7526a14c56de648d1e0d711..761a009c044f0687479c211f762eebe619d2521b 100644 (file)
 /**
  * A class that simplifies the process of execution logging. It does so by
  * providing
- * @begin{itemize}
+ * <ul>
  * @item a push and pop mechanism for prefixes, and
  * @item the possibility of distributing information to files and the
  *   console.
- * @end{itemize}
+ * </ul>
  *
  * The usual usage of this class is through the pregenerated object
  * <tt>deallog</tt>. Typical steps are
- * @begin{itemize}
+ * <ul>
  * @item <tt>deallog.attach(std::ostream)</tt>: write logging information into a file.
  * @item <tt>deallog.depth_console(n)</tt>: 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 <tt>deallog << anything << std::endl;</tt> to write logging information
  *       (Usage of <tt>std::endl</tt> is mandatory!).
  * @item <tt>deallog.pop()</tt> when leaving that stage entered with <tt>push</tt>.
- * @end{itemize}
+ * </ul>
  *
  * @author Guido Kanschat, Wolfgang Bangerth, 1999, 2003
  */
index d618160a489104c13b82f4ce169e4f7bf2d4b20d..50920c0f25ac425db8e37be78aa242edfcf210bc 100644 (file)
@@ -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: <tt>\#</tt>, <tt>{</tt>, 
- *   <tt>}</tt>, <tt>|</tt>. Their use is reserved for the @ref{MultipleParameterLoop} class.
+ *   <tt>}</tt>, <tt>|</tt>. 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 <tt>ofile.1</tt>, <tt>ofile.2</tt>,
  *   <tt>ofile.3</tt> and <tt>ofile.4</tt>, respectively. Array entries do not generate multiple
index 3d5e21f811725a0665d2bb83127786c927a721eb..8898d898ce2c9b44df66b834b9e2a650abb39728 100644 (file)
@@ -409,7 +409,7 @@ namespace Polynomials
                                         * constructor.  This way, it can
                                         * use the non-standard
                                         * constructor of
-                                        * @ref{Polynomial}.
+                                        * Polynomial.
                                         */
       static const std::vector<double> &
       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<double> &
      get_coefficients (const unsigned int p);
index 0360d9283d4b2601b8b840dd5506cbc79224ffea..239e38114dcfad000d02456710b9f34816a65608 100644 (file)
  * P<sub>i</sub>(x)P<sub>j</sub>(y)P<sub>k</sub>(z)</i>, where the sum
  * of <i>i</i>, <i>j</i> and <i>k</i> is less than or equal <i>n</i>.
  *
- * 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
  */
index e24b8b009792f4984c2d8352d4c3a5779cf4f8a2..05e84e5f287d9f68476b9e1a1f2a2fb9309fab8e 100644 (file)
@@ -60,7 +60,7 @@ class PolynomialsP: public PolynomialSpace<dim>
                                      * Note, that this number is
                                      * <tt>PolynomialSpace::degree()-1</tt>,
                                      * compare definition in
-                                     * @ref{PolynomialSpace}.
+                                     * PolynomialSpace.
                                      */
     unsigned int degree() const;
 
index 3fa7d8b7f9eeefeed4d411929964cf03dc0bbd0b..b01f35ae9acd67e54adba52b587a73a754b7f36c 100644 (file)
@@ -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
index da05e878a6df2c5990437057958bf9bb92f12244..30ee033800e59bbd409fb556fe0f765906ff034e 100644 (file)
@@ -24,7 +24,7 @@
  * The coefficients of these quadrature rules are computed by the
  * function found in <tt>Numerical Recipies</tt>. 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.
  *
index c5966f6ae1a0c48d03162606a88a8ee8d49b35fc..dd94a8c2809a6e81b81f533b53297ed744d87fdb 100644 (file)
 
 /**
  * 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<dim>
                                      * as a list separated by <tt>|</tt>,
                                      * 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();
index 8388d61956557d0e98463ba7e6340e1422950a11..381d655adb7d4e203e810fd15e31de36789462c4 100644 (file)
@@ -32,12 +32,12 @@ template <bool, typename> 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>
  *   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 <bool, typename> 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 <bool, typename> struct constraint_and_return_value;
  *   template <typename T> struct constraint_and_return_value<true,T> {
  *     typedef T type;
  *   };
- * @end{verbatim}
+ * @endverbatim
  * constraint_and_return_value<false,T> is not defined. Given something like
- * @begin{verbatim}
+ * @verbatim
  *   template <typename>
  *   struct int_or_double         { static const bool value = false;};
  *   template <>
  *   struct int_or_double<int>    { static const bool value = true; };
  *   template <>
  *   struct int_or_double<double> { static const bool value = true; };
- * @end{verbatim}
+ * @endverbatim
  * we can write a template
- * @begin{verbatim}
+ * @verbatim
  *   template <typename T>
  *   typename constraint_and_return_value<int_or_double<T>::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
index fa9c0bd32ae1c54848c4de1b08f9caf62e5195fb..1624cd782c047fd540eceea7ae421ad365a2bbcc 100644 (file)
@@ -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
index d8f0662e00a7f3391ec2ef334a12c6348dad0e42..903b35c951d601424900ee73466a67ea2f90397c 100644 (file)
  * P<sub>2</sub>(x)P<sub>2</sub>(y), P<sub>3</sub>(x)P<sub>2</sub>(y),
  * ...</i> 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<Pol> &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<n_tensor_pols; ++i)
     {
       index_map[i]=i;
index 41ae1ebd6a3dc95877b9364328fe645e958054ad..13c33cd67013f77ed795cc03fc6cc8e9e1225c8c 100644 (file)
@@ -561,8 +561,8 @@ namespace Threads
                                     * Upon program start, this number
                                     * is one. It is increased each
                                     * time a thread is created using
-                                    * the @ref{Threads::spawn} or
-                                    * @ref{Threads::spawn_n}
+                                    * the Threads::spawn or
+                                    * Threads::spawn_n()
                                     * functions. It is decreased once
                                     * a thread terminates by returning
                                     * from the function that was
@@ -2883,7 +2883,7 @@ namespace Threads
                                      /**
                                      * @internal
                                       * Class derived from
-                                      * @ref{thread_description_base}
+                                      * thread_description_base()
                                       * that also provides the
                                       * possibility to store a return
                                       * value.

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.