class compilerDoc::DocPodIndexRenderer

sys::Obj
  compilerDoc::DocRenderer
    compilerDoc::DocPodIndexRenderer

Source

Renders the index of a pod's documents.

Index

<h1><span>pod</span>{pod.qname}</h1>
<p>{pod.summary}</p>

<h2>{section.name}</h2>
<table>
 <tr>
  <td>{type.name}</td>
  <td>{type.summary}</td>
 </tr>
</table>

Table of Contents

<ul>
 <li><a>...</a></li>
 <li><a>...</a>
  <ul>...</ul>
 </li>
</ul>

index

const DocPodIndex index

Source

Pod index to render

make

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

Source

writeContent

virtual override Void writeContent()

Source

Write the content for a pod index. This delegates to writeContentApi or writeContentManual

writeContentApi

virtual Void writeContentApi()

Source

Write the content for an API (non-manual) pod

writeContentManual

virtual Void writeContentManual()

Source

Write the content for a manual pod

writePodDocToc

virtual Void writePodDocToc(DocHeading[] headings)

Source

Write out pod-doc table of contents.

writeTypes

virtual Void writeTypes()

Source

Render the pod's index of types.