Changeset 8848 for code/branches/output/src/libraries/util/output/ConsoleWriter.h

Timestamp:

Aug 21, 2011, 4:04:54 PM (13 years ago)

Author:

landauf

Message:

added documentation and some comments

File:

• code/branches/output/src/libraries/util/output/ConsoleWriter.h (modified) (3 diffs)

code/branches/output/src/libraries/util/output/ConsoleWriter.h

@@ -27 +27 @@
  */
 
+/**
+    @file
+    @ingroup Output
+    @brief Declaration of the ConsoleWriter singleton which is used to write output to the console.
+*/
+
 #ifndef _ConsoleWriter_H__
 #define _ConsoleWriter_H__
@@ -35 +41 @@
 namespace orxonox
 {
+    /**
+        @brief ConsoleWriter inherits from BaseWriter and writes output to the console.
+
+        This class can be seen as an equivalent to std::cout within the output
+        system. It is implemented as a singleton for static acces.
+    */
     class _UtilExport ConsoleWriter : public BaseWriter
     {
@@ -51 +63 @@
             virtual ~ConsoleWriter();
 
-            bool bEnabled_;
+            bool bEnabled_; ///< If false, the instance will not write output to the console.
     };
 }