From 62ab82d5f932fca5255620fa842c9d71ddf82ca4 Mon Sep 17 00:00:00 2001 From: guido Date: Mon, 25 Jul 2005 14:49:26 +0000 Subject: [PATCH] new doxygen module IO git-svn-id: https://svn.dealii.org/trunk@11190 0785d39b-7218-0410-832d-ea1e28bc413d --- deal.II/base/include/base/data_out_base.h | 56 ++++++++++++++----- deal.II/deal.II/include/grid/grid_in.h | 2 + deal.II/deal.II/include/grid/grid_out.h | 26 ++++++++- .../deal.II/include/grid/grid_reordering.h | 1 + deal.II/deal.II/include/grid/grid_tools.h | 1 + .../deal.II/include/grid/persistent_tria.h | 1 + deal.II/deal.II/include/grid/tria.h | 8 +++ deal.II/deal.II/include/grid/tria_boundary.h | 1 + deal.II/deal.II/include/grid/tria_hex.h | 1 + deal.II/deal.II/include/grid/tria_iterator.h | 3 + .../deal.II/include/grid/tria_iterator_base.h | 2 + deal.II/deal.II/include/grid/tria_levels.h | 6 ++ deal.II/deal.II/include/grid/tria_line.h | 1 + deal.II/deal.II/include/grid/tria_quad.h | 1 + deal.II/deal.II/include/numerics/data_out.h | 8 ++- .../deal.II/include/numerics/data_out_faces.h | 5 +- .../include/numerics/data_out_rotation.h | 7 ++- .../deal.II/include/numerics/data_out_stack.h | 3 +- .../include/numerics/dof_print_solver_step.h | 1 + deal.II/doc/doxygen/headers/base/dox.h | 7 +++ 20 files changed, 115 insertions(+), 26 deletions(-) diff --git a/deal.II/base/include/base/data_out_base.h b/deal.II/base/include/base/data_out_base.h index 1c6c1f9339..d7cbb95c1e 100644 --- a/deal.II/base/include/base/data_out_base.h +++ b/deal.II/base/include/base/data_out_base.h @@ -183,6 +183,7 @@ class ParameterHandler; * * * + * @ingroup IO * @author Wolfgang Bangerth, Guido Kanschat 1999, 2000, 2001, 2002, 2005. */ class DataOutBase @@ -212,6 +213,7 @@ class DataOutBase * | | | | | * |__|__|__|__| * @endverbatim + * @ingroup IO * @author Wolfgang Bangerth */ template @@ -389,14 +391,23 @@ class DataOutBase }; /** - * Flags describing the details of - * output in OpenDX format. At - * present no flags are implemented. + * Flags controlling the details of + * output in OpenDX format. + * + * @ingroup IO */ struct DXFlags { /** - * Write neighbor information. + * Write neighbor + * information. This + * information is necessary + * for instance, if OpenDX is + * supposed to compute + * integral curves + * (streamlines). If it is + * not present, streamlines + * end at cell boundaries. */ bool write_neighbors; @@ -433,8 +444,10 @@ class DataOutBase }; /** - * Flags describing the details of + * Flags controlling the details of * output in UCD format. + * + * @ingroup IO */ struct UcdFlags { @@ -495,9 +508,11 @@ class DataOutBase }; /** - * Flags describing the details of + * Flags controlling the details of * output in Gnuplot format. At * present no flags are implemented. + * + * @ingroup IO */ struct GnuplotFlags { @@ -551,11 +566,13 @@ class DataOutBase }; /** - * Flags describing the details + * Flags controlling the details * of output in Povray * format. Several flags are * implemented, see their * respective documentation. + * + * @ingroup IO */ struct PovrayFlags { @@ -631,9 +648,11 @@ class DataOutBase /** - * Flags describing the details of + * Flags controlling the details of * output in encapsulated postscript * format. + * + * @ingroup IO */ struct EpsFlags { @@ -959,9 +978,11 @@ class DataOutBase }; /** - * Flags describing the details of + * Flags controlling the details of * output in gmv format. At * present no flags are implemented. + * + * @ingroup IO */ struct GmvFlags { @@ -1015,9 +1036,10 @@ class DataOutBase }; /** - * Flags describing the details of - * output in Tecplot format. At - * present no flags are implemented. + * Flags controlling the details of + * output in Tecplot format. + * + * @ingroup IO */ struct TecplotFlags { @@ -1078,10 +1100,12 @@ class DataOutBase }; /** - * Flags describing the details + * Flags controlling the details * of output in VTK format. At * present no flags are * implemented. + * + * @ingroup IO */ struct VtkFlags { @@ -1137,11 +1161,13 @@ class DataOutBase /** - * Flags describing the details + * Flags controlling the details * of output in deal.II * intermediate format. At * present no flags are * implemented. + * + * @ingroup IO */ struct Deal_II_IntermediateFlags { @@ -1885,6 +1911,7 @@ class DataOutBase * suffix for the output file name can be obtained by default_suffix * without arguments. * + * @ingroup IO * @author Wolfgang Bangerth, 1999 */ template @@ -2316,6 +2343,7 @@ class DataOutInterface : private DataOutBase * function is explained in step-19. * * + * @ingroup IO * @author Wolfgang Bangerth, 2005 */ template diff --git a/deal.II/deal.II/include/grid/grid_in.h b/deal.II/deal.II/include/grid/grid_in.h index 55ed5dae00..87adb544a2 100644 --- a/deal.II/deal.II/include/grid/grid_in.h +++ b/deal.II/deal.II/include/grid/grid_in.h @@ -153,6 +153,8 @@ class SubCellData; * that class if you experience unexpected problems when reading grids * through this class. * + * @ingroup grid + * @ingroup IO * @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 b88de93fe4..e3052793b1 100644 --- a/deal.II/deal.II/include/grid/grid_out.h +++ b/deal.II/deal.II/include/grid/grid_out.h @@ -30,11 +30,15 @@ template class Mapping; * modify the default outfit of the grids written into a file. See the * different subclasses and the documentation of the GridOut * class for more details. + * + * @ingroup IO */ namespace GridOutFlags { /** * Flags for grid output in OpenDX format. + * + * @ingroup IO */ struct DX { @@ -77,6 +81,8 @@ namespace GridOutFlags /** * Flags describing the details of * output in UCD format. + * + * @ingroup IO */ struct Ucd { @@ -124,6 +130,8 @@ namespace GridOutFlags /** * Flags describing the details of * output in GNUPLOT format. + * + * @ingroup IO */ struct Gnuplot { @@ -175,6 +183,8 @@ namespace GridOutFlags * By default, the size of the picture * is scaled such that the width equals * 300 units. + * + * @ingroup IO */ struct EpsFlagsBase { @@ -271,7 +281,9 @@ namespace GridOutFlags * exist, we only here declare the * general template and declare * explicit specializations below. - */ + * + * @ingroup IO + */ template struct Eps {}; @@ -279,6 +291,8 @@ namespace GridOutFlags /** * Flags specific to the output of * grids in one space dimensions. + * + * @ingroup IO */ template <> struct Eps<1> : public EpsFlagsBase @@ -297,6 +311,8 @@ namespace GridOutFlags /** * Flags specific to the output of * grids in two space dimensions. + * + * @ingroup IO */ template <> struct Eps<2> : public EpsFlagsBase @@ -359,6 +375,8 @@ namespace GridOutFlags /** * Flags specific to the output of * grids in three space dimensions. + * + * @ingroup IO */ template <> struct Eps<3> : public EpsFlagsBase @@ -400,6 +418,8 @@ namespace GridOutFlags }; /** * Flags for XFig output. + * + * @ingroup IO */ struct XFig { @@ -496,7 +516,6 @@ namespace GridOutFlags * different formats. See the enum GridOut::OutputFormat for a list of formats * and the corresponding output function names. * - * @sect3{Usage} * Usage is simple: either you use the direct form * @verbatim * ofstream output_file("some_filename"); @@ -561,7 +580,8 @@ namespace GridOutFlags * dimensions supported by this class; they then have a template parameter, * as usual. * - * + * @ingroup grid + * @ingroup IO * @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/grid/grid_reordering.h b/deal.II/deal.II/include/grid/grid_reordering.h index 6ae4fea002..01c0ebc809 100644 --- a/deal.II/deal.II/include/grid/grid_reordering.h +++ b/deal.II/deal.II/include/grid/grid_reordering.h @@ -585,6 +585,7 @@ * the triangulation from this data using the * Triangulation::create_triangulation() function. * + * @ingroup grid * @author Wolfgang Bangerth, 2000, Michael Anderson 2003, Ralf Hartmann 2005 */ template diff --git a/deal.II/deal.II/include/grid/grid_tools.h b/deal.II/deal.II/include/grid/grid_tools.h index 102a2c91c2..2155e25ac0 100644 --- a/deal.II/deal.II/include/grid/grid_tools.h +++ b/deal.II/deal.II/include/grid/grid_tools.h @@ -28,6 +28,7 @@ * cell that contains a given point. See the descriptions of the * individual functions for more information. * + * @ingroup grid * @author Wolfgang Bangerth, 2001, 2003, 2004 */ class GridTools diff --git a/deal.II/deal.II/include/grid/persistent_tria.h b/deal.II/deal.II/include/grid/persistent_tria.h index 6eba8dc326..90bf4a8662 100644 --- a/deal.II/deal.II/include/grid/persistent_tria.h +++ b/deal.II/deal.II/include/grid/persistent_tria.h @@ -96,6 +96,7 @@ * later reconstruction and does also not touch the coarse grid which is * used within restore(). * + * @ingroup grid * @author Wolfgang Bangerth, 1999 */ template diff --git a/deal.II/deal.II/include/grid/tria.h b/deal.II/deal.II/include/grid/tria.h index b7bad5a075..3559aad265 100644 --- a/deal.II/deal.II/include/grid/tria.h +++ b/deal.II/deal.II/include/grid/tria.h @@ -39,6 +39,8 @@ template class MGDoFHandler; * Triangulation::create_triangulation function. It * contains all data needed to construct a cell, namely the indices * of the vertices and the material indicator. + * + * @ingroup grid */ template struct CellData @@ -118,6 +120,8 @@ struct CellData * (if in the interior). Explicitely giving a line the indicator 255 * will result in an error, as well as giving an interior line a boundary * indicator. + * + * @ingroup grid */ struct SubCellData { @@ -171,6 +175,7 @@ struct SubCellData * Note: these class should be made local to the triangulation class * once the compiler supports that (gcc2.95 does not at present). * + * @ingroup grid * @author Wolfgang Bangerth, 1999 */ template @@ -192,6 +197,7 @@ struct TriaNumberCache * Note: these class should be made local to the triangulation class * once the compiler supports that (gcc2.95 does not at present). * + * @ingroup grid * @author Wolfgang Bangerth, 1999 */ template <> @@ -252,6 +258,7 @@ struct TriaNumberCache<1> * Note: these class should be made local to the triangulation class * once the compiler supports that (gcc2.95 does not at present). * + * @ingroup grid * @author Wolfgang Bangerth, 1999 */ template <> @@ -313,6 +320,7 @@ struct TriaNumberCache<2> : public TriaNumberCache<1> * Note: these class should be made local to the triangulation class * once the compiler supports that (gcc2.95 does not at present). * + * @ingroup grid * @author Wolfgang Bangerth, 1999 */ template <> diff --git a/deal.II/deal.II/include/grid/tria_boundary.h b/deal.II/deal.II/include/grid/tria_boundary.h index 616ee960e1..5f499bbed9 100644 --- a/deal.II/deal.II/include/grid/tria_boundary.h +++ b/deal.II/deal.II/include/grid/tria_boundary.h @@ -71,6 +71,7 @@ template class Triangulation; * HyperBallBoundary creating a hyperball with given radius * around a given center point. * + * @ingroup grid * @author Wolfgang Bangerth, 1999, 2001, Ralf Hartmann, 2001 */ template diff --git a/deal.II/deal.II/include/grid/tria_hex.h b/deal.II/deal.II/include/grid/tria_hex.h index 553b21a396..291d561e79 100644 --- a/deal.II/deal.II/include/grid/tria_hex.h +++ b/deal.II/deal.II/include/grid/tria_hex.h @@ -32,6 +32,7 @@ * within a hexahedron, refer to the documentation of the * Triangulation class. * + * @ingroup grid * @author Wolfgang Bangerth, 1998 */ class Hexahedron diff --git a/deal.II/deal.II/include/grid/tria_iterator.h b/deal.II/deal.II/include/grid/tria_iterator.h index 931f65ddc6..9707388df1 100644 --- a/deal.II/deal.II/include/grid/tria_iterator.h +++ b/deal.II/deal.II/include/grid/tria_iterator.h @@ -219,6 +219,7 @@ template class Triangulation; * @ref TriaDimensionInfo<1> * @ref TriaDimensionInfo<2> * @ref TriaDimensionInfo<3> + * @ingroup grid * @ingroup Iterators * @author Wolfgang Bangerth, 1998 * @author documentation update Guido Kanschat, 2004 @@ -548,6 +549,7 @@ class TriaRawIterator : * This specialization of TriaRawIterator provides access only to * the used lines, quads, cells, etc. * + * @ingroup grid * @ingroup Iterators */ template @@ -698,6 +700,7 @@ class TriaIterator : public TriaRawIterator * cell which is not refined and thus a cell on which calculations * on the finest level are done. * + * @ingroup grid * @ingroup Iterators */ template diff --git a/deal.II/deal.II/include/grid/tria_iterator_base.h b/deal.II/deal.II/include/grid/tria_iterator_base.h index 1a1d784d97..82f815a14f 100644 --- a/deal.II/deal.II/include/grid/tria_iterator_base.h +++ b/deal.II/deal.II/include/grid/tria_iterator_base.h @@ -20,6 +20,8 @@ /** * Namespace in which an enumeration is declared that denotes the * states in which an iterator can be in. + * + * @ingroup Iterators */ namespace IteratorState { diff --git a/deal.II/deal.II/include/grid/tria_levels.h b/deal.II/deal.II/include/grid/tria_levels.h index 80c13b7775..9a62590bb0 100644 --- a/deal.II/deal.II/include/grid/tria_levels.h +++ b/deal.II/deal.II/include/grid/tria_levels.h @@ -26,6 +26,8 @@ * General template for information belonging to one level of a multilevel * hierarchy of a triangulation. This template is only declared to allow * specializations for different dimensions. + * + * @ingroup grid */ template class TriangulationLevel @@ -50,6 +52,7 @@ class TriangulationLevel * for the lines. Since we only store one byte per line, quad or hex, * this is a minor loss and we can live with that. * + * @ingroup grid * @author Wolfgang Bangerth, 1998 */ template <> @@ -201,6 +204,7 @@ class TriangulationLevel<0> * The TriangulationsLevel objects of higher dimensions are derived from * this one. * + * @ingroup grid * @author Wolfgang Bangerth, 1998 */ template <> @@ -357,6 +361,7 @@ class TriangulationLevel<1> : public TriangulationLevel<0> * The vector of lines and their children is derived from * TriangulationLevel<1>. * + * @ingroup grid * @author Wolfgang Bangerth, 1998 */ template <> @@ -479,6 +484,7 @@ class TriangulationLevel<2> : public TriangulationLevel<1> * The vectors of lines and quads and their children are derived from * TriangulationLevel<2>. * + * @ingroup grid * @author Wolfgang Bangerth, 1998, 2003 */ template <> diff --git a/deal.II/deal.II/include/grid/tria_line.h b/deal.II/deal.II/include/grid/tria_line.h index a5ec10ecdc..c5367b8999 100644 --- a/deal.II/deal.II/include/grid/tria_line.h +++ b/deal.II/deal.II/include/grid/tria_line.h @@ -27,6 +27,7 @@ * it belongs to. The level index is implicitly given by the position * in the lines.lines list attached to the information of each level. * + * @ingroup grid * @author Wolfgang Bangerth, 1998 */ class Line diff --git a/deal.II/deal.II/include/grid/tria_quad.h b/deal.II/deal.II/include/grid/tria_quad.h index b26ad6604e..1bf0c903f7 100644 --- a/deal.II/deal.II/include/grid/tria_quad.h +++ b/deal.II/deal.II/include/grid/tria_quad.h @@ -29,6 +29,7 @@ * in the quads.quads list attached to the information of each level * of the triangulation. * + * @ingroup grid * @author Wolfgang Bangerth, 1998 */ class Quad diff --git a/deal.II/deal.II/include/numerics/data_out.h b/deal.II/deal.II/include/numerics/data_out.h index 433d4f514b..6796ebaaff 100644 --- a/deal.II/deal.II/include/numerics/data_out.h +++ b/deal.II/deal.II/include/numerics/data_out.h @@ -36,7 +36,7 @@ template class FEValuesBase; * be written in any of the implemented data formats. * * - * @sect3{User visible interface} + *

