The SKIRT project
advanced radiative transfer for astrophysics
Public Member Functions | Private Attributes | List of all members
Block Class Reference

#include <Block.hpp>

Public Member Functions

 Block (const vector< string > &block)
 
 Block (const vector< string > &chunk, size_t first, size_t last)
 
vector< string > streamlined ()
 

Private Attributes

vector< string > _block
 

Detailed Description

This class streamlines a single doxygen documentation block.

Constructor & Destructor Documentation

◆ Block() [1/2]

Block::Block ( const vector< string > &  block)

Constructs a streamliner for the specified documentation block.

◆ Block() [2/2]

Block::Block ( const vector< string > &  chunk,
size_t  first,
size_t  last 
)

Constructs a streamliner for the documentation block specified as a portion of a larger source code chunk.

Member Function Documentation

◆ streamlined()

vector< string > Block::streamlined ( )

Returns the streamlined documentation block.

Member Data Documentation

◆ _block

vector<string> Block::_block
private

The documentation block.


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