
class
docCompiler::ApiToHtmlGenerator
sys::Obj fandoc::HtmlDocWriter docCompiler::HtmlGenerator docCompiler::ApiToHtmlGenerator
ApiToHtmlGenerator generates an HTML file for a Type's API
Slots
- actions
-
Void actions()
Generate the actions.
- content
-
override Void content()
Generate the content section of the document.
- fandoc
-
Void fandoc(Str qname, Str text)
Write out the fandoc for this text - if an exception is thrown, write the original text.
- header
-
override Void header()
Generate the header section of the document.
- inheritance
-
Void inheritance()
Generate the type inheritance.
- make
-
new make(DocCompiler compiler, Location loc, OutStream out, Type t)
- makeTypeLink
-
static Str makeTypeLink(Type t, |Type -> Uri| map)
Make a type link out in the form <a href='type.uri'>type.name</a>.
- parseMeta
-
Parse def parameters.
- setter
-
Write a field's setter proctection level if its different from the getter's level.
-
override Void sidebar()
Generate the sidebar section of the document.
- slotDetail
-
Generate the documentation for the given slot.
- slotModifiers
-
Write a slot's modifiers.
- slots
-
Slot[] slots
- slotsDetail
-
Void slotsDetail()
Generate the slot detail documentation.
- slotsOverview
-
Void slotsOverview(Bool hideByDefault := true)
Generate the slot overview documentation.
- source
-
Str source()
Return the Uri for the source file of this Type.
- t
-
Type t
- title
-
override Str title()
Return the title for this document.
- typeDetail
-
Void typeDetail()
Generate the type detail documentation.
- typeLink
-
Convenience for <code>out.print(makeTypeLink(t))</code>.
- typeOverview
-
Void typeOverview()
Generate the type overview documentation.