Fantom

 

pod

docCompiler

Fantom documentation compiler

Mixins

DocCompilerSupport DocCompilerSupport provides lots of convenience methods for classes used during the documentation compiler pipeline.

Classes

ApiToHtml ApiToHtml generates an HTML file for each type in pod
ApiToHtmlGenerator ApiToHtmlGenerator generates an HTML file for a Type's API
BuildSearchIndex BuildSearchIndex generates the top level navigation and search index.
CopyResources CopyResources copies master resource files like fandoc.css to the target directory.
DocCompiler DocCompiler manages the pipeline of compiling API and stand-alone fandoc documents into HTML.
DocCompilerStep DocCompilerStep
FandocIndexToHtmlGenerator FandocIndexToHtmlGenerator generates an HTML file from an index.fog file.
FandocToHtml FandocToHtml generates an HTML file for each fandoc file in pod
FandocToHtmlGenerator FandocToHtmlGenerator generates an HTML file for a standalone fandoc file
FanToHtml FanToHtml generates a syntax color coded HTML fragment from a Fantom source file.
HtmlDocTest HtmlDocTest is used for used for testing HTML generation for the docCompiler pod.
HtmlDocUtil HtmlDocUtil provides util methods for generating Html documenation.
HtmlGenerator HtmlGenerator is the base class for HTML generation which handles all the navigation and URI concerns
HtmlTheme HtmlTheme decorates a HtmlGenerator
Init Init prepares the output directory.
ListNode
Main Main is the main entry point for the Fantom documentation compiler.
PodDocGenerator PodDocGenerator generates pod-doc from pod.fandoc.
PodIndexGenerator PodIndexGenerator generates the index file for a pod.
PodIndexToHtml PodIndexToHtml generates the Index.html file for a specific pod if one wasn't manually provided.
SourceToHtml SourceToHtml generates a HTML file for each type in pod
SourceToHtmlGenerator SourceToHtmlGenerator generates an syntax color coded HTML file for a Type's source code.
TopIndexGenerator TopIndexGenerator generates the top level index file.
TopIndexToHtml TopIndexToHtml generates the top level navigation and search index.
UriMapper UriMapper is used to normalize fandoc URIs into hrefs to their HTML file representation using relative URLs.