Class · text

text::ConsoleComments

On this page
aurore/cadran/util/text.hpp
#include <aurore/cadran/util/text.hpp>

class text::ConsoleComments

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.

Types 1

enum Step
ValueDescription
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

text.hpp:150

Functions 1

Read from Aurore's headers by Doxygen at each build · library/include