Report a bug
If you spot a problem with this page, click here to create a Bugzilla issue.
Improve this page
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 using
a local clone.
dmd.doc
Ddoc documentation generation.
Specification Documentation Generator
Authors:
License:
Source doc.d
Documentation https://dlang.org/phobos/dmd_doc.html
- void
gendocfile(Modulem, const char*ddoctext_ptr, size_tddoctext_length, const char*datetime, ErrorSinkeSink, ref OutBufferoutbuf); - Generate Ddoc file for Module m.Parameters:
Module mModule char* ddoctext_ptrcombined text of .ddoc files for macro definitions size_t ddoctext_lengthextant of ddoctext_ptr char* datetimecharz returned by ctime() ErrorSink eSinksend error messages to eSink OutBuffer outbufappend the Ddoc text to this - void
gendocfile(Modulem, const char[]ddoctext, const char*datetime, ErrorSinkeSink, ref OutBufferoutbuf); - Generate Ddoc text for Module
mand append it tooutbuf.Parameters:Module mModule char[] ddoctextcombined text of .ddoc files for macro definitions char* datetimecharz returned by ctime() ErrorSink eSinksend error messages to eSink OutBuffer outbufappend the Ddoc text to this - void
escapeDdocString(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.
- struct
DocComment; -
- static void
parseMacros(Escape*escapetable, ref MacroTablepmacrotable, const(char)[]m); - Parse macros out of Macros: section. Macros are of the form: name1 = value1name2 = value2
- static void
parseEscapes(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.
- void
parseSections(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.
Copyright © 1999-2025 by the D Language Foundation | Page generated by
Ddoc on Mon Mar 31 10:27:51 2025