Doc

struct Doc

Documentation of an entity.

Variables

Name	Description
docs	Content of the documentation.
ingroup	Group to which the entity belongs, obtained from the documentation comment.
open	Opening token, used to determine the type of comment.
indent	Current indent level of the documentation comment for this entity.
hide	Hide the associated entity?

Functions

Name	Description
Doc	Constructor.
add_indent	Add an indent to the docs in the given style.

Variable Details

docs

std::string docs

Content of the documentation.

hide

bool hide

Hide the associated entity?

indent

int indent

Current indent level of the documentation comment for this entity. This is used for tracking indenting across multiple end-of-line comments, for example following a @note command, each following line should be indented until the end of the paragraph.

ingroup

TextLineCursor ingroup

Group to which the entity belongs, obtained from the documentation comment.

open

DocToken open

Opening token, used to determine the type of comment.

Function Details

Doc

Doc(const TextLineCursor &comment, const int init_indent, const std::string& style)

Constructor.

comment: Comment from which to populate documentation.
init_indent: Initial indent level.
style: Markdown style.

add_indent

void add_indent(const int indent, const std::string& style)

Add an indent to the docs in the given style.

indent: Indentation level.
style: Markdown style.