Chunk Class Reference

#include <Chunk.hpp>

Public Member Functions
	Chunk ()
void	readFromConsole ()
void	streamline ()
void	writeToConsole ()

Private Attributes
vector< string >	_chunk

Detailed Description

This class streamlines doxygen documentation blocks in a chunk of source code. The read/write methods are separated from the actual streamlining because future versions of this class may be extended with other input/output mechanisms in addition to stdin/stdout.

Constructor & Destructor Documentation

Chunk()

Chunk::Chunk

(

)

Constructs a streamliner with an empty source code chunk.

Member Function Documentation

readFromConsole()

void Chunk::readFromConsole

(

)

Reads lines from stdin until EOF is reached, adding them to the current source code chunk.

streamline()

void Chunk::streamline

(

)

Streamlines the current source code chunk, adjusting its contents as needed.

writeToConsole()

void Chunk::writeToConsole

(

)

Writes the current source code chunk to stdout.

Member Data Documentation

_chunk

vector<string> Chunk::_chunk

private

The current source code chunk.

---

The documentation for this class was generated from the following file:

• Chunk.hpp