Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

Ignore:
Timestamp:
Sep 16, 2008, 3:46:25 AM (17 years ago)
Author:
landauf
Message:

added comments to all my classes in util

File:
1 edited

Legend:

Unmodified
Added
Removed

  • code/trunk/src/util/OutputBuffer.cc

    r1784 r1791  
    2727 */
    2828
     29/**
     30    @file OutputBuffer.cc
     31    @brief Implementation of the OutputBuffer.
     32*/
     33
    2934#include "OutputBuffer.h"
    30 
    3135
    3236namespace orxonox
    3337{
    34     const int OUTPUTBUFFER_MAX_LINE_LENGTH = 16384;
     38    const int OUTPUTBUFFER_MAX_LINE_LENGTH = 16384; //! The maximal number of lines that can be stored within the OutputBuffer.
    3539
     40    /**
     41        @brief Adds a new listener to the list.
     42        @param listener The new listener
     43    */
    3644    void OutputBuffer::registerListener(OutputBufferListener* listener)
    3745    {
    … …  
    3947    }
    4048
     49    /**
     50        @brief Removes a listener from the list.
     51        @param listener The listener
     52    */
    4153    void OutputBuffer::unregisterListener(OutputBufferListener* listener)
    4254    {
    … …  
    5062    }
    5163
     64    /**
     65        @brief Puts a stream manipulator to the stream.
     66        @param manipulator The manipulator
     67    */
    5268    OutputBuffer& OutputBuffer::operator<<(std::ostream& (*manipulator)(std::ostream&))
    5369    {
    … …  
    5773    }
    5874
     75    /**
     76        @brief Puts a stream manipulator to the stream.
     77        @param manipulator The manipulator
     78    */
    5979    OutputBuffer& OutputBuffer::operator<<(std::ios& (*manipulator)(std::ios&))
    6080    {
    … …  
    6484    }
    6585
     86    /**
     87        @brief Puts a stream manipulator to the stream.
     88        @param manipulator The manipulator
     89    */
    6690    OutputBuffer& OutputBuffer::operator<<(std::ios_base& (*manipulator)(std::ios_base&))
    6791    {
    … …  
    7195    }
    7296
     97    /**
     98        @brief Removes the first line from the stream and assigns it to a given string object.
     99        @param output The string object to assign the first line
     100        @return True if there was at least one line in the stream and this line was successfully assigned
     101
     102        It's important to know the returned line will be removed from the stream. If there are more than one
     103        listener, they have to cooperate to avoid conflicts.
     104    */
    73105    bool OutputBuffer::getLine(std::string* output)
    74106    {
    … …  
    90122    }
    91123
     124    /**
     125        @brief Calls the outputChanged() function of all registered listeners.
     126    */
    92127    void OutputBuffer::callListeners()
    93128    {
Note: See TracChangeset for help on using the changeset viewer.