Library Reference

version 2.112.0

Internal API

If you spot a problem with this page, click here to create a Bugzilla issue.

Quickly fork, edit online, and submit a pull request for this page.Requires a signed-in GitHub account. This works well for small changes.If you'd like to make larger changes you may want to consider usinga local clone.

dmd.doc

Ddoc documentation generation.

SpecificationDocumentation Generator

Authors:

Walter Bright

License:

Boost License 1.0

Sourcedoc.d

Documentationhttps://dlang.org/phobos/dmd_doc.html

Coveragehttps://codecov.io/gh/dlang/dmd/src/master/compiler/src/dmd/doc.d

voidgendocfile(Modulem, const char[]ddoctext, const char*datetime, ErrorSinkeSink, ref OutBufferoutbuf);

Generate Ddoc text for Modulem and append it tooutbuf.

Parameters:

Module`m`	Module
char[]`ddoctext`	combined text of .ddoc files for macro definitions
char*`datetime`	charz returned by ctime()
ErrorSink`eSink`	send error messages to eSink
OutBuffer`outbuf`	append the Ddoc text to this

voidescapeDdocString(ref OutBufferbuf, size_tstart);

Having unmatched parentheses can hose the output of Ddoc, as the macros depend on properly nested parentheses. This function replaces all ( with ( and ) with ) to preserve text literally. This also means macros in the text won't be expanded.

voidgendocfile(Modulem, const char*ddoctext_ptr, size_tddoctext_length, const char*datetime, ErrorSinkeSink, ref OutBufferoutbuf);

Generate Ddoc file for Module m.

Parameters:

Module`m`	Module
char*`ddoctext_ptr`	combined text of .ddoc files for macro definitions
size_t`ddoctext_length`	extant of ddoctext_ptr
char*`datetime`	charz returned by ctime()
ErrorSink`eSink`	send error messages to eSink
OutBuffer`outbuf`	append the Ddoc text to this

structDocComment;

static voidparseMacros(Escape*escapetable, ref MacroTablepmacrotable, const(char)[]m);: Parse macros out of Macros: section. Macros are of the form: name1 = value1
name2 = value2
static voidparseEscapes(Escape*escapetable, const(char)[]text);: Parse escapes of the form: /c/string/ where c is a single character. Multiple escapes can be separated by whitespace and/or commas.
voidparseSections(const(char)*comment);: Parse next paragraph out of *pcomment. Update *pcomment to point past paragraph. Returns NULL if no more paragraphs. If paragraph ends in 'identifier:', then (*pcomment)[0 .. idlen] is the identifier.

Movatterモバイル変換

Library Reference

dmd.doc