class
docCompiler::ApiToHtmlGenerator
sys::Obj fandoc::HtmlDocWriter docCompiler::HtmlGenerator docCompiler::ApiToHtmlGenerator
ApiToHtmlGenerator generates an HTML file for a Type's API
Slots
- actionsSource
-
Void actions()
Generate the actions.
- contentSource
-
override Void content()
Overrides docCompiler::HtmlGenerator.content
Doc inherited from docCompiler::HtmlGenerator.content
Generate the content section of the document.
- docBodySource
-
Get the doc body without the @headers or return null if empty
- fandocSource
-
Void fandoc(Str qname, Str text)
Write out the fandoc for this text - if an exception is thrown, write the original text.
- findOverriddenSource
-
Slot? findOverridden(Slot slot)
Figure out which what slot is being overridden
- headerSource
-
override Void header()
Overrides docCompiler::HtmlGenerator.header
Doc inherited from docCompiler::HtmlGenerator.header
Generate the header section of the document.
- inheritanceSource
-
Void inheritance()
Generate the type inheritance.
- makeSource
-
new make(DocCompiler compiler, Location loc, OutStream out, Type t)
- makeTypeLinkSource
-
static Str makeTypeLink(Type t, |Type -> Uri| map)
Make a type link out in the form <a href='type.uri'>type.name</a>.
- parseMetaSource
-
Parse def parameters.
- setterSource
-
Write a field's setter proctection level if its different from the getter's level.
-
override Void sidebar()
Overrides docCompiler::HtmlGenerator.sidebar
Doc inherited from docCompiler::HtmlGenerator.sidebar
Generate the sidebar section of the document.
- slotDetailSource
-
Generate the documentation for the given slot.
- slotLinkSource
-
Print hyperlink to slot with qname as the anchor text
- slotModifiersSource
-
Write a slot's modifiers.
- slotsSource
-
Slot[] slots
- slotsDetailSource
-
Void slotsDetail()
Generate the slot detail documentation.
- slotsOverviewSource
-
Void slotsOverview(Bool hideByDefault := true)
Generate the slot overview documentation.
- sourceSource
-
Str source()
Return the Uri for the source file of this Type.
- tSource
-
Type t
- titleSource
-
override Str title()
Overrides docCompiler::HtmlGenerator.title
Doc inherited from docCompiler::HtmlGenerator.title
Return the title for this document.
- typeDetailSource
-
Void typeDetail()
Generate the type detail documentation.
- typeLinkSource
-
Convenience for <code>out.print(makeTypeLink(t))</code>.
- typeOverviewSource
-
Void typeOverview()
Generate the type overview documentation.