Documentation for OpenFLUID 2.2.0
openfluid::waresdev::WareSrcDocalyzer Class Reference

Detailed Description

Class to check wares source code

#include <waresdev/WareSrcDocalyzer.hpp>

Public Member Functions

 CPPCLASS_DELETE_FIVE (WareSrcDocalyzer)
 
 WareSrcDocalyzer (const std::string &SrcPath, const std::string &OutputPath, WareSrcDocalyzerListener *Listener, std::vector< std::string > InputFormats)
 
void performDocalyze (bool KeepWorkData=false, bool IncludeEmptyFields=false)
 

Constructor & Destructor Documentation

◆ WareSrcDocalyzer()

openfluid::waresdev::WareSrcDocalyzer::WareSrcDocalyzer ( const std::string &  SrcPath,
const std::string &  OutputPath,
WareSrcDocalyzerListener Listener,
std::vector< std::string >  InputFormats 
)

Constructs a docalyzer

Parameters
[in]SrcPathThe path to the sources to docalyze
[in]OutputPathThe path where to put the built documentation
ListenerThe Listener for Docalyzer actions
[in]InputFormatsThe doc format searched by the docalyzer (searches for all possible formats if empty)

Member Function Documentation

◆ CPPCLASS_DELETE_FIVE()

openfluid::waresdev::WareSrcDocalyzer::CPPCLASS_DELETE_FIVE ( WareSrcDocalyzer  )

◆ performDocalyze()

void openfluid::waresdev::WareSrcDocalyzer::performDocalyze ( bool  KeepWorkData = false,
bool  IncludeEmptyFields = false 
)

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