various small doxygen improvements

[[Imported from SVN: r6406]]

dune/common/lcm.hh

@@ -3,6 +3,10 @@
 #ifndef DUNE_LCM_HH
 #define DUNE_LCM_HH
 
+/** \file
+ * \brief Statically compute the least common multiple of two integers
+ */
+
 #include <dune/common/static_assert.hh>
 #include <dune/common/gcd.hh>
 

dune/common/mpihelper.hh

@@ -17,7 +17,8 @@ namespace Dune
 {
   /**
    * @file
-   * @brief This file contains helpers for dealing with MPI.
+   * @brief Helpers for dealing with MPI.
+   *
    * @ingroup ParallelCommunication
    *
    * Basically there are two helpers available:

dune/common/nullptr.hh

@@ -3,6 +3,10 @@
 #ifndef DUNE_NULLPTR_HH
 #define DUNE_NULLPTR_HH
 
+/** \file
+ * \brief Fallback implementation of the nullptr object in C++0x
+ */
+
 #if ! HAVE_NULLPTR
 
 /**

dune/common/version.hh

@@ -3,29 +3,43 @@
 #ifndef DUNE_VERSION_HH
 #define DUNE_VERSION_HH
 
+/** \file
+ * \brief Various macros to work with %Dune module version numbers
+ */
+
+/** \brief Constructs the preprocessor name used in config.h to hold version numbers
+ * \param module The name of the Dune module
+ * \param type The version number type, one of MAJOR, MINOR, or REVISION
+ */
 #define DUNE_VERSION_JOIN(module,type) module ## _VERSION_ ## type
 
+/** \brief True if 'module' has the version major.minor */
 #define DUNE_VERSION_EQUAL(module,major,minor) \
   ((DUNE_VERSION_JOIN(module,MAJOR) == major) && \
    (DUNE_VERSION_JOIN(module,MINOR) == minor))
 
+/** \brief True if 'module' has the version major.minor.revision */
 #define DUNE_VERSION_EQUAL_REV(module,major,minor,revision) \
   ( DUNE_VERSION_EQUAL(module,major,minor) && \
     (DUNE_VERSION_JOIN(module,REVISION) == revision))
 
+/** \brief True if 'module' has the version major.minor or newer */
 #define DUNE_VERSION_NEWER(module,major,minor,revision) \
   ((DUNE_VERSION_JOIN(module,MAJOR) > major) \
    || ((DUNE_VERSION_JOIN(module,MAJOR) == major) && (DUNE_VERSION_JOIN(module,MINOR) >= minor)))
 
+/** \brief True if 'module' has the version major.minor.revision or newer */
 #define DUNE_VERSION_NEWER_REV(module,major,minor,revision) \
   ((DUNE_VERSION_JOIN(module,MAJOR) > major) \
    || ((DUNE_VERSION_JOIN(module,MAJOR) == major) && (DUNE_VERSION_JOIN(module,MINOR) > minor)) \
    || ((DUNE_VERSION_JOIN(module,MAJOR) == major) && (DUNE_VERSION_JOIN(module,MINOR) == minor) \
        && (DUNE_VERSION_JOIN(module,REVISION) >= revision)))
 
+/** \brief Compute a unique uint id from the major, minor, and revision numbers */
 #define DUNE_VERSION_ID(major,minor,revision) \
   ((unsigned int)((major << 24) + (minor << 16) + revision))
 
+/** \brief Compute a unique uint id for the given module */
 #define DUNE_MODULE_VERSION_ID(module) \
   DUNE_VERSION_ID( DUNE_VERSION_JOIN(module,MAJOR), DUNE_VERSION_JOIN(module,MINOR), DUNE_VERSION_JOIN(module,REVISION) )