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.

content

override Void content()

fandoc

Void fandoc(Str text)

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

override Void header()

inheritance

Void inheritance()

Generate the type inheritance.

make

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

parseDefs

Str:Str parseDefs(Str text)

Parse def parameters.

setter

Void setter(Field f)

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

override Void sidebar()

slotDetail

Void slotDetail(Slot slot)

Generate the documentation for the given slot.

slotModifiers

Void slotModifiers(Slot s)

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.

t

Type t

title

override Str title()

typeDetail

Void typeDetail()

Generate the type detail documentation.

Void typeLink(Type t)

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

typeOverview

Void typeOverview()

Generate the type overview documentation.

typeToDisplay

static Str typeToDisplay(Type t)

Convert the Type name to a display string by stripping the pod names from the signature.