paludis::args::AsciidocWriter Class Reference

#include <man.hh>

Inheritance diagram for paludis::args::AsciidocWriter:

Public Member Functions
void	heading (const std::string &name, const std::string &section, const std::string &synopis) override
void	start_usage_lines () override
void	usage_line (const std::string &name, const std::string &line) override
void	start_description (const std::string &description) override
void	extra_description (const std::string &description) override
void	end_description () override
void	start_options (const std::string &s) override
void	start_arg_group (const std::string &name, const std::string &description) override
void	arg_group_item (const char &short_name, const std::string &long_name, const std::string &negated_long_name, const std::string &description) override
void	start_extra_arg () override
void	extra_arg_enum (const AllowedEnumArg &, const std::string &default_arg) override
void	extra_arg_string_set (const std::string &first, const std::string &second) override
void	end_extra_arg () override
void	end_arg_group () override
void	end_options () override
void	start_environment () override
void	environment_line (const std::string &first, const std::string &second) override
void	end_environment () override
void	start_examples () override
void	example (const std::string &, const std::string &) override
void	end_examples () override
void	start_notes () override
void	note (const std::string &) override
void	end_notes () override
void	section (const std::string &title) override
void	subsection (const std::string &title) override
void	paragraph (const std::string &text) override
void	start_see_alsos () override
void	see_also (const std::string &, const int, const bool first) override
void	end_see_alsos () override

Basic operations
	AsciidocWriter (std::ostream &os)

Detailed Description

Create Asciidoc documentation from args classes.

Member Function Documentation

arg_group_item()

void paludis::args::AsciidocWriter::arg_group_item ( const char & short_name, const std::string & long_name, const std::string & negated_long_name, const std::string & description )

overridevirtual

Implements paludis::args::DocWriter.

end_arg_group()

void paludis::args::AsciidocWriter::end_arg_group ( )

overridevirtual

Implements paludis::args::DocWriter.

end_description()

void paludis::args::AsciidocWriter::end_description ( )

overridevirtual

Implements paludis::args::DocWriter.

end_environment()

void paludis::args::AsciidocWriter::end_environment ( )

overridevirtual

Implements paludis::args::DocWriter.

end_examples()

void paludis::args::AsciidocWriter::end_examples ( )

overridevirtual

Implements paludis::args::DocWriter.

end_extra_arg()

void paludis::args::AsciidocWriter::end_extra_arg ( )

overridevirtual

Implements paludis::args::DocWriter.

end_notes()

void paludis::args::AsciidocWriter::end_notes ( )

overridevirtual

Implements paludis::args::DocWriter.

end_options()

void paludis::args::AsciidocWriter::end_options ( )

overridevirtual

Implements paludis::args::DocWriter.

end_see_alsos()

void paludis::args::AsciidocWriter::end_see_alsos ( )

overridevirtual

Implements paludis::args::DocWriter.

environment_line()

void paludis::args::AsciidocWriter::environment_line ( const std::string & first, const std::string & second )

overridevirtual

Implements paludis::args::DocWriter.

example()

void paludis::args::AsciidocWriter::example ( const std::string & , const std::string &  )

overridevirtual

Implements paludis::args::DocWriter.

extra_arg_enum()

void paludis::args::AsciidocWriter::extra_arg_enum ( const AllowedEnumArg & , const std::string & default_arg )

overridevirtual

Implements paludis::args::DocWriter.

extra_arg_string_set()

void paludis::args::AsciidocWriter::extra_arg_string_set ( const std::string & first, const std::string & second )

overridevirtual

Implements paludis::args::DocWriter.

extra_description()

void paludis::args::AsciidocWriter::extra_description ( const std::string & description )

overridevirtual

Implements paludis::args::DocWriter.

heading()

void paludis::args::AsciidocWriter::heading ( const std::string & name, const std::string & section, const std::string & synopis )

overridevirtual

Implements paludis::args::DocWriter.

note()

void paludis::args::AsciidocWriter::note ( const std::string & )

overridevirtual

Implements paludis::args::DocWriter.

paragraph()

void paludis::args::AsciidocWriter::paragraph ( const std::string & text )

overridevirtual

Implements paludis::args::DocWriter.

section()

void paludis::args::AsciidocWriter::section ( const std::string & title )

overridevirtual

Implements paludis::args::DocWriter.

see_also()

void paludis::args::AsciidocWriter::see_also ( const std::string & , const int , const bool first )

overridevirtual

Implements paludis::args::DocWriter.

start_arg_group()

void paludis::args::AsciidocWriter::start_arg_group ( const std::string & name, const std::string & description )

overridevirtual

Implements paludis::args::DocWriter.

start_description()

void paludis::args::AsciidocWriter::start_description ( const std::string & description )

overridevirtual

Implements paludis::args::DocWriter.

start_environment()

void paludis::args::AsciidocWriter::start_environment ( )

overridevirtual

Implements paludis::args::DocWriter.

start_examples()

void paludis::args::AsciidocWriter::start_examples ( )

overridevirtual

Implements paludis::args::DocWriter.

start_extra_arg()

void paludis::args::AsciidocWriter::start_extra_arg ( )

overridevirtual

Implements paludis::args::DocWriter.

start_notes()

void paludis::args::AsciidocWriter::start_notes ( )

overridevirtual

Implements paludis::args::DocWriter.

start_options()

void paludis::args::AsciidocWriter::start_options ( const std::string & s )

overridevirtual

Implements paludis::args::DocWriter.

start_see_alsos()

void paludis::args::AsciidocWriter::start_see_alsos ( )

overridevirtual

Implements paludis::args::DocWriter.

start_usage_lines()

void paludis::args::AsciidocWriter::start_usage_lines ( )

overridevirtual

Implements paludis::args::DocWriter.

subsection()

void paludis::args::AsciidocWriter::subsection ( const std::string & title )

overridevirtual

Implements paludis::args::DocWriter.

usage_line()

void paludis::args::AsciidocWriter::usage_line ( const std::string & name, const std::string & line )

overridevirtual

Implements paludis::args::DocWriter.

---

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

• /var/tmp/paludis/build/sys-apps-paludis-scm-r1/work/paludis-scm/paludis/args/man.hh