DDocComment

Represents a sanitized and parsed DDoc comment.

class DDocComment {

Section[] sections;

Section summary;

Section description;

this(Section[] sections, Section summary, Section description);

Section takeCopyright();

bool isDitto();

bool isEmpty();

}

Constructors

this this(Section[] sections, Section summary, Section description): Constructs a DDocComment object.

Members

Functions

isDitto bool isDitto(): Returns true if "ditto" is the only text in this comment.
isEmpty bool isEmpty(): Returns true when this comment has no text.
takeCopyright Section takeCopyright(): Removes the first copyright section and returns it.

Variables

description Section description;: Optional description section.
sections Section[] sections;: The sections of this comment.
summary Section summary;: Optional summary section.

Meta

Source

See Implementation

dil doc Doc classes

structs