From: Guido Kanschat Date: Tue, 12 Aug 2003 16:21:17 +0000 (+0000) Subject: Documentation update for doxygen X-Git-Tag: v8.0.0~16297 X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=c5adf2f825f207726a2112c6161a00158a5d484b;p=dealii.git Documentation update for doxygen git-svn-id: https://svn.dealii.org/trunk@7913 0785d39b-7218-0410-832d-ea1e28bc413d --- diff --git a/deal.II/base/include/base/auto_derivative_function.h b/deal.II/base/include/base/auto_derivative_function.h index c0d772ab86..1b5cbfa9d7 100644 --- a/deal.II/base/include/base/auto_derivative_function.h +++ b/deal.II/base/include/base/auto_derivative_function.h @@ -80,8 +80,17 @@ class AutoDerivativeFunction : public Function */ enum DifferenceFormula { + /** + * Symmetric Euler scheme + */ Euler, + /** + * Upwind Euler scheme + */ UpwindEuler, + /** + * Difference formula of 4th order. + */ FourthOrder }; diff --git a/deal.II/base/include/base/data_out_base.h b/deal.II/base/include/base/data_out_base.h index aaab631ad4..186077192f 100644 --- a/deal.II/base/include/base/data_out_base.h +++ b/deal.II/base/include/base/data_out_base.h @@ -306,7 +306,7 @@ class ParameterHandler; * files directly make sure that the TECHOME environment variable points to the * Tecplot installation directory, and that the files $TECHOME/include/TECIO.h * and $TECHOME/lib/tecio.a are readable. If these files are not availabe (or in the - * case of 1D) @p{write_tecplot_binary} will simply call @{write_tecplot} and thus larger + * case of 1D) @p{write_tecplot_binary} will simply call @p{write_tecplot} and thus larger * ASCII data files will be produced rather than more efficient Tecplot binary files. * For more information consult the Tecplot Users and Reference manuals. * @@ -1669,7 +1669,50 @@ class DataOutInterface : private DataOutBase * the presently supported output * formats. */ - enum OutputFormat { default_format, dx, ucd, gnuplot, povray, eps, gmv, tecplot, tecplot_binary, vtk }; + enum OutputFormat { + default_format, + /** + * Output for IBM OpenDX. + */ + dx, + /** + * Output in AVS UCD format. + */ + ucd, + /** + * Output for the gnuplot tool. + */ + gnuplot, + /** + * Output for the povray raytracer. + */ + povray, + /** + * Output in encapsulated + * PostScript. + */ + eps, + /** + * Output for GMV. + */ + gmv, + /** + * Output for tecplot in + * text format. + */ + + tecplot, + /** + * Output for tecplot in + * binaryformat. Faster and + * smaller than text + * format. + */ + tecplot_binary, + /** + * Output in VTK format. + */ + vtk }; /** * Obtain data through the diff --git a/deal.II/base/include/base/memory_consumption.h b/deal.II/base/include/base/memory_consumption.h index e779d940da..544e02745a 100644 --- a/deal.II/base/include/base/memory_consumption.h +++ b/deal.II/base/include/base/memory_consumption.h @@ -56,7 +56,7 @@ * * Finally, if we cannot reduce a type @p{T} further, because it is * neither atomic nor a known C++ data type, we call a member function - * @{T::memory_consumption} on it, which we assume to exist. Almost + * @p{T::memory_consumption} on it, which we assume to exist. Almost * all classes in the deal.II library have such a function. This way, * if we call @p{memory_consumption(v)} on a vector @p{v} of type * @p{FullMatrix}, we first reduce this to a loop in which we diff --git a/deal.II/base/include/base/parameter_handler.h b/deal.II/base/include/base/parameter_handler.h index ced2614aad..0d035c23d9 100644 --- a/deal.II/base/include/base/parameter_handler.h +++ b/deal.II/base/include/base/parameter_handler.h @@ -1198,7 +1198,20 @@ class ParameterHandler * formats. */ enum OutputStyle { - Text, LaTeX, HTML + /** + * Write human readable output. + */ + Text, + /** + * Write paramteters as a + * LaTeX table. + */ + LaTeX, + /** + * Write parameters as an + * HTML table. + */ + HTML }; diff --git a/deal.II/base/include/base/polynomial_space.h b/deal.II/base/include/base/polynomial_space.h index 0151d48dae..2f06766044 100644 --- a/deal.II/base/include/base/polynomial_space.h +++ b/deal.II/base/include/base/polynomial_space.h @@ -28,8 +28,8 @@ * Representation of the space of polynomials of degree at most n in * higher dimensions. * - * Given a vector of @{n} one-dimensional polynomials @{P0} to @{Pn}, - * where @{Pi} has degree @p{i}, this class generates all polynomials + * Given a vector of @p{n} one-dimensional polynomials @p{P0} to @p{Pn}, + * where @p{Pi} has degree @p{i}, this class generates all polynomials * of the form @p{ Pijk(x,y,z) = Pi(x)Pj(y)Pk(z)}, where the sum of * @p{i}, @p{j} and @p{k} is less than or equal @p{n}. * diff --git a/deal.II/base/include/base/subscriptor.h b/deal.II/base/include/base/subscriptor.h index 37648b2705..d7cc86303a 100644 --- a/deal.II/base/include/base/subscriptor.h +++ b/deal.II/base/include/base/subscriptor.h @@ -22,6 +22,7 @@ namespace internal { /** + * @internal * A namespace in which we * implement helper classes for the * subscriptor class. @@ -29,6 +30,7 @@ namespace internal namespace Subscriptor { /** + * @internal * Template class that declares * in inner typedef with the * following semantics: if the @@ -71,6 +73,7 @@ namespace internal }; /** + * @internal * Specialization of the template * for the case that the first * template argument is diff --git a/deal.II/base/include/base/table.h b/deal.II/base/include/base/table.h index ed48415406..690303dd3c 100644 --- a/deal.II/base/include/base/table.h +++ b/deal.II/base/include/base/table.h @@ -276,6 +276,7 @@ namespace internal { /** + * @internal * Have a namespace in which we declare some classes that are used to * access the elements of tables using the @p{operator[]}. These are * quite technical, since they have to do their work recursively (due @@ -295,6 +296,7 @@ namespace internal namespace TableBaseAccessors { /** + * @internal * Have a class which declares some nested typedefs, depending on its * template parameters. The general template declares nothing, but * there are more useful specializations regaring the last parameter @@ -306,6 +308,7 @@ namespace internal {}; /** + * @internal * Have a class which declares some nested typedefs, depending on its * template parameters. Specialization for accessors to constant * objects. @@ -317,6 +320,7 @@ namespace internal }; /** + * @internal * Have a class which declares some nested typedefs, depending on its * template parameters. Specialization for accessors to non-constant * objects. @@ -329,6 +333,7 @@ namespace internal /** + * @internal * Class that acts as accessor to subobjects of tables of type * @p{Table}. The template parameter @p{C} may be either true or * false, and indicates whether the objects worked on are constant or @@ -469,6 +474,7 @@ namespace internal /** + * @internal * Accessor class for tables. This is the specialization for the last * index, which actually allows access to the elements of the table, * rather than recursively returning access objects for further diff --git a/deal.II/base/include/base/tensor_product_polynomials.h b/deal.II/base/include/base/tensor_product_polynomials.h index cd498c5a7e..f705c7a93c 100644 --- a/deal.II/base/include/base/tensor_product_polynomials.h +++ b/deal.II/base/include/base/tensor_product_polynomials.h @@ -26,7 +26,7 @@ /** * Tensor product of given polynomials. * - * Given a vector of @{n} one-dimensional polynomials @{P1} to @{Pn}, + * Given a vector of @p{n} one-dimensional polynomials @p{P1} to @p{Pn}, * this class generates @p{n} to the power of @p{dim} polynomials of * the form @p{ Qijk(x,y,z) = Pi(x)Pj(y)Pk(z)}. If the base * polynomials are mutually orthogonal on the interval $[-1,1]$ or @@ -226,8 +226,8 @@ class TensorProductPolynomials /** * Anisotropic tensor product of given polynomials. * - * Given one-dimensional polynomials @{Px1}, @{Px2}, ... in - * x-direction, @{Py1}, @{Py2}, ... in y-direction, and so on, this + * Given one-dimensional polynomials @p{Px1}, @p{Px2}, ... in + * x-direction, @p{Py1}, @p{Py2}, ... in y-direction, and so on, this * class generates polynomials of the form @p{ Qijk(x,y,z) = * Pxi(x)Pyj(y)Pzk(z)}. If the base polynomials are mutually * orthogonal on the interval $[-1,1]$ or $[0,d], then the tensor diff --git a/deal.II/base/include/base/thread_management.h b/deal.II/base/include/base/thread_management.h index 636e91961e..858a0f7145 100644 --- a/deal.II/base/include/base/thread_management.h +++ b/deal.II/base/include/base/thread_management.h @@ -34,7 +34,9 @@ - +/** + * A namespace for the implementation of thread management in deal.II. + */ namespace Threads { /** @@ -645,6 +647,7 @@ namespace Threads namespace internal { /** + * @internal * If in a sub-thread an * exception is thrown, it is not * propagated to the main @@ -676,6 +679,7 @@ namespace Threads void handle_std_exception (const std::exception &exc); /** + * @internal * Same as above, but the type of * the exception is not derived * from @p{std::exception}, so @@ -685,6 +689,7 @@ namespace Threads void handle_unknown_exception (); /** + * @internal * The following function is used * for internal bookkeeping of the * number of existing threads. It @@ -696,6 +701,7 @@ namespace Threads void register_thread (); /** + * @internal * The following function is used * for internal bookkeeping of the * number of existing threads. It @@ -775,6 +781,7 @@ namespace Threads namespace internal { /** + * @internal * A type that is used to * distinguish argument lists of * functions by enumeration. @@ -788,7 +795,8 @@ namespace Threads namespace internal { /** - * Given an arbitrary type RT, + * @internal + * Given an arbitrary type RT, * store an element of it and grant * access to it through functions * get() and set(). There are @@ -809,6 +817,7 @@ namespace Threads /** + * @internal * Given an arbitrary type RT, * store an element of it and grant * access to it through functions @@ -833,6 +842,7 @@ namespace Threads /** + * @internal * Given an arbitrary type RT, * store an element of it and grant * access to it through functions @@ -853,6 +863,7 @@ namespace Threads namespace internal { /** + * @internal * Call arbitrary functions with * return type RT. For each number * of arguments to these functions, @@ -1309,6 +1320,7 @@ namespace Threads /** + * @internal * Call arbitrary functions with * void return type. For each * number of arguments to these @@ -1739,6 +1751,7 @@ namespace Threads /** + * @internal * Call an arbitrary function by * dispatching to the functions in * the Caller class based on the @@ -1758,6 +1771,7 @@ namespace Threads /** + * @internal * Call an arbitrary member * function by dispatching to the * functions in the Caller class @@ -1781,6 +1795,7 @@ namespace Threads namespace internal { /** + * @internal * Construct a pointer to member * function based on the template * arguments, and whether the @@ -1800,6 +1815,7 @@ namespace Threads /** + * @internal * Construct a pointer to member * function based on the template * arguments. This is the @@ -1813,6 +1829,7 @@ namespace Threads }; /** + * @internal * Construct a pointer to member * function based on the template * arguments. This is the @@ -1827,6 +1844,7 @@ namespace Threads /** + * @internal * Construct a pointer to member * function based on the template * arguments. This is the @@ -1840,6 +1858,7 @@ namespace Threads }; /** + * @internal * Construct a pointer to member * function based on the template * arguments. This is the @@ -1854,6 +1873,7 @@ namespace Threads /** + * @internal * Construct a pointer to member * function based on the template * arguments. This is the @@ -1868,6 +1888,7 @@ namespace Threads }; /** + * @internal * Construct a pointer to member * function based on the template * arguments. This is the @@ -1883,6 +1904,7 @@ namespace Threads /** + * @internal * Construct a pointer to member * function based on the template * arguments. This is the @@ -1898,6 +1920,7 @@ namespace Threads }; /** + * @internal * Construct a pointer to member * function based on the template * arguments. This is the @@ -1914,6 +1937,7 @@ namespace Threads /** + * @internal * Construct a pointer to member * function based on the template * arguments. This is the @@ -1930,6 +1954,7 @@ namespace Threads }; /** + * @internal * Construct a pointer to member * function based on the template * arguments. This is the @@ -1947,6 +1972,7 @@ namespace Threads /** + * @internal * Construct a pointer to member * function based on the template * arguments. This is the @@ -1964,6 +1990,7 @@ namespace Threads }; /** + * @internal * Construct a pointer to member * function based on the template * arguments. This is the @@ -1982,6 +2009,7 @@ namespace Threads /** + * @internal * Construct a pointer to member * function based on the template * arguments. This is the @@ -2000,6 +2028,7 @@ namespace Threads }; /** + * @internal * Construct a pointer to member * function based on the template * arguments. This is the @@ -2019,6 +2048,7 @@ namespace Threads /** + * @internal * Construct a pointer to member * function based on the template * arguments. This is the @@ -2038,6 +2068,7 @@ namespace Threads }; /** + * @internal * Construct a pointer to member * function based on the template * arguments. This is the @@ -2058,6 +2089,7 @@ namespace Threads /** + * @internal * Construct a pointer to member * function based on the template * arguments. This is the @@ -2078,6 +2110,7 @@ namespace Threads }; /** + * @internal * Construct a pointer to member * function based on the template * arguments. This is the @@ -2099,6 +2132,7 @@ namespace Threads /** + * @internal * Construct a pointer to member * function based on the template * arguments. This is the @@ -2120,6 +2154,7 @@ namespace Threads }; /** + * @internal * Construct a pointer to member * function based on the template * arguments. This is the @@ -2143,6 +2178,7 @@ namespace Threads /** + * @internal * Construct a pointer to member * function based on the template * arguments. This is the @@ -2165,6 +2201,7 @@ namespace Threads }; /** + * @internal * Construct a pointer to member * function based on the template * arguments. This is the @@ -2189,6 +2226,7 @@ namespace Threads /** + * @internal * Construct a pointer to member * function based on the template * arguments, and whether the @@ -2220,6 +2258,7 @@ namespace Threads namespace internal { /** + * @internal * Construct a pointer to non-member * function based on the template * arguments, and whether the @@ -2237,6 +2276,7 @@ namespace Threads /** + * @internal * Construct a pointer to non-member * function based on the template * arguments. This is the @@ -2250,6 +2290,7 @@ namespace Threads /** + * @internal * Construct a pointer to non-member * function based on the template * arguments. This is the @@ -2263,6 +2304,7 @@ namespace Threads /** + * @internal * Construct a pointer to non-member * function based on the template * arguments. This is the @@ -2277,6 +2319,7 @@ namespace Threads /** + * @internal * Construct a pointer to non-member * function based on the template * arguments. This is the @@ -2292,6 +2335,7 @@ namespace Threads /** + * @internal * Construct a pointer to non-member * function based on the template * arguments. This is the @@ -2308,6 +2352,7 @@ namespace Threads /** + * @internal * Construct a pointer to non-member * function based on the template * arguments. This is the @@ -2325,6 +2370,7 @@ namespace Threads /** + * @internal * Construct a pointer to non-member * function based on the template * arguments. This is the @@ -2343,6 +2389,7 @@ namespace Threads /** + * @internal * Construct a pointer to non-member * function based on the template * arguments. This is the @@ -2362,6 +2409,7 @@ namespace Threads /** + * @internal * Construct a pointer to non-member * function based on the template * arguments. This is the @@ -2382,6 +2430,7 @@ namespace Threads /** + * @internal * Construct a pointer to non-member * function based on the template * arguments. This is the @@ -2404,6 +2453,7 @@ namespace Threads /** + * @internal * Construct a pointer to non-member * function based on the template * arguments. This is the @@ -2427,6 +2477,7 @@ namespace Threads /** + * @internal * Construct a pointer to * non-member function based on the * template arguments. We do this @@ -2453,6 +2504,7 @@ namespace Threads namespace internal { /** + * @internal * Extract the Nth element of the * type list and make it a * reference. @@ -2465,6 +2517,7 @@ namespace Threads }; /** + * @internal * Specializations of this template * declare a typedef to a tuple * type that has the same basic @@ -2482,6 +2535,7 @@ namespace Threads /** + * @internal * Make a tuple type of all * references out of the given * tuple. Specialization for tuple @@ -2495,6 +2549,7 @@ namespace Threads /** + * @internal * Make a tuple type of all * references out of the given * tuple. Specialization for tuple @@ -2510,6 +2565,7 @@ namespace Threads /** + * @internal * Make a tuple type of all * references out of the given * tuple. Specialization for tuple @@ -2526,6 +2582,7 @@ namespace Threads /** + * @internal * Make a tuple type of all * references out of the given * tuple. Specialization for tuple @@ -2543,6 +2600,7 @@ namespace Threads /** + * @internal * Make a tuple type of all * references out of the given * tuple. Specialization for tuple @@ -2561,6 +2619,7 @@ namespace Threads /** + * @internal * Make a tuple type of all * references out of the given * tuple. Specialization for tuple @@ -2580,6 +2639,7 @@ namespace Threads /** + * @internal * Make a tuple type of all * references out of the given * tuple. Specialization for tuple @@ -2601,6 +2661,7 @@ namespace Threads /** + * @internal * Make a tuple type of all * references out of the given * tuple. Specialization for tuple @@ -2622,6 +2683,7 @@ namespace Threads /** + * @internal * Make a tuple type of all * references out of the given * tuple. Specialization for tuple @@ -2644,6 +2706,7 @@ namespace Threads /** + * @internal * Make a tuple type of all * references out of the given * tuple. Specialization for tuple @@ -2667,6 +2730,7 @@ namespace Threads /** + * @internal * Make a tuple type of all * references out of the given * tuple. Specialization for tuple @@ -2692,6 +2756,7 @@ namespace Threads /** + * @internal * Declare a typedef to a tuple * type that has the same basic * types as the template @@ -2718,6 +2783,7 @@ namespace Threads namespace internal { /** + * @internal * Base class describing a * thread. This is the basic * class abstracting the @@ -2815,6 +2881,7 @@ namespace Threads # endif // defined(DEAL_II_USE_MT_POSIX) /** + * @internal * Class derived from * @ref{thread_description_base} * that also provides the @@ -2968,6 +3035,7 @@ namespace Threads { /** + * @internal * Base class for the classes * wrapping function pointers and * arguments for non-member and @@ -3041,6 +3109,7 @@ namespace Threads /** + * @internal * Wrap the arguments to a * non-member or static member * function and provide an entry @@ -3193,6 +3262,7 @@ namespace Threads /** + * @internal * Wrap the arguments to a member * function and provide an entry * point for a new thread that @@ -3351,6 +3421,7 @@ namespace Threads namespace internal { /** + * @internal * General template declaration * of a class that is used to * encapsulate arguments to @@ -3379,6 +3450,7 @@ namespace Threads /** + * @internal * General template declaration * of a class that is used to * encapsulate arguments to @@ -3411,6 +3483,7 @@ namespace Threads namespace internal { /** + * @internal * Encapsulator class for member * functions with no arguments. */ @@ -3470,6 +3543,7 @@ namespace Threads namespace internal { /** + * @internal * Encapsulator class for member * functions with 1 argument. */ @@ -3529,6 +3603,7 @@ namespace Threads namespace internal { /** + * @internal * Encapsulator class for member * functions with 2 arguments. */ @@ -3589,6 +3664,7 @@ namespace Threads namespace internal { /** + * @internal * Encapsulator class for member * functions with 3 arguments. */ @@ -3656,6 +3732,7 @@ namespace Threads namespace internal { /** + * @internal * Encapsulator class for member * functions with 4 arguments. */ @@ -3723,6 +3800,7 @@ namespace Threads namespace internal { /** + * @internal * Encapsulator class for member * functions with 5 arguments. */ @@ -3794,6 +3872,7 @@ namespace Threads namespace internal { /** + * @internal * Encapsulator class for member * functions with 6 arguments. */ @@ -3867,6 +3946,7 @@ namespace Threads namespace internal { /** + * @internal * Encapsulator class for member * functions with 7 arguments. */ @@ -3948,6 +4028,7 @@ namespace Threads namespace internal { /** + * @internal * Encapsulator class for member * functions with 8 arguments. */ @@ -4034,6 +4115,7 @@ namespace Threads namespace internal { /** + * @internal * Encapsulator class for member * functions with 9 arguments. */ @@ -4122,6 +4204,7 @@ namespace Threads namespace internal { /** + * @internal * Encapsulator class for member * functions with 10 arguments. */ @@ -4216,6 +4299,7 @@ namespace Threads namespace internal { /** + * @internal * Encapsulator class for * functions with no arguments. */ @@ -4262,6 +4346,7 @@ namespace Threads namespace internal { /** + * @internal * Encapsulator class for * functions with 1 argument. */ @@ -4902,6 +4987,7 @@ namespace Threads namespace internal { /** + * @internal * General template declaration * of a class that is used to * forward arguments to @@ -4926,6 +5012,7 @@ namespace Threads class fun_forwarder; /** + * @internal * General template declaration * of a class that is used to * forward arguments to @@ -4953,6 +5040,7 @@ namespace Threads namespace internal { /** + * @internal * Forwarder class for member * functions with no arguments. */ @@ -4981,6 +5069,7 @@ namespace Threads /** + * @internal * Overload of the non-const spawn * function for member functions * with no arguments. This is the @@ -4996,6 +5085,7 @@ namespace Threads } /** + * @internal * Overload of the spawn function * for const member functions with * no arguments. This is the @@ -5018,6 +5108,7 @@ namespace Threads namespace internal { /** + * @internal * Forwarder class for member * functions with 1 argument. */ @@ -5046,6 +5137,7 @@ namespace Threads /** + * @internal * Overload of the non-const spawn * function for member functions with * 1 argument. This is the @@ -5061,6 +5153,7 @@ namespace Threads } /** + * @internal * Overload of the spawn function for * const member functions with 1 * argument. This is the @@ -5083,6 +5176,7 @@ namespace Threads namespace internal { /** + * @internal * Forwarder class for member * functions with 2 * arguments. @@ -5114,6 +5208,7 @@ namespace Threads /** + * @internal * Overload of the non-const spawn * function for member functions * with 2 arguments. This is the @@ -5129,6 +5224,7 @@ namespace Threads } /** + * @internal * Overload of the spawn function * for const member functions with * 2 arguments. This is the version @@ -5150,6 +5246,7 @@ namespace Threads namespace internal { /** + * @internal * Forwarder class for member * functions with 3 * arguments. @@ -5224,6 +5321,7 @@ namespace Threads namespace internal { /** + * @internal * Forwarder class for member * functions with 4 * arguments. @@ -5298,6 +5396,7 @@ namespace Threads namespace internal { /** + * @internal * Forwarder class for member * functions with 5 * arguments. @@ -5376,6 +5475,7 @@ namespace Threads namespace internal { /** + * @internal * Forwarder class for member * functions with 6 * arguments. @@ -5456,6 +5556,7 @@ namespace Threads namespace internal { /** + * @internal * Forwarder class for member * functions with 7 * arguments. @@ -5544,6 +5645,7 @@ namespace Threads namespace internal { /** + * @internal * Forwarder class for member * functions with 8 * arguments. @@ -5637,6 +5739,7 @@ namespace Threads namespace internal { /** + * @internal * Forwarder class for member * functions with 9 * arguments. @@ -5732,6 +5835,7 @@ namespace Threads namespace internal { /** + * @internal * Forwarder class for member * functions with 10 * arguments. @@ -5833,6 +5937,7 @@ namespace Threads namespace internal { /** + * @internal * Forwarder class for functions * with no arguments. */ @@ -5883,6 +5988,7 @@ namespace Threads namespace internal { /** + * @internal * Forwarder class for functions * with 1 argument. */ @@ -5932,6 +6038,7 @@ namespace Threads namespace internal { /** + * @internal * Forwarder class for functions * with 2 arguments. */ @@ -5982,6 +6089,7 @@ namespace Threads namespace internal { /** + * @internal * Forwarder class for functions * with 3 arguments. */ @@ -6037,6 +6145,7 @@ namespace Threads namespace internal { /** + * @internal * Forwarder class for functions * with 4 arguments. */ @@ -6092,6 +6201,7 @@ namespace Threads namespace internal { /** + * @internal * Forwarder class for functions * with 5 arguments. */ @@ -6149,6 +6259,7 @@ namespace Threads namespace internal { /** + * @internal * Forwarder class for functions * with 6 arguments. */ @@ -6207,6 +6318,7 @@ namespace Threads namespace internal { /** + * @internal * Forwarder class for functions * with 7 arguments. */ @@ -6270,6 +6382,7 @@ namespace Threads namespace internal { /** + * @internal * Forwarder class for functions * with 8 arguments. */ @@ -6336,6 +6449,7 @@ namespace Threads namespace internal { /** + * @internal * Forwarder class for functions * with 9 arguments. */ @@ -6404,6 +6518,7 @@ namespace Threads namespace internal { /** + * @internal * Forwarder class for functions * with 10 arguments. */ diff --git a/deal.II/lac/include/lac/block_vector.h b/deal.II/lac/include/lac/block_vector.h index 03f3828bcc..1b7a4f0795 100644 --- a/deal.II/lac/include/lac/block_vector.h +++ b/deal.II/lac/include/lac/block_vector.h @@ -28,10 +28,6 @@ template class BlockVector; -/*! @addtogroup LAC - *@{ - */ - namespace internal { @@ -1242,7 +1238,6 @@ class BlockVector template friend class BlockVector; }; -/*@}*/ /*----------------------- Inline functions ----------------------------------*/ diff --git a/deal.II/lac/include/lac/matrix_out.h b/deal.II/lac/include/lac/matrix_out.h index 3f10ce5ee1..a98cda476a 100644 --- a/deal.II/lac/include/lac/matrix_out.h +++ b/deal.II/lac/include/lac/matrix_out.h @@ -18,11 +18,6 @@ #include #include -/*! @addtogroup LAC - *@{ - */ - - /** * Output a matrix in graphical form using the generic format * independent output routines of the base class. The matrix is @@ -305,8 +300,6 @@ class MatrixOut : public DataOutInterface<2,2> }; -/*@}*/ - /* ---------------------- Template and inline functions ------------- */ diff --git a/deal.II/lac/include/lac/sparse_decomposition.h b/deal.II/lac/include/lac/sparse_decomposition.h index c26bdc6a35..3ac8682c21 100644 --- a/deal.II/lac/include/lac/sparse_decomposition.h +++ b/deal.II/lac/include/lac/sparse_decomposition.h @@ -19,7 +19,7 @@ #include -/*! @addtogroup LAC +/*! @addtogroup Preconditioners *@{ */ diff --git a/deal.II/lac/include/lac/sparse_direct.h b/deal.II/lac/include/lac/sparse_direct.h index 7c743e5fba..4b04418ccd 100644 --- a/deal.II/lac/include/lac/sparse_direct.h +++ b/deal.II/lac/include/lac/sparse_direct.h @@ -24,7 +24,7 @@ -/*! @addtogroup LAC +/*! @addtogroup Preconditioners *@{ */ diff --git a/deal.II/lac/include/lac/sparse_ilu.h b/deal.II/lac/include/lac/sparse_ilu.h index a5aef6f077..da5842073a 100644 --- a/deal.II/lac/include/lac/sparse_ilu.h +++ b/deal.II/lac/include/lac/sparse_ilu.h @@ -18,7 +18,7 @@ #include -/*! @addtogroup LAC +/*! @addtogroup Preconditioners *@{ */ diff --git a/deal.II/lac/include/lac/swappable_vector.h b/deal.II/lac/include/lac/swappable_vector.h index f05c001409..01f00febeb 100644 --- a/deal.II/lac/include/lac/swappable_vector.h +++ b/deal.II/lac/include/lac/swappable_vector.h @@ -20,11 +20,6 @@ #include -/*! @addtogroup LAC - *@{ - */ - - /** * This class is a wrapper to the @p{Vector} class which allows to swap * out the data to a file and reload it later on. It handles the @@ -310,8 +305,6 @@ class SwappableVector : public Vector void reload_vector (const bool set_flag); }; -/*@}*/ - /*---------------------------- swappable_vector.h ---------------------------*/ /* end of #ifndef __deal2__swappable_vector_h */ #endif diff --git a/deal.II/lac/include/lac/vector.h b/deal.II/lac/include/lac/vector.h index c590befaad..46fd41aea4 100644 --- a/deal.II/lac/include/lac/vector.h +++ b/deal.II/lac/include/lac/vector.h @@ -20,10 +20,6 @@ #include -/*! @addtogroup LAC - *@{ - */ - /** * Numerical vector of data. For this class there are different types * of functions available. The first type of function mesures the norm @@ -584,7 +580,6 @@ class Vector template friend class Vector; }; -/*@}*/ /*----------------------- Inline functions ----------------------------------*/