]> https://gitweb.dealii.org/ - dealii.git/commitdiff
Augment documentation. Move a bunch of classes into doxygen modules that better fit...
authorWolfgang Bangerth <bangerth@math.tamu.edu>
Fri, 13 Jan 2006 23:03:25 +0000 (23:03 +0000)
committerWolfgang Bangerth <bangerth@math.tamu.edu>
Fri, 13 Jan 2006 23:03:25 +0000 (23:03 +0000)
git-svn-id: https://svn.dealii.org/trunk@12012 0785d39b-7218-0410-832d-ea1e28bc413d

14 files changed:
deal.II/base/include/base/data_out_base.h
deal.II/base/include/base/quadrature.h
deal.II/deal.II/include/fe/fe_system.h
deal.II/deal.II/include/fe/fe_tools.h
deal.II/deal.II/include/fe/fe_update_flags.h
deal.II/deal.II/include/fe/mapping.h
deal.II/deal.II/include/grid/grid_in.h
deal.II/deal.II/include/grid/grid_out.h
deal.II/deal.II/include/numerics/data_out.h
deal.II/deal.II/include/numerics/data_out_faces.h
deal.II/deal.II/include/numerics/data_out_rotation.h
deal.II/deal.II/include/numerics/data_out_stack.h
deal.II/lac/include/lac/matrix_out.h
deal.II/lac/include/lac/sparse_direct.h

index c5b90ecdb7fbf619a5b7362e59c3f8de96d52b6d..290c95929550ce85397b01982134f7227b71b3dc 100644 (file)
@@ -185,7 +185,7 @@ class ParameterHandler;
  *
  * </ul>
  *
- * @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 <int dim, int spacedim=dim>
@@ -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 <a
- * href="www.povray.org">povray</a> raytracer.
+ * href="http://www.povray.org">povray</a> 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 <tt>default_suffix</tt>
  * without arguments.
  *
- * @ingroup IO
+ * @ingroup output
  * @author Wolfgang Bangerth, 1999
  */
 template <int dim, int spacedim=dim>
@@ -2422,7 +2425,7 @@ class DataOutInterface : private DataOutBase
  * function is explained in step-19.
  * 
  *
- * @ingroup IO
+ * @ingroup input output
  * @author Wolfgang Bangerth, 2005
  */
 template <int dim, int spacedim=dim>
index 7d4273ff3a8603788e2236cb9835e7104cb7be29..32e85823ff65df1b3f3218d5a15af65d6cfc47e4 100644 (file)
@@ -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<dim>
     QIterated (const Quadrature<1> &base_quadrature,
               const unsigned int   n_copies);
 
-                                    /** @addtogroup Exceptions
-                                     * @{ */
                                     /**
                                      * Exception
                                      */
index 2c1ee3525e51a5e301bca3f17ba3bbf76fb4efbe..dc1ebaec35031470014af4c0eb61e89f8bd7e330 100644 (file)
@@ -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 <utility>
 
 
-/*!@addtogroup febase */
+/*!@addtogroup febase fe */
 /*@{*/
 
 /**
index 4288c7b4057b9ba8464cb48e59c064383ad4f766..05d0e6d89c7999bd104f5fb8ddd205ee907962a1 100644 (file)
@@ -38,7 +38,7 @@ class ConstraintMatrix;
 #include <vector>
 #include <string>
 
-/*!@addtogroup febase */
+/*!@addtogroup feall */
 /*@{*/
 
 
index 96ec5659f7b494806d6c54111adc0293f6eb2c48..5bec6b407fe2a71b7a2969737e3e3d54e980f648 100644 (file)
@@ -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 <base/config.h>
 
 
-/*!@addtogroup febase */
+/*!@addtogroup feaccess */
 /*@{*/
 
 /**
index 83950c4ee68bc422b5a0a4908de5fa90b79da6d0..e4bfa3aaca1062381e0e822e28a755a8b76c6062 100644 (file)
@@ -30,8 +30,6 @@ template <int dim> 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 <int dim> 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 <int dim>
@@ -500,7 +499,6 @@ class Mapping : public Subscriptor
   friend class FESubfaceValues<dim>;
 };
 
-/*@}*/
 
 /* ------------------------- inline functions ------------------------- */
 
index d6f6b8a01fbf148097e8fef7fda2e4b0e5036c3e..b2cff3da8edc47b31a58cdb08fbb3f4e7bc1ced7 100644 (file)
@@ -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 <int dim>
index e3052793b14b12bbc4a3836ffabdc32c729f8c99..0d515a4429f3ed89df0d022bb18eefb0c4591925 100644 (file)
@@ -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 <int dim> 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 <int dim>
   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 
index 04f4cc82dac7caeb439c4b4e75f7931618a423fc..49d2bae3fbfaf229c52b7c5111cd88eb2a7ca18c 100644 (file)
@@ -159,7 +159,7 @@ template <int>      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 <int dof_handler_dim, template <int> class DH,
@@ -858,7 +858,7 @@ class DataOut_DoFData : public DataOutInterface<patch_dim,patch_space_dim>
  * 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 <int dim, template <int> class DH = DoFHandler>
index 6501a328899986056e5e99a83d9c0ace212e502d..959c713902bc6b8849a31ed8d736ab68ce6f8d54 100644 (file)
@@ -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 <int dim> class DoFHandler;
  * applications certainly exist, for which the author is not
  * imaginative enough.
  *
- * @ingroup IO
+ * @ingroup output
  * @author Wolfgang Bangerth, 2000
  */
 template <int dim, template <int> class DH = DoFHandler>
index 29cd1b1c4389ca8e2db6a1a96671fd463f150bc6..6a6ec57dfc4cf4bb19036d07629d48c2dcf8ac08 100644 (file)
@@ -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 <int dim> 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 <int dim, template <int> class DH = DoFHandler>
index e8096e2bffd63bfa86f960c7bff6e75bb49976bb..34d96075513597e9ccd4738aa2a0cf60c994a255 100644 (file)
@@ -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 <int dim> class DoFHandler;
  *     };
  * @endverbatim
  *
- * @ingroup IO
+ * @ingroup output
  * @author Wolfgang Bangerth, 1999
  */
 template <int dim, template <int> class DH = DoFHandler>
index 7e209cd22235dfb5457aa45502b24b0db435e17f..ef8af2dd69717bd18957bbe54dc9395bd1ae5af1 100644 (file)
@@ -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>
index a25959c3ae27322446a1969f49b42991faac891f..19a030352f715b49daa3599ec82ac50fe1d54902 100644 (file)
@@ -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
 
 
 
-/*! @addtogroup Preconditioners
- *@{
- */
-
 /**
  * This class provides an interface to the sparse direct solver MA27
  * from the Harwell Subroutine Library. MA27 is a direct solver
  * 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,
  * <a href="http://www.cise.ufl.edu/~davis/">Timothy A. Davis</a>.
  *
+ * 
+ * @ingroup Solvers Preconditioners
+ *
  * @author Wolfgang Bangerth, 2004
  */
 class SparseDirectUMFPACK : public Subscriptor
@@ -1214,8 +1217,6 @@ class SparseDirectUMFPACK : public Subscriptor
 };
 
 
-/*@}*/
-
 
 
 #endif

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.