From 71f658a5ec130f35022795ca1d4df423ee9b9aef Mon Sep 17 00:00:00 2001
From: kanschat <kanschat@0785d39b-7218-0410-832d-ea1e28bc413d>
Date: Thu, 29 Apr 2010 18:31:03 +0000
Subject: [PATCH] update documentation

git-svn-id: https://svn.dealii.org/trunk@21053 0785d39b-7218-0410-832d-ea1e28bc413d
---
 deal.II/deal.II/include/dofs/block_info.h     | 24 ++++++++++++++++++-
 deal.II/deal.II/include/dofs/dof_faces.h      |  6 +----
 deal.II/deal.II/include/dofs/dof_levels.h     |  6 +----
 .../multigrid/mg_dof_iterator_selector.h      |  3 ---
 4 files changed, 25 insertions(+), 14 deletions(-)

diff --git a/deal.II/deal.II/include/dofs/block_info.h b/deal.II/deal.II/include/dofs/block_info.h
index f802993cab..9b2f3cbb60 100644
--- a/deal.II/deal.II/include/dofs/block_info.h
+++ b/deal.II/deal.II/include/dofs/block_info.h
@@ -37,7 +37,7 @@ namespace hp
  * filled, which reflects the block structure of the degrees of
  * freedom.
  *
- * BlockInfo consists of deveral BlockIndices objects. The member
+ * BlockInfo consists of several BlockIndices objects. The member
  * global() reflects the block structure of the system on the active
  * cell level, usually referred to as the global system. As soon as
  * DoFHandler::distribute_dofs() has been called, the function
@@ -57,9 +57,31 @@ namespace hp
  * behavior of the MeshWorker::Assembler classes relying on
  * BlockInfo. They must be initialized by hand through initialize_local().
  *
+ * <h3>Usage</h3>
+ *
+ * The most common usage for this object is initializing vectors as in
+ * the following code:
+ *
+ * <code>
+ * MGDofHandler<dim> dof_handler(triangulation);
+ * dof_handler.distribute_dofs(fesystem);
+ * DoFRenumbering::block_wise(dof_handler);
+ *
+ * BlockVector<double> solution(dof_handler.block_info().global());
+ *
+ * MGLevelObject<BlockVector<double> > mg_vector(0, triangulation.n_levels()-1);
+ * for (unsigned int i=0;i<triangulation.n_levels();++i)
+ *   mg_vector[i].reinit(dof_handler.block_info().level(i));
+ *</code>
+ * In this example, <tt>solution</tt> obtains the block structure needed to
+ * represent a finite element function on the DoFHandler. Similarly,
+ * all levels of <tt>mg_vector</tt> will have the block structure
+ * needed on that level.
+ *
  * @todo Extend the functions local() and renumber() to the concept to
  * hpDoFHandler.
  *
+ * @ingroup dofs
  * @author Guido Kanschat, 2009
  */
 class BlockInfo : public Subscriptor
diff --git a/deal.II/deal.II/include/dofs/dof_faces.h b/deal.II/deal.II/include/dofs/dof_faces.h
index 3e4b4f1e88..ce1ca18ff1 100644
--- a/deal.II/deal.II/include/dofs/dof_faces.h
+++ b/deal.II/deal.II/include/dofs/dof_faces.h
@@ -2,7 +2,7 @@
 //    $Id$
 //    Version: $Name$
 //
-//    Copyright (C) 2006, 2007, 2008 by the deal.II authors
+//    Copyright (C) 2006, 2007, 2008, 2010 by the deal.II authors
 //
 //    This file is subject to QPL and may not be  distributed
 //    without copyright and license information. Please refer
@@ -57,7 +57,6 @@ namespace internal
  * setter functions. Knowledge of the actual data format is therefore encapsulated to the
  * present hierarchy of classes as well as the dealii::DoFHandler class.
  *
- * @ingroup dofs
  * @author Tobias Leicht, 2006
  */    
     template<int dim>
@@ -76,7 +75,6 @@ namespace internal
  * Store the indices of degrees of freedom on faces in 1D. As these would be vertices, which
  * are treted seperately, don't do anything.
  *
- * @ingroup dofs
  * @author Tobias Leicht, 2006
  */
     template<>
@@ -94,7 +92,6 @@ namespace internal
 /**
  * Store the indices of degrees of freedom on faces in 2D, which are lines.
  *
- * @ingroup dofs
  * @author Tobias Leicht, 2006
  */
     template<>
@@ -118,7 +115,6 @@ namespace internal
 /**
  * Store the indices of degrees of freedom on faces in 3D, which are quads, additionaly also on lines.
  *
- * @ingroup dofs
  * @author Tobias Leicht, 2006
  */
     template<>
diff --git a/deal.II/deal.II/include/dofs/dof_levels.h b/deal.II/deal.II/include/dofs/dof_levels.h
index 05716874af..331feb1ba0 100644
--- a/deal.II/deal.II/include/dofs/dof_levels.h
+++ b/deal.II/deal.II/include/dofs/dof_levels.h
@@ -2,7 +2,7 @@
 //    $Id$
 //    Version: $Name$
 //
-//    Copyright (C) 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2008 by the deal.II authors
+//    Copyright (C) 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2008, 2010 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,6 @@ namespace internal
  * encapsulated to the present hierarchy of classes as well as the
  * dealii::DoFHandler class.
  *
- * @ingroup dofs
  * @author Wolfgang Bangerth, 1998, 2006
  */
     template <int N>
@@ -124,7 +123,6 @@ namespace internal
  * Store the indices of the degrees of freedom which are located on
  * lines. See the general template DoFLevel for more information.
  *
- * @ingroup dofs
  * @author Wolfgang Bangerth, 1998, 2006
  */
     template <>
@@ -150,7 +148,6 @@ namespace internal
  * Store the indices of the degrees of freedom which are located on
  * quads. See the general template DoFLevel for more information.
  *
- * @ingroup dofs
  * @author Wolfgang Bangerth, 1998, 2006
  */
     template <>
@@ -176,7 +173,6 @@ namespace internal
  * Store the indices of the degrees of freedom which are located on
  * hexhedra. See the general template DoFLevel for more information.
  *
- * @ingroup dofs
  * @author Wolfgang Bangerth, 1998, 2006
  */
     template <>
diff --git a/deal.II/deal.II/include/multigrid/mg_dof_iterator_selector.h b/deal.II/deal.II/include/multigrid/mg_dof_iterator_selector.h
index e1e8c8d94b..2d4a599410 100644
--- a/deal.II/deal.II/include/multigrid/mg_dof_iterator_selector.h
+++ b/deal.II/deal.II/include/multigrid/mg_dof_iterator_selector.h
@@ -32,9 +32,6 @@ namespace internal
 {
   namespace MGDoFHandler
   {
-/*!@addtogroup mg */
-/*@{*/
-
     template <int dim, int spacedim>
     class Iterators;
 
-- 
2.39.5