ExportAsHtml

Any Documentable annotated with this annotation will be exported to HTML by the documentation processor.

You can use @exportAsHtmlStart and @exportAsHtmlEnd to specify a range of the doc to export to HTML.

NOTE: DO NOT RENAME!

Parameters

theme

Whether to include a simple theme in the HTML file. Default is true.

stripReferences

Whether to strip [references] from the HTML file. Default is true. This is useful when you want to include the HTML file in a website, where the references are not needed or would break.

includeResizeScript

Whether to include a script that helps height recalculation inside iFrames. This is useful inside WriterSide. Default is true.

Properties

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
val theme: Boolean = true