Improve documentation

dune/solvers/transferoperators/mandelobsrestrictor.cc

@@ -22,10 +22,6 @@ restrict(const std::vector<BoxConstraint<field_type, blocksize> >&f,
     for (size_t i=0; i<t.size(); i++)
         t[i].clear();
 
-    // The Mandel restriction computes the maximum $m$ of all nodal base coefficients
-    // in the support of a given coarse grid base function \f$ \phi_c \f$.  If the
-    // coefficient of \f$ \phi_c \f$ is smaller than \f$ m \f$ , it is set to \f$ m \f$.
-
     // We use the multigrid transfer matrix to find all relevant fine grid dofs
     typedef typename Dune::BCRSMatrix<Dune::FieldMatrix<field_type,1,1> >::row_type RowType;
     typedef typename RowType::ConstIterator ColumnIterator;

dune/solvers/transferoperators/mandelobsrestrictor.hh

@@ -8,6 +8,14 @@
 #include <dune/solvers/transferoperators/multigridtransfer.hh>
 #include <dune/solvers/common/boxconstraint.hh>
 
+/** \brief Mandel restriction to compute coarse grid obstacles, needed within montone multigrid methods.
+ *
+ * The Mandel restriction computes the maximum $m$ of all nodal base coefficients
+ * in the support of a given coarse grid base function \f$ \phi_c \f$.  If the
+ * coefficient of \f$ \phi_c \f$ is smaller than \f$ m \f$ , it is set to \f$ m \f$.
+ *
+ * \tparam VectorType The block vector type of the algebraic problem.
+ */
 template <class VectorType>
 class MandelObstacleRestrictor : public ObstacleRestrictor<VectorType>
 {
@@ -17,6 +25,7 @@ class MandelObstacleRestrictor : public ObstacleRestrictor<VectorType>
 
 public:
     
+    //! Compute coarse grid obstacles using the mandel restriction
     virtual void restrict(const std::vector<BoxConstraint<field_type,blocksize> >& f,
                           std::vector<BoxConstraint<field_type,blocksize> >& t,
                           const Dune::BitSetVector<blocksize>& fHasObstacle,