format_help.hpp File Reference

Provides the format_help struct that print the help page to the command line and the two child formats (format_version, format_short_help) that print short help messages to the command line. More...

#include <cassert>
#include <iostream>
#include <seqan3/argument_parser/detail/format_base.hpp>
#include <seqan3/argument_parser/detail/terminal.hpp>
#include <seqan3/core/detail/test_accessor.hpp>

Include dependency graph for format_help.hpp:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	seqan3::detail::format_help::console_layout_struct
	Stores the relevant parameters of the documentation on the screen. More...
class	seqan3::detail::format_copyright
	The format that prints the copyright information to std::cout. More...
class	seqan3::detail::format_help
	The format that prints the help page to std::cout. More...
class	seqan3::detail::format_short_help
	The format that prints a short help message to std::cout. More...
class	seqan3::detail::format_version
	The format that prints the version to std::cout. More...

Namespaces
namespace	seqan3
	The main SeqAn3 namespace.
namespace	seqan3::detail
	The internal SeqAn3 namespace.

Detailed Description

Provides the format_help struct that print the help page to the command line and the two child formats (format_version, format_short_help) that print short help messages to the command line.

Author

Svenja Mehringer <svenja.mehringer AT fu-berlin.de>