clipp::usage_lines Class Reference

generates usage lines More...

#include <clipp.h>

Public Types
using	string = doc_string

Public Member Functions
	usage_lines (const group &params, string prefix="", const doc_formatting &fmt=doc_formatting{})
	usage_lines (const group &params, const doc_formatting &fmt)
usage_lines &	ommit_outermost_group_surrounders (bool yes)
bool	ommit_outermost_group_surrounders () const
string	str () const

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

Detailed Description

generates usage lines

lazily evaluated

Definition at line 5315 of file clipp.h.

Member Typedef Documentation

string

using clipp::usage_lines::string = doc_string

Definition at line 5318 of file clipp.h.

Constructor & Destructor Documentation

usage_lines() [1/2]

clipp::usage_lines::usage_lines ( const group &  params, string  prefix = "", const doc_formatting &  fmt = doc_formatting{}  )

inline

Definition at line 5320 of file clipp.h.

usage_lines() [2/2]

clipp::usage_lines::usage_lines ( const group &  params, const doc_formatting &  fmt  )

inline

Definition at line 5329 of file clipp.h.

Member Function Documentation

ommit_outermost_group_surrounders() [1/2]

bool clipp::usage_lines::ommit_outermost_group_surrounders ( ) const

inline

Definition at line 5337 of file clipp.h.

ommit_outermost_group_surrounders() [2/2]

usage_lines& clipp::usage_lines::ommit_outermost_group_surrounders ( bool  yes )

inline

Definition at line 5333 of file clipp.h.

str()

string clipp::usage_lines::str ( ) const

inline

Definition at line 5347 of file clipp.h.

Friends And Related Function Documentation

operator<<

template<class OStream >

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

friend

Definition at line 5342 of file clipp.h.

---

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

• clipp.h