class compilerDoc::DocTypeRenderer

sys::Obj
  compilerDoc::DocRenderer
    compilerDoc::DocTypeRenderer

Source

Renders DocType documents

Overview

<h1>
 <span>{type.flags}</span> {type.qname}
</h1>
<pre>...</pre>                 // inhertiance
<p class='facets'>...</p>      // facet list (if available)
<p class='src'><a>...</a></p>  // source link (if available)
...                            // type fandoc
<ul>...</ul>                   // emum list (if available)

Slots

<dl>
 <dt id='{slot.name}'>{slot.name}</dt>
 <dd>
  <p class='sig'><code>...</code></p>  // slot signature
  <p class='src'><a>...</a></p>        // source link (if available)
  ...                                  // slot fandoc
 </dd>
</dl>

Table of Contents

<h3>Source</h3>
<ul><li><a>...</a></li></ul>     // if source link
<ul><li>Not available</li></ul>  // if no source link

<h3>Slots</h3>
<ul>
 <li><a href='#{slot.name}'>{slot.name}</a></li>
</ul>

make

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

Source

Constructor with env, out params.

toSrcLink

DocLink? toSrcLink(DocLoc loc, Str dis)

Source

Map filename/line number to a source file link

type

const DocType type

Source

Type to renderer

writeContent

virtual override Void writeContent()

Source

writeFacet

virtual Void writeFacet(DocFacet f)

Source

Write the given facet.

writeSlot

virtual Void writeSlot(DocSlot slot)

Source

Render the HTML for all the given slot

writeSlotSig

virtual Void writeSlotSig(DocSlot slot)

Source

Render HTML for slot signature.

writeSlots

virtual Void writeSlots()

Source

Render the HTML for all the slot definitions

writeSrcLink

virtual Void writeSrcLink(DocLoc loc, Str dis := "Source")

Source

Write source code link as <p> if source is available.

writeToc

virtual Void writeToc()

Source

Render the table of contents for this type.

writeTypeInheritance

virtual Void writeTypeInheritance()

Source

Render type inheritance.

writeTypeOverview

virtual Void writeTypeOverview()

Source

Render the HTML for the type overview (base, mixins, type doc)

writeTypeRef

virtual Void writeTypeRef(DocTypeRef ref, Bool full := false)

Source

Write the given type ref as a hyperlink