HTMLWriterAggregated

A HTML writer generating 'aggregated' HTML documentation.

Instead of generating a separate file for every variable or function, this only generates files for aggregates (module, struct, class, interface, template, enum), and any non-aggregate symbols are put documented in their aggregate parent's documentation files.

E.g. all member functions and data members of a class are documented directly in the file documenting that class instead of in separate files the class documentation would link to like with HTMLWriterSimple.

This output results in much less files and lower file size than HTMLWriterSimple, and is arguably easier to use due to less clicking between files.

Constructors

this
this(Config config, File searchIndex, TocItem[] tocItems, string[] tocAdditionals)
Undocumented in source.

Members

Aliases

Super
alias Super = typeof(super)
Undocumented in source.
symbolLink
alias symbolLink = symbolLinkAggregated
Undocumented in source.
writeBreadcrumbs
alias writeBreadcrumbs = Super.writeBreadcrumbs
Undocumented in source.

Functions

pushSymbol
auto pushSymbol(string[] symbolStackRaw, SymbolDatabase database, bool first, string itemURL)
Undocumented in source. Be warned that the author may not have intended to support it.
writeSeparator
void writeSeparator(R dst)
Undocumented in source. Be warned that the author may not have intended to support it.
writeSymbolDescription
void writeSymbolDescription(R dst, void delegate() descriptionCode)
Undocumented in source. Be warned that the author may not have intended to support it.
writeSymbolEnd
void writeSymbolEnd(R dst)
Undocumented in source. Be warned that the author may not have intended to support it.
writeSymbolStart
void writeSymbolStart(R dst, string link)
Undocumented in source. Be warned that the author may not have intended to support it.

Meta