User visible interface

* * The user visible interface of this class consists of functions which allow * a user to make a DoFHandler object known to this class and to add data @@ -154,6 +154,7 @@ template class FEValuesBase; * triangulation, so that the last template parameter has the same * value as the second one. * + * @ingroup IO * @author Wolfgang Bangerth, 1999 */ template @@ -757,7 +758,7 @@ class DataOut_DoFData : public DataOutInterface * the patches. * * - * @sect3{User interface information} + *

User interface information

* * The base classes of this class, DataOutBase, DataOutInterface and * DataOut_DoFData() offer several interfaces of their own. Refer to the @@ -770,7 +771,7 @@ class DataOut_DoFData : public DataOutInterface * output. * * - * @sect3{Extensions} + *

Extensions

* * By default, this class produces patches for all active cells. Sometimes, * this is not what you want, maybe because they are simply too many (and too @@ -798,6 +799,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 * @author Wolfgang Bangerth, 1999 */ template 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 d04e01c6c1..894088dc1a 100644 --- a/deal.II/deal.II/include/numerics/data_out_faces.h +++ b/deal.II/deal.II/include/numerics/data_out_faces.h @@ -34,7 +34,7 @@ template class DoFHandler; * be generated. These patches can then be written in several * graphical data formats by the functions of the underlying classes. * - * @sect3{Interface} + *

Interface

* * The interface of this class is copied from the DataOut * class. Furthermore, they share the common parent class @@ -42,7 +42,7 @@ template class DoFHandler; * discussion of the interface. * * - * @sect3{Extending this class} + *

Extending this class

* * The sequence of faces to generate patches from is generated in the * same way as in the DataOut class, see there for a description @@ -75,6 +75,7 @@ template class DoFHandler; * applications certainly exist, for which the author is not * imaginative enough. * + * @ingroup IO * @author Wolfgang Bangerth, 2000 */ template 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 7115947aa3..21eba0272c 100644 --- a/deal.II/deal.II/include/numerics/data_out_rotation.h +++ b/deal.II/deal.II/include/numerics/data_out_rotation.h @@ -42,7 +42,7 @@ template class DoFHandler; * produces very large output files. * * - * @sect3{Interface} + *

Interface

* * The interface of this class is copied from the DataOut * class. Furthermore, they share the common parent class @@ -51,7 +51,7 @@ template class DoFHandler; * further classes from this class. * * - * @sect3{Details for 1d computations} + *

Details for 1d computations

* * The one coordinate in the triangulation used by the * DoFHandler object passed to this class is taken as the radial @@ -60,7 +60,7 @@ template class DoFHandler; * radial coordinate only attains non-negative values. * * - * @sect3{Details for 2d computations} + *

Details for 2d computations

* * We consider the computation (represented by the DoFHandler * object that is attached to this class) to have happened in the @@ -77,6 +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 * @author Wolfgang Bangerth, 2000 */ template 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 5468376e73..3b364af796 100644 --- a/deal.II/deal.II/include/numerics/data_out_stack.h +++ b/deal.II/deal.II/include/numerics/data_out_stack.h @@ -52,7 +52,7 @@ template class DoFHandler; * interpolations in time may be added in the future. * * - * @sect2{Example of Use} + *

Example of Use

* * The following little example shall illustrate the different steps * of use of this class. It is assumed that the finite element used is @@ -98,6 +98,7 @@ template class DoFHandler; * }; * @endverbatim * + * @ingroup IO * @author Wolfgang Bangerth, 1999 */ template diff --git a/deal.II/deal.II/include/numerics/dof_print_solver_step.h b/deal.II/deal.II/include/numerics/dof_print_solver_step.h index 2a6756f7fc..89aeb71067 100644 --- a/deal.II/deal.II/include/numerics/dof_print_solver_step.h +++ b/deal.II/deal.II/include/numerics/dof_print_solver_step.h @@ -48,6 +48,7 @@ * written as a finite element field using the DataOut class. * Please note that this class may produce enormous amounts of data! * + * @ingroup IO * @author Guido Kanschat, 2000 */ template > diff --git a/deal.II/doc/doxygen/headers/base/dox.h b/deal.II/doc/doxygen/headers/base/dox.h index 110868397d..a2ec74c11f 100644 --- a/deal.II/doc/doxygen/headers/base/dox.h +++ b/deal.II/doc/doxygen/headers/base/dox.h @@ -33,3 +33,10 @@ * All other classes in this module actually implement quadrature * rules of different order and other characteristics. */ + +/** + * @defgroup IO Input/Output + * + * This module collects the classes used for reading and writing + * meshes and data. + */ -- 2.39.5