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.

Variable Details

docs

std::string docs

Content of the documentation.

ingroup

std::string ingroup

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

open

DocToken open

Opening token, used to determine the type of comment.

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.

hide

bool hide

Hide the associated entity?

Function Details

Doc

Doc(const std::string_view comment, const int init_indent)

Constructor.

comment

Comment from which to populate documentation.

init_indent

Initial indent level.