[Debug Streams] Document the #includes for the standard debug stream objects.

[[Imported from SVN: r6252]]

dune/common/stdstreams.hh

@@ -85,6 +85,10 @@ namespace Dune {
   /*!
      \brief stream for very verbose output.
 
+     \code
+     #include <dune/common/stdstreams.hh>
+     \endcode
+
      Information on the lowest
      level. This is expected to report insane amounts of
      information. Use of the activation-flag to only generate output
@@ -104,7 +108,13 @@ namespace Dune {
    */
   typedef DebugStream<VERBOSE_DEBUG_LEVEL, MINIMAL_DEBUG_LEVEL> DVerbType;
 
-  /** @brief Singleton of verbose debug stream. */
+  /**
+   * @brief Singleton of verbose debug stream.
+   *
+   * \code
+   *#include <dune/common/stdstreams.hh>
+   * \endcode
+   */
   extern DVerbType dverb;
 
   /**
@@ -122,6 +132,10 @@ namespace Dune {
   /**
       @brief Stream for informative output.
 
+      \code
+     #include <dune/common/stdstreams.hh>
+      \endcode
+
       Summary infos on what a module
       does, runtimes, etc.
    */
@@ -139,7 +153,13 @@ namespace Dune {
    */
   typedef DebugStream<WARN_DEBUG_LEVEL, MINIMAL_DEBUG_LEVEL> DWarnType;
 
-  /** @brief Stream for warnings indicating problems. */
+  /**
+   * @brief Stream for warnings indicating problems.
+   *
+   * \code
+   *#include <dune/common/stdstreams.hh>
+   * \endcode
+   */
   extern DWarnType dwarn;
 
   /**
@@ -151,7 +171,13 @@ namespace Dune {
   /** @brief Type of debug stream for fatal errors.*/
   typedef DebugStream<GRAVE_DEBUG_LEVEL, MINIMAL_DEBUG_LEVEL> DGraveType;
 
-  /**  @brief Stream for warnings indicating fatal errors.*/
+  /**
+   * @brief Stream for warnings indicating fatal errors.
+   *
+   * \code
+   *#include <dune/common/stdstreams.hh>
+   * \endcode
+   */
   extern DGraveType dgrave;
 
   /** @brief The type of the stream used for error messages. */
@@ -160,6 +186,10 @@ namespace Dune {
   /*!
      @brief Stream for error messages.
 
+     \code
+     #include <dune/common/stdstreams.hh>
+     \endcode
+
      Only packages integrating Dune
      completely will redirect it. The output of derr is independent of
      the debug-level, only the activation-flag is checked.