Added some comments for doxygen

[[Imported from SVN: r1398]]

common/dynamictype.hh

@@ -9,11 +9,11 @@ namespace Dune {
 
   typedef int IdentifierType;
 
-  //! ???
+  //! Base class used for tagging derived classes with an identifier
   class DynamicType {
   public:
 
-    //! ???
+    //! Definition for undefined value
     static const IdentifierType undefined = 0;
 
     //! set identifier of this class

common/function.hh

@@ -41,11 +41,11 @@ namespace Dune {
     //! ???
     typedef FunctionSpaceType FunctionSpace;
 
-    //! ???
-    Function (const FunctionSpaceType & f ) : functionSpace_ (f) {} ;
+    //! Constructor
+    Function (const FunctionSpaceType & f) : functionSpace_ (f) {} ;
 
     //! evaluate Function
-    void eval ( const Domain & , Range &) const ;
+    void eval (const Domain & , Range &) const ;
 
     //! evaluate function and derivatives
     template <int derivation>
@@ -54,12 +54,12 @@ namespace Dune {
     void evaluate  ( const FieldVector<deriType, derivation> &diffVariable,
                      const Domain & , Range &) const {};
 
-    //! ???
-    const FunctionSpaceType &getFunctionSpace() const { return functionSpace_; }
+    //! Get access to the related function space
+    const FunctionSpaceType& getFunctionSpace() const { return functionSpace_; }
 
   protected:
 
-    //! ???
+    //! The related function space
     const FunctionSpaceType & functionSpace_;
 
   };

common/functionspace.hh

@@ -22,9 +22,9 @@ namespace Dune {
   class FunctionSpace : public DynamicType {
   public:
 
-    /** \todo Please doc me! */
+    /** Intrinsic type used for values in the domain field (usually a double) */
     typedef DomainFieldType DomainField;
-    /** \todo Please doc me! */
+    /** Intrinsic type used for values in the range field (usually a double) */
     typedef RangeFieldType RangeField;
 
     /** \todo Please doc me! */
@@ -32,15 +32,15 @@ namespace Dune {
     /** \todo Please doc me! */
     typedef FieldVector<Mat< n, n, RangeField>, m> HessianRange ;
 
-    /** \todo Please doc me! */
+    /** Type of domain vector (using type of domain field) */
     typedef FieldVector<DomainField, n> Domain;
-    /** \todo Please doc me! */
+    /** Type of range vector (using type of range field) */
     typedef FieldVector<RangeField, m> Range;
 
-    /** \todo Please doc me! */
+    /** Remember the dimensions of the domain and range field */
     enum { DimDomain = n, DimRange = m};
 
-    /** \todo Please doc me! */
+    /** Constructor taking an identifier */
     FunctionSpace ( int ident ) : DynamicType (ident){} ;
 
   };

common/mapping.hh

@@ -17,8 +17,10 @@ namespace Dune {
      @{
    */
 
-  /** \brief A mapping
-      \todo Please doc me!
+  /** \brief A mapping from one vector space into another
+      This class describes a general mapping from the domain vector space into
+      the range vector space.
+      It can also be used to construct linear combinations of mappings.
 
       Note: Range has to have Vector structure as well.
    */
@@ -26,11 +28,15 @@ namespace Dune {
   class Mapping : public Vector < RFieldType >
   {
   public:
-    //! remember template parameters for derived classes
+    //! domain vector space (for usage in derived classes)
     typedef DType DomainType;
+    //! range vector space
     typedef RType RangeType;
+    //! integral type used in the construction of the domain vector space
     typedef DFieldType DomainFieldType;
+    //! integral type used in the construction of the range vector space
     typedef RFieldType RangeFieldType;
+    //! \todo why that one?
     typedef RangeFieldType Field;
 
     //! remember what type this class has

common/stdstreams.hh

@@ -36,7 +36,7 @@ namespace Dune {
 
      Keep in mind that libdune has to be recompiled if this value is changed!
    */
-  static const DebugLevel MINIMAL_DEBUG_LEVEL = 4;
+  static const DebugLevel MINIMAL_DEBUG_LEVEL = 3;
 
   typedef DebugStream<1, MINIMAL_DEBUG_LEVEL> DVVerbType;
   extern DVVerbType dvverb;