GeneratorSettings

Undocumented in source.

class GeneratorSettings {

NavigationType navigationType;

bool focusSearchField;

MethodStyle fileNameStyle;

bool highlightInlineCode;

HTMLOutputStyle htmlOutputStyle;

bool enumMemberPages;

bool lowerCase [@property getter];

bool lowerCase [@property setter];

}

Members

Properties

lowerCase deprecated bool lowerCase [@property getter]: Undocumented in source. Be warned that the author may not have intended to support it.
lowerCase deprecated bool lowerCase [@property setter]: Undocumented in source. Be warned that the author may not have intended to support it.

Variables

enumMemberPages bool enumMemberPages;: Creates a page per enum member instead of putting everything into a single table.
fileNameStyle MethodStyle fileNameStyle;: Defines how symbol names are mapped to file names when generating file based documentation (useful for case insensitive file systems)
focusSearchField bool focusSearchField;: focus search field on load
highlightInlineCode bool highlightInlineCode;: Enables syntax highlighting for inline code
htmlOutputStyle HTMLOutputStyle htmlOutputStyle;: Select HTML style (e.g. compact, pretty)
navigationType NavigationType navigationType;: Undocumented in source.
siteUrl URL siteUrl;: used for sitemap generation and for determining the URL prefix in registerApiDocs()

Meta

Source

See Implementation

ddox settings classes

enums