Description
Renders markup as plain text.
This isn't fancy–it's got just enough smarts so a user can read the documentation when a more capable formatter like perldoc is not available.
Definition at line 21 of file DocumentTextMarkup.h.
#include <Sawyer/DocumentTextMarkup.h>
Inheritance diagram for Sawyer::Document::TextMarkup:
Collaboration diagram for Sawyer::Document::TextMarkup:
Public Member Functions | |
| virtual bool | emit (const std::string &doc) |
| Emit documentation to output. | |
| bool | doingPageHeader () const |
| Property: Whether to create a page header. | |
| TextMarkup & | doingPageHeader (bool b) |
| Property: Whether to create a page header. | |
| bool | doingPageFooter () const |
| Property: Whether to create a page footer. | |
| TextMarkup & | doingPageFooter (bool b) |
| Property: Whether to create a page footer. | |
 Public Member Functions inherited from Sawyer::Document::BaseMarkup | |
| BaseMarkup & | title (const std::string &pageName, const std::string &chapterNumber, const std::string &chapterTitle) |
| Set title properties. | |
| BaseMarkup & | version (const std::string &versionString, const std::string &versionDate) |
| Set version properties. | |
| virtual std::string | operator() (const std::string &) override |
| Parse input to generate POD. | |
| const std::string & | pageName () const |
| Property: Page name. | |
| BaseMarkup & | pageName (const std::string &s) |
| Property: Page name. | |
| const std::string & | chapterNumber () const |
| Property: Chapter number. | |
| BaseMarkup & | chapterNumber (const std::string &s) |
| Property: Chapter number. | |
| const std::string & | chapterNumberOrDefault () const |
| Property: Chapter number. | |
| const std::string & | chapterTitle () const |
| Property: Chapter title. | |
| BaseMarkup & | chapterTitle (const std::string &s) |
| Property: Chapter title. | |
| const std::string & | chapterTitleOrDefault () const |
| Property: Chapter title. | |
| const std::string & | versionString () const |
| Property: Version string. | |
| BaseMarkup & | versionString (const std::string &s) |
| Property: Version string. | |
| const std::string & | versionStringOrDefault () const |
| Property: Version string. | |
| const std::string & | versionDate () const |
| Property: Version date. | |
| BaseMarkup & | versionDate (const std::string &s) |
| Property: Version date. | |
| const std::string & | versionDateOrDefault () const |
| Property: Version date. | |
| Public Member Functions inherited from Sawyer::Document::Markup::Grammar | |
| Grammar & | with (const Function::Ptr &) |
| Insert function. | |
Additional Inherited Members | |
| Static Public Member Functions inherited from Sawyer::Document::BaseMarkup | |
| static bool | hasNonSpace (const std::string &) |
| True if this string contains any non-blank characters. | |
| static std::string | makeOneLine (const std::string &) |
| Remove linefeeds. | |
| static std::string | leftJustify (const std::string &, size_t width) |
| Left justify a string in a field of width N (or more). | |
| static std::string | escapeSingleQuoted (const std::string &) |
| Escape single quoted string content. | |
| Static Public Member Functions inherited from Sawyer::Document::Markup::Grammar | |
| static std::string | unescape (const std::string &s) |
| Expand escape sequences "@@", "@{" and "@}". | |
| static std::string | escape (const std::string &s) |
| Escape all special "@", "{", and "}". | |
Constructor & Destructor Documentation
◆ TextMarkup()
|
inline |
Definition at line 24 of file DocumentTextMarkup.h.
Member Function Documentation
◆ emit()
|
virtual |
Emit documentation to output.
Implements Sawyer::Document::BaseMarkup.
◆ doingPageHeader() [1/2]
|
inline |
Property: Whether to create a page header.
Definition at line 34 of file DocumentTextMarkup.h.
◆ doingPageHeader() [2/2]
|
inline |
Property: Whether to create a page header.
Definition at line 35 of file DocumentTextMarkup.h.
◆ doingPageFooter() [1/2]
|
inline |
Property: Whether to create a page footer.
Definition at line 41 of file DocumentTextMarkup.h.
◆ doingPageFooter() [2/2]
|
inline |
Property: Whether to create a page footer.
Definition at line 42 of file DocumentTextMarkup.h.
The documentation for this class was generated from the following file:
