class compilerDoc::DocTopIndexRenderer

sys::Obj
  compilerDoc::DocRenderer
    compilerDoc::DocTopIndexRenderer

Source

Renders the index of a pod's documents

index

const DocTopIndex index

Source

Pod index to render

make

new make(DocEnv env, WebOutStream out, DocTopIndex doc)

Source

writeApis

virtual Void writeApis(DocPod[] pods)

Source

Write API table of pod name/link and summaries.

writeContent

virtual override Void writeContent()

Source

Write the content for a top index. Default organizes pods into manuals and APIs.

writeManuals

virtual Void writeManuals(DocPod[] pods)

Source

Write manuals table of pod name/links along with shortcut chapter links.