text::ConsoleComments Class Reference

#include <aurore/cadran/util/text.hpp>

Public Types
enum	Step { Show , Skip , Break , Directive }

Public Member Functions
Step	next (const std::string &t, std::string &inner)

Detailed Description

The HTML comments of a Markdown text, invisible on GitHub, read line by line (each trimmed of white space, as trim_space): skipped, except the console's own (an app's changelog and release notes) <!-- console: a line --> that line, read here only; <!-- console:only … --> the lines between, here only; <!-- console:hide --> … <!-- /console --> the lines between, not here.

Member Enumeration Documentation

Step

enum text::ConsoleComments::Step

Enumerator
Show	an ordinary line (one inside console:only too)
Skip	inside a comment or a console:hide block
Break	a comment or a block starts or a console:only ends: no line
Directive	<!-- console: … -->: inner is its line

Member Function Documentation

next()

Step text::ConsoleComments::next ( const std::string &  t, std::string &  inner  )

inline

---

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

• aurore/cadran/util/text.hpp