Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

Ignore:
Timestamp:
Aug 21, 2011, 4:04:54 PM (13 years ago)
Author:
landauf
Message:

added documentation and some comments

File:
1 edited

Legend:

Unmodified
Added
Removed
  • code/branches/output/src/libraries/util/output/ConsoleWriter.cc

    r8799 r8848  
    2727 */
    2828
     29/**
     30    @file
     31    @brief Implementation of the ConsoleWriter singleton.
     32*/
     33
    2934#include "ConsoleWriter.h"
    3035
     
    3540namespace orxonox
    3641{
     42    /**
     43        @brief Constructor, initializes the output level.
     44
     45        In debug builds, it writes output up to level::internal_warning to the
     46        console, in release builds only up to level::user_info.
     47
     48        After creation, the instance is enabled.
     49    */
    3750    ConsoleWriter::ConsoleWriter() : BaseWriter("Console")
    3851    {
     
    4558    }
    4659
     60    /**
     61        @brief Destructor.
     62    */
    4763    ConsoleWriter::~ConsoleWriter()
    4864    {
    4965    }
    5066
     67    /**
     68        @brief Returns the only existing instance of this class.
     69    */
    5170    /*static*/ ConsoleWriter& ConsoleWriter::getInstance()
    5271    {
     
    5574    }
    5675
     76    /**
     77        @brief Inherited function from BaseWriter, writes output to the console using std::cout.
     78    */
    5779    void ConsoleWriter::printLine(const std::string& line, OutputLevel)
    5880    {
     
    6082    }
    6183
     84    /**
     85        @brief Enables the instance by registering itself as listener at OutputManager.
     86    */
    6287    void ConsoleWriter::enable()
    6388    {
     
    6994    }
    7095
     96    /**
     97        @brief Disables the instance by unregistering itself from OutputManager.
     98    */
    7199    void ConsoleWriter::disable()
    72100    {
Note: See TracChangeset for help on using the changeset viewer.