paludis::args::ManWriter Class Reference
#include <man.hh>
List of all members.
|
Basic operations |
|
| ManWriter (std::ostream &os) |
|
| ~ManWriter () |
Public Member Functions |
|
void | heading (const std::string &name, const std::string §ion, const std::string &synopis) |
|
void | usage_line (const std::string &name, const std::string &line) |
|
void | start_description (const std::string &description) |
|
void | start_arg_group (const std::string &name, const std::string &description) |
|
void | arg_group_item (const char &short_name, const std::string &long_name, const std::string &negated_long_name, const std::string &description) |
|
void | start_extra_arg () |
|
void | extra_arg_enum (const std::string &first, const std::string &second, const std::string &default_arg) |
|
void | extra_arg_string_set (const std::string &first, const std::string &second) |
|
void | end_extra_arg () |
|
void | end_arg_group () |
|
void | end_description () |
|
void | start_environment () |
|
void | environment_line (const std::string &first, const std::string &second) |
|
void | end_environment () |
|
void | start_examples () |
|
void | example (const std::string &, const std::string &) |
|
void | end_examples () |
|
void | start_notes () |
|
void | note (const std::string &) |
|
void | end_notes () |
|
void | section (const std::string &title) |
|
void | subsection (const std::string &title) |
|
void | paragraph (const std::string &text) |
Detailed Description
Create man documentation from
args classes.
The documentation for this class was generated from the following file:
- /home/users/stephen/scm/paludis/paludis/args/man.hh