paludis::args::DocWriter Class Reference

#include <man.hh>

Inheritance diagram for paludis::args::DocWriter:

Basic operations
virtual	~DocWriter ()=0

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

Detailed Description

Write docs from args classes in a particular format.

---

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

• /mnt/home/bo/scm/paludis/paludis/paludis/args/man.hh