clipp::man_page Class Reference

stores strings for man page sections More...

#include <clipp.h>

Classes
class	section
	man page section More...

Public Types
using	string = doc_string
using	value_type = section
using	const_iterator = section_store::const_iterator
using	size_type = section_store::size_type

Public Member Functions
man_page &	append_section (string title, string content)
man_page &	prepend_section (string title, string content)
const section &	operator[] (size_type index) const noexcept
size_type	size () const noexcept
bool	empty () const noexcept
const_iterator	begin () const noexcept
const_iterator	end () const noexcept
man_page &	program_name (const string &n)
man_page &	program_name (string &&n)
const string &	program_name () const noexcept
man_page &	section_row_spacing (int rows)
int	section_row_spacing () const noexcept

Detailed Description

stores strings for man page sections

Definition at line 5982 of file clipp.h.

Member Typedef Documentation

const_iterator

using clipp::man_page::const_iterator = section_store::const_iterator

Definition at line 6012 of file clipp.h.

size_type

using clipp::man_page::size_type = section_store::size_type

Definition at line 6013 of file clipp.h.

string

using clipp::man_page::string = doc_string

Definition at line 5986 of file clipp.h.

value_type

using clipp::man_page::value_type = section

Definition at line 6011 of file clipp.h.

Member Function Documentation

append_section()

man_page& clipp::man_page::append_section ( string  title, string  content  )

inline

Definition at line 6018 of file clipp.h.

begin()

const_iterator clipp::man_page::begin ( ) const

inlinenoexcept

Definition at line 6045 of file clipp.h.

empty()

bool clipp::man_page::empty ( ) const

inlinenoexcept

Definition at line 6041 of file clipp.h.

end()

const_iterator clipp::man_page::end ( ) const

inlinenoexcept

Definition at line 6046 of file clipp.h.

operator[]()

const section& clipp::man_page::operator[] ( size_type  index ) const

inlinenoexcept

Definition at line 6034 of file clipp.h.

prepend_section()

man_page& clipp::man_page::prepend_section ( string  title, string  content  )

inline

Definition at line 6025 of file clipp.h.

program_name() [1/3]

const string& clipp::man_page::program_name ( ) const

inlinenoexcept

Definition at line 6058 of file clipp.h.

program_name() [2/3]

man_page& clipp::man_page::program_name ( const string &  n )

inline

Definition at line 6050 of file clipp.h.

program_name() [3/3]

man_page& clipp::man_page::program_name ( string &&  n )

inline

Definition at line 6054 of file clipp.h.

section_row_spacing() [1/2]

int clipp::man_page::section_row_spacing ( ) const

inlinenoexcept

Definition at line 6068 of file clipp.h.

section_row_spacing() [2/2]

man_page& clipp::man_page::section_row_spacing ( int  rows )

inline

Definition at line 6064 of file clipp.h.

size()

size_type clipp::man_page::size ( ) const

inlinenoexcept

Definition at line 6039 of file clipp.h.

---

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

• clipp.h