Fan

 

class

docCompiler::TopIndexGenerator

sys::Obj
  fandoc::HtmlDocWriter
    docCompiler::HtmlGenerator
      docCompiler::TopIndexGenerator

TopIndexGenerator generates the top level index file.

Slots

contentSource

override Void content()

Overrides docCompiler::HtmlGenerator.content

Doc inherited from docCompiler::HtmlGenerator.content

Generate the content section of the document.

override Void header()

Overrides docCompiler::HtmlGenerator.header

Doc inherited from docCompiler::HtmlGenerator.header

Generate the header section of the document.

isAPISource

Bool isAPI(Pod pod)

listPodsSource

Void listPods(Str title, Bool api)

makeSource

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

pathToRootSource

override Str pathToRoot()

Overrides docCompiler::HtmlGenerator.pathToRoot

Doc inherited from docCompiler::HtmlGenerator.pathToRoot

Returnt the relative path to the document root.

titleSource

override Str title()

Overrides docCompiler::HtmlGenerator.title

Doc inherited from docCompiler::HtmlGenerator.title

Return the title for this document.