Wiki

Clone wiki

autodoc / Html Plugin

The HTML plugin is configurable through a standard properties file, configured in the standard way:

#!xml
<outputPlugins>
    <param>net.riccardocossu.autodoc.html.HtmlOutputPlugin,htmlConfig.properties</param>
</outputPlugins>

or using the short form

#!xml

<outputPlugins>
    <param>HTML,htmlConfig.properties</param>
</outputPlugins>

where htmlConfig.properties is searched in the classpath as an absolute path.

Note that there is no need to configure it if you're ok with the default settings. The config has the following properties:

  • outputEncoding=<encoding to use for output>
  • baseTemplatePath=<classpath path to use as a base for templates>
  • packageTemplateName=<custom name for package template>
  • cssFile=<custom name for css file (file name only>
  • cssPath=<custom path for css file>

Updated