Fan

 

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()

Generate the content section of the document.

docBodySource

static Str? docBody(Str? doc)

Get the doc body without the @headers or return null if empty

fandocSource

static Void fandoc(HtmlGenerator gen, 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

override Void 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)

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

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

parseMetaSource

static Str:Str parseMeta(Str? text)

Parse def parameters.

setterSource

Void setter(Field f)

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.

slotDetailSource

Void slotDetail(Slot slot)

Generate the documentation for the given slot.

Void slotLink(Slot s)

Print hyperlink to slot with qname as the anchor text

slotModifiersSource

Void slotModifiers(Slot s)

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()

Return the title for this document.

typeDetailSource

Void typeDetail()

Generate the type detail documentation.

Void typeLink(Type t)

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

typeOverviewSource

Void typeOverview()

Generate the type overview documentation.