From: Wolfgang Bangerth Date: Fri, 13 Jan 2006 23:03:25 +0000 (+0000) Subject: Augment documentation. Move a bunch of classes into doxygen modules that better fit... X-Git-Tag: v8.0.0~12652 X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=e9d89770748fbe058f0b98ab48d646e6d35ccec4;p=dealii.git Augment documentation. Move a bunch of classes into doxygen modules that better fit them. git-svn-id: https://svn.dealii.org/trunk@12012 0785d39b-7218-0410-832d-ea1e28bc413d --- diff --git a/deal.II/base/include/base/data_out_base.h b/deal.II/base/include/base/data_out_base.h index c5b90ecdb7..290c959295 100644 --- a/deal.II/base/include/base/data_out_base.h +++ b/deal.II/base/include/base/data_out_base.h @@ -185,7 +185,7 @@ class ParameterHandler; * * * - * @ingroup IO + * @ingroup output * @author Wolfgang Bangerth, Guido Kanschat 1999, 2000, 2001, 2002, 2005. */ class DataOutBase @@ -215,7 +215,7 @@ class DataOutBase * | | | | | * |__|__|__|__| * @endverbatim - * @ingroup IO + * @ingroup output * @author Wolfgang Bangerth */ template @@ -396,7 +396,7 @@ class DataOutBase * Flags controlling the details of * output in OpenDX format. * - * @ingroup IO + * @ingroup output */ struct DXFlags { @@ -491,7 +491,7 @@ class DataOutBase * of output in UCD format for * @ref SoftwareAVS. * - * @ingroup IO + * @ingroup output */ struct UcdFlags { @@ -556,7 +556,7 @@ class DataOutBase * output in Gnuplot format. At * present no flags are implemented. * - * @ingroup IO + * @ingroup output */ struct GnuplotFlags { @@ -616,7 +616,7 @@ class DataOutBase * implemented, see their * respective documentation. * - * @ingroup IO + * @ingroup output */ struct PovrayFlags { @@ -696,7 +696,7 @@ class DataOutBase * output in encapsulated postscript * format. * - * @ingroup IO + * @ingroup output */ struct EpsFlags { @@ -1026,7 +1026,7 @@ class DataOutBase * output in gmv format. At * present no flags are implemented. * - * @ingroup IO + * @ingroup output */ struct GmvFlags { @@ -1084,7 +1084,7 @@ class DataOutBase * of output in @ref * SoftwareTecplot format. * - * @ingroup IO + * @ingroup output */ struct TecplotFlags { @@ -1148,9 +1148,9 @@ class DataOutBase * Flags controlling the details * of output in VTK format. At * present no flags are - * implemented. + * implemented. See @ref SoftwareVTK. * - * @ingroup IO + * @ingroup output */ struct VtkFlags { @@ -1212,7 +1212,7 @@ class DataOutBase * present no flags are * implemented. * - * @ingroup IO + * @ingroup output */ struct Deal_II_IntermediateFlags { @@ -1316,10 +1316,13 @@ class DataOutBase * format. */ tecplot_binary, + /** * Output in VTK format. + * @ref SoftwareVTK */ vtk, + /** * Output in deal.II * intermediate format. @@ -1481,7 +1484,7 @@ class DataOutBase /** * Write the given list of patches to the output stream for the povray raytracer. + * href="http://www.povray.org">povray raytracer. * * Output in this format creates a povray source file, include * standard camera and light source definition for rendering with @@ -1990,7 +1993,7 @@ class DataOutBase * suffix for the output file name can be obtained by default_suffix * without arguments. * - * @ingroup IO + * @ingroup output * @author Wolfgang Bangerth, 1999 */ template @@ -2422,7 +2425,7 @@ class DataOutInterface : private DataOutBase * function is explained in step-19. * * - * @ingroup IO + * @ingroup input output * @author Wolfgang Bangerth, 2005 */ template diff --git a/deal.II/base/include/base/quadrature.h b/deal.II/base/include/base/quadrature.h index 7d4273ff3a..32e85823ff 100644 --- a/deal.II/base/include/base/quadrature.h +++ b/deal.II/base/include/base/quadrature.h @@ -2,7 +2,7 @@ // $Id$ // Version: $Name$ // -// Copyright (C) 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005 by the deal.II authors +// Copyright (C) 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006 by the deal.II authors // // This file is subject to QPL and may not be distributed // without copyright and license information. Please refer @@ -299,8 +299,6 @@ class QIterated : public Quadrature QIterated (const Quadrature<1> &base_quadrature, const unsigned int n_copies); - /** @addtogroup Exceptions - * @{ */ /** * Exception */ diff --git a/deal.II/deal.II/include/fe/fe_system.h b/deal.II/deal.II/include/fe/fe_system.h index 2c1ee3525e..dc1ebaec35 100644 --- a/deal.II/deal.II/include/fe/fe_system.h +++ b/deal.II/deal.II/include/fe/fe_system.h @@ -2,7 +2,7 @@ // $Id$ // Version: $Name$ // -// Copyright (C) 1999, 2000, 2001, 2002, 2003, 2004, 2005 by the deal.II authors +// Copyright (C) 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006 by the deal.II authors // // This file is subject to QPL and may not be distributed // without copyright and license information. Please refer @@ -23,7 +23,7 @@ #include -/*!@addtogroup febase */ +/*!@addtogroup febase fe */ /*@{*/ /** diff --git a/deal.II/deal.II/include/fe/fe_tools.h b/deal.II/deal.II/include/fe/fe_tools.h index 4288c7b405..05d0e6d89c 100644 --- a/deal.II/deal.II/include/fe/fe_tools.h +++ b/deal.II/deal.II/include/fe/fe_tools.h @@ -38,7 +38,7 @@ class ConstraintMatrix; #include #include -/*!@addtogroup febase */ +/*!@addtogroup feall */ /*@{*/ diff --git a/deal.II/deal.II/include/fe/fe_update_flags.h b/deal.II/deal.II/include/fe/fe_update_flags.h index 96ec5659f7..5bec6b407f 100644 --- a/deal.II/deal.II/include/fe/fe_update_flags.h +++ b/deal.II/deal.II/include/fe/fe_update_flags.h @@ -2,7 +2,7 @@ // $Id$ // Version: $Name$ // -// Copyright (C) 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005 by the deal.II authors +// Copyright (C) 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006 by the deal.II authors // // This file is subject to QPL and may not be distributed // without copyright and license information. Please refer @@ -17,7 +17,7 @@ #include -/*!@addtogroup febase */ +/*!@addtogroup feaccess */ /*@{*/ /** diff --git a/deal.II/deal.II/include/fe/mapping.h b/deal.II/deal.II/include/fe/mapping.h index 83950c4ee6..e4bfa3aaca 100644 --- a/deal.II/deal.II/include/fe/mapping.h +++ b/deal.II/deal.II/include/fe/mapping.h @@ -30,8 +30,6 @@ template class FESubfaceValues; //TODO: Offset in transform functions should be replaced by initializing VectorSlice correctly -/*!@addtogroup febase */ -/*@{*/ /** * Abstract base class for mapping classes. @@ -53,6 +51,7 @@ template class FESubfaceValues; * A hint to implementators: no function except the two functions * @p update_once and @p update_each may add any flags. * + * @ingroup mapping * @author Guido Kanschat, Ralf Hartmann 2000, 2001 */ template @@ -500,7 +499,6 @@ class Mapping : public Subscriptor friend class FESubfaceValues; }; -/*@}*/ /* ------------------------- inline functions ------------------------- */ diff --git a/deal.II/deal.II/include/grid/grid_in.h b/deal.II/deal.II/include/grid/grid_in.h index d6f6b8a01f..b2cff3da8e 100644 --- a/deal.II/deal.II/include/grid/grid_in.h +++ b/deal.II/deal.II/include/grid/grid_in.h @@ -2,7 +2,7 @@ // $Id$ // Version: $Name$ // -// Copyright (C) 1999, 2000, 2001, 2002, 2003, 2004, 2005 by the deal.II authors +// Copyright (C) 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006 by the deal.II authors // // This file is subject to QPL and may not be distributed // without copyright and license information. Please refer @@ -178,7 +178,7 @@ class SubCellData; * through this class. * * @ingroup grid - * @ingroup IO + * @ingroup input * @author Wolfgang Bangerth, 1998, 2000, Luca Heltai, 2004 */ template diff --git a/deal.II/deal.II/include/grid/grid_out.h b/deal.II/deal.II/include/grid/grid_out.h index e3052793b1..0d515a4429 100644 --- a/deal.II/deal.II/include/grid/grid_out.h +++ b/deal.II/deal.II/include/grid/grid_out.h @@ -2,7 +2,7 @@ // $Id$ // Version: $Name$ // -// Copyright (C) 1999, 2000, 2001, 2002, 2003, 2004, 2005 by the deal.II authors +// Copyright (C) 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006 by the deal.II authors // // This file is subject to QPL and may not be distributed // without copyright and license information. Please refer @@ -31,14 +31,14 @@ template class Mapping; * different subclasses and the documentation of the GridOut * class for more details. * - * @ingroup IO + * @ingroup output */ namespace GridOutFlags { /** * Flags for grid output in OpenDX format. * - * @ingroup IO + * @ingroup output */ struct DX { @@ -82,7 +82,7 @@ namespace GridOutFlags * Flags describing the details of * output in UCD format. * - * @ingroup IO + * @ingroup output */ struct Ucd { @@ -131,7 +131,7 @@ namespace GridOutFlags * Flags describing the details of * output in GNUPLOT format. * - * @ingroup IO + * @ingroup output */ struct Gnuplot { @@ -184,7 +184,7 @@ namespace GridOutFlags * is scaled such that the width equals * 300 units. * - * @ingroup IO + * @ingroup output */ struct EpsFlagsBase { @@ -282,7 +282,7 @@ namespace GridOutFlags * general template and declare * explicit specializations below. * - * @ingroup IO + * @ingroup output */ template struct Eps @@ -292,7 +292,7 @@ namespace GridOutFlags * Flags specific to the output of * grids in one space dimensions. * - * @ingroup IO + * @ingroup output */ template <> struct Eps<1> : public EpsFlagsBase @@ -312,7 +312,7 @@ namespace GridOutFlags * Flags specific to the output of * grids in two space dimensions. * - * @ingroup IO + * @ingroup output */ template <> struct Eps<2> : public EpsFlagsBase @@ -376,7 +376,7 @@ namespace GridOutFlags * Flags specific to the output of * grids in three space dimensions. * - * @ingroup IO + * @ingroup output */ template <> struct Eps<3> : public EpsFlagsBase @@ -419,7 +419,7 @@ namespace GridOutFlags /** * Flags for XFig output. * - * @ingroup IO + * @ingroup output */ struct XFig { @@ -581,7 +581,7 @@ namespace GridOutFlags * as usual. * * @ingroup grid - * @ingroup IO + * @ingroup output * @author Wolfgang Bangerth, Guido Kanschat, 1999, 2003; postscript format based on an implementation by Stefan Nauber, 1999 */ class GridOut diff --git a/deal.II/deal.II/include/numerics/data_out.h b/deal.II/deal.II/include/numerics/data_out.h index 04f4cc82da..49d2bae3fb 100644 --- a/deal.II/deal.II/include/numerics/data_out.h +++ b/deal.II/deal.II/include/numerics/data_out.h @@ -159,7 +159,7 @@ template class FEValuesBase; * triangulation, so that the last template parameter has the same * value as the second one. * - * @ingroup IO + * @ingroup output * @author Wolfgang Bangerth, 1999 */ template class DH, @@ -858,7 +858,7 @@ class DataOut_DoFData : public DataOutInterface * this pair of functions and they return a non-active cell, then an exception * will be thrown. * - * @ingroup IO + * @ingroup output * @author Wolfgang Bangerth, 1999 */ template class DH = DoFHandler> diff --git a/deal.II/deal.II/include/numerics/data_out_faces.h b/deal.II/deal.II/include/numerics/data_out_faces.h index 6501a32889..959c713902 100644 --- a/deal.II/deal.II/include/numerics/data_out_faces.h +++ b/deal.II/deal.II/include/numerics/data_out_faces.h @@ -2,7 +2,7 @@ // $Id$ // Version: $Name$ // -// Copyright (C) 2000, 2001, 2002, 2003, 2004, 2005 by the deal.II authors +// Copyright (C) 2000, 2001, 2002, 2003, 2004, 2005, 2006 by the deal.II authors // // This file is subject to QPL and may not be distributed // without copyright and license information. Please refer @@ -75,7 +75,7 @@ template class DoFHandler; * applications certainly exist, for which the author is not * imaginative enough. * - * @ingroup IO + * @ingroup output * @author Wolfgang Bangerth, 2000 */ template class DH = DoFHandler> diff --git a/deal.II/deal.II/include/numerics/data_out_rotation.h b/deal.II/deal.II/include/numerics/data_out_rotation.h index 29cd1b1c43..6a6ec57dfc 100644 --- a/deal.II/deal.II/include/numerics/data_out_rotation.h +++ b/deal.II/deal.II/include/numerics/data_out_rotation.h @@ -2,7 +2,7 @@ // $Id$ // Version: $Name$ // -// Copyright (C) 2000, 2001, 2002, 2003, 2004, 2005 by the deal.II authors +// Copyright (C) 2000, 2001, 2002, 2003, 2004, 2005, 2006 by the deal.II authors // // This file is subject to QPL and may not be distributed // without copyright and license information. Please refer @@ -77,7 +77,7 @@ template class DoFHandler; * It is in the responsibility of the user to make sure that the * radial variable attains only non-negative values. * - * @ingroup IO + * @ingroup output * @author Wolfgang Bangerth, 2000 */ template class DH = DoFHandler> diff --git a/deal.II/deal.II/include/numerics/data_out_stack.h b/deal.II/deal.II/include/numerics/data_out_stack.h index e8096e2bff..34d9607551 100644 --- a/deal.II/deal.II/include/numerics/data_out_stack.h +++ b/deal.II/deal.II/include/numerics/data_out_stack.h @@ -2,7 +2,7 @@ // $Id$ // Version: $Name$ // -// Copyright (C) 1999, 2000, 2001, 2002, 2003, 2004, 2005 by the deal.II authors +// Copyright (C) 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006 by the deal.II authors // // This file is subject to QPL and may not be distributed // without copyright and license information. Please refer @@ -98,7 +98,7 @@ template class DoFHandler; * }; * @endverbatim * - * @ingroup IO + * @ingroup output * @author Wolfgang Bangerth, 1999 */ template class DH = DoFHandler> diff --git a/deal.II/lac/include/lac/matrix_out.h b/deal.II/lac/include/lac/matrix_out.h index 7e209cd222..ef8af2dd69 100644 --- a/deal.II/lac/include/lac/matrix_out.h +++ b/deal.II/lac/include/lac/matrix_out.h @@ -2,7 +2,7 @@ // $Id$ // Version: $Name$ // -// Copyright (C) 2001, 2002, 2003, 2004, 2005 by the deal.II authors +// Copyright (C) 2001, 2002, 2003, 2004, 2005, 2006 by the deal.II authors // // This file is subject to QPL and may not be distributed // without copyright and license information. Please refer @@ -81,7 +81,7 @@ * D d; * @endverbatim * - * @ingroup IO + * @ingroup output * @author Wolfgang Bangerth, 2001 */ class MatrixOut : public DataOutInterface<2,2> diff --git a/deal.II/lac/include/lac/sparse_direct.h b/deal.II/lac/include/lac/sparse_direct.h index a25959c3ae..19a030352f 100644 --- a/deal.II/lac/include/lac/sparse_direct.h +++ b/deal.II/lac/include/lac/sparse_direct.h @@ -2,7 +2,7 @@ // $Id$ // Version: $Name$ // -// Copyright (C) 2001, 2002, 2003, 2004, 2005 by the deal.II authors +// Copyright (C) 2001, 2002, 2003, 2004, 2005, 2006 by the deal.II authors // // This file is subject to QPL and may not be distributed // without copyright and license information. Please refer @@ -24,10 +24,6 @@ -/*! @addtogroup Preconditioners - *@{ - */ - /** * This class provides an interface to the sparse direct solver MA27 * from the Harwell Subroutine Library. MA27 is a direct solver @@ -182,6 +178,7 @@ * seconds. After that time, the detached solver should have noticed * the main programs demise. * + * @ingroup Solvers Preconditioners * * @author Wolfgang Bangerth, 2000, 2001, 2002 */ @@ -666,6 +663,9 @@ class SparseDirectMA27 : public Subscriptor * A detached mode as for MA27 has not yet been implemented for this * class. * + * + * @ingroup Solvers Preconditioners + * * @author Wolfgang Bangerth, 2000, 2001 */ class SparseDirectMA47 : public Subscriptor @@ -1027,6 +1027,9 @@ class SparseDirectMA47 : public Subscriptor * from the deal.II ReadMe file. UMFPACK is included courtesy of its author, * Timothy A. Davis. * + * + * @ingroup Solvers Preconditioners + * * @author Wolfgang Bangerth, 2004 */ class SparseDirectUMFPACK : public Subscriptor @@ -1214,8 +1217,6 @@ class SparseDirectUMFPACK : public Subscriptor }; -/*@}*/ - #endif