mrdocs::doc::AdmonitionKind

An admonishment style.

Synopsis

Declared in <mrdocs/Metadata/DocComment/Block/AdmonitionKind.hpp>

enum class AdmonitionKind : int;

Members

NameDescription
none No admonishment
note A general note
tip A tip to the reader
important Something important
caution A caution admonishment
warning A warning admonishment

Non-Member Functions

NameDescription
toStringReturn the name of the Admonish as a string.