logo

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.

Source

content

override Void content()

Generate the content section of the document.

Source

fandoc

Void fandoc(Str qname, Str text)

Write out the fandoc for this text - if an exception is thrown, write the original text.

Source

override Void header()

Generate the header section of the document.

Source

inheritance

Void inheritance()

Generate the type inheritance.

Source

make

new make(DocCompiler compiler, Location loc, OutStream out, Type t)

Source

static Str makeTypeLink(Type t, |Type -> Uri| map)

Make a type link out in the form <a href='type.uri'>type.name</a>.

Source

parseMeta

Str:Str parseMeta(Str text)

Parse def parameters.

Source

setter

Void setter(Field f)

Write a field's setter proctection level if its different from the getter's level.

Source

override Void sidebar()

Generate the sidebar section of the document.

Source

slotDetail

Void slotDetail(Slot slot)

Generate the documentation for the given slot.

Source

slotModifiers

Void slotModifiers(Slot s)

Write a slot's modifiers.

Source

slots

Slot[] slots

Source

slotsDetail

Void slotsDetail()

Generate the slot detail documentation.

Source

slotsOverview

Void slotsOverview(Bool hideByDefault := true)

Generate the slot overview documentation.

Source

source

Str source()

Return the Uri for the source file of this Type.

Source

t

Type t

Source

title

override Str title()

Return the title for this document.

Source

typeDetail

Void typeDetail()

Generate the type detail documentation.

Source

Void typeLink(Type t)

Convenience for <code>out.print(makeTypeLink(t))</code>.

Source

typeOverview

Void typeOverview()

Generate the type overview documentation.

Source