classafAskFanny::IndexBuilder

sys::Obj
  afAskFanny::IndexBuilder

Indexes documents and pods to create an Index instrance.

build

Source

Index build()

Builds an Index instance from the indexed documents.

indexAllPods

Source

This indexAllPods()

Indexes all pods in the current Fantom installation.

indexCorePods

Source

This indexCorePods()

Indexes a subset of core pods from the standard Fantom installation; including sys and all reference documentation.

indexFandoc

Source

This indexFandoc(Str pod, Str type, InStream in)

Indexes a single fandoc file. Useful for adhoc documents.

indexPod

Source

This indexPod(Str podName)

Indexes the contents of a pod, including:

  • all documented types - <pod>/doc/*.apidoc
  • all fandocs - <pod>/doc/*.fandoc
sections

Source

Section[] sections := Section[,]