ROSE 0.11.145.192
Public Member Functions | List of all members
Sawyer::Document::PodMarkup Class Reference

Description

Definition at line 17 of file DocumentPodMarkup.h.

Inheritance diagram for Sawyer::Document::PodMarkup:
Inheritance graph
[legend]
Collaboration diagram for Sawyer::Document::PodMarkup:
Collaboration graph
[legend]

Public Member Functions

virtual bool emit (const std::string &doc)
 Emit documentation to output.
 
- Public Member Functions inherited from Sawyer::Document::BaseMarkup
BaseMarkuptitle (const std::string &pageName, const std::string &chapterNumber, const std::string &chapterTitle)
 Set title properties.
 
BaseMarkupversion (const std::string &versionString, const std::string &versionDate)
 Set version properties.
 
virtual std::string operator() (const std::string &)
 Parse input to generate POD.
 
const std::string & pageName () const
 Property: Page name.
 
BaseMarkuppageName (const std::string &s)
 Property: Page name.
 
const std::string & chapterNumber () const
 Property: Chapter number.
 
BaseMarkupchapterNumber (const std::string &s)
 Property: Chapter number.
 
const std::string & chapterNumberOrDefault () const
 Property: Chapter number.
 
const std::string & chapterTitle () const
 Property: Chapter title.
 
BaseMarkupchapterTitle (const std::string &s)
 Property: Chapter title.
 
const std::string & chapterTitleOrDefault () const
 Property: Chapter title.
 
const std::string & versionString () const
 Property: Version string.
 
BaseMarkupversionString (const std::string &s)
 Property: Version string.
 
const std::string & versionStringOrDefault () const
 Property: Version string.
 
const std::string & versionDate () const
 Property: Version date.
 
BaseMarkupversionDate (const std::string &s)
 Property: Version date.
 
const std::string & versionDateOrDefault () const
 Property: Version date.
 
- Public Member Functions inherited from Sawyer::Document::Markup::Grammar
Grammarwith (const Function::Ptr &)
 Insert function.
 
virtual std::string operator() (const std::string &s) const
 Evaluate an entire string.
 

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

◆ PodMarkup()

Sawyer::Document::PodMarkup::PodMarkup ( )
inline

Definition at line 19 of file DocumentPodMarkup.h.

Member Function Documentation

◆ emit()

virtual bool Sawyer::Document::PodMarkup::emit ( const std::string &  doc)
virtual

Emit documentation to output.

Implements Sawyer::Document::BaseMarkup.


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