clipp::documentation Class Reference

generates parameter and group documentation from docstrings More...

#include <clipp.h>

Public Types
using	string = doc_string

Public Member Functions
	documentation (const group &cli, const doc_formatting &fmt=doc_formatting{}, const param_filter &filter=param_filter{})
	documentation (const group &params, const param_filter &filter, const doc_formatting &fmt=doc_formatting{})
string	str () const

Friends
template<class OStream >
OStream &	operator<< (OStream &os, const documentation &p)

Detailed Description

generates parameter and group documentation from docstrings

lazily evaluated

Definition at line 5780 of file clipp.h.

Member Typedef Documentation

string

using clipp::documentation::string = doc_string

Definition at line 5783 of file clipp.h.

Constructor & Destructor Documentation

documentation() [1/2]

clipp::documentation::documentation ( const group &  cli, const doc_formatting &  fmt = doc_formatting{}, const param_filter &  filter = param_filter{}  )

inline

Definition at line 5785 of file clipp.h.

documentation() [2/2]

clipp::documentation::documentation ( const group &  params, const param_filter &  filter, const doc_formatting &  fmt = doc_formatting{}  )

inline

Definition at line 5797 of file clipp.h.

Member Function Documentation

str()

string clipp::documentation::str ( ) const

inline

Definition at line 5811 of file clipp.h.

Friends And Related Function Documentation

operator<<

template<class OStream >

OStream& operator<< ( OStream &  os, const documentation &  p  )

friend

Definition at line 5805 of file clipp.h.

---

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

• clipp.h