This plugin is for a Spring Surf project to generate reference documents for its Web Scripts, JavaScript root objects, Template root objects, custom Template and JavaScript APIs.
As part of Maven build process, this plugin will use the embedded Spring Web Script container to locate all web scripts that are either packed into Spring Surf library jars or placed under WEB-INF directory. The plugin will then generate DocBook based documentation using the information provided by web script package description documents, schema description documents and web script description documents.
This plugin can also be used to generate similar DocBook based reference documents for all available JavaScript root objects, Template root objects, custom Template and JavaScript APIs of the current Spring Surf web application. It will retrieve Spring Surf ScriptClass, ScriptMethod and ScriptParameter Java annotations of target Java classes for document generation.
All generated DocBook XMl documents can then be further rendered to prefered formats such as single-page HTML, multiple-page HTML or PDF using DocBook Maven plugins such as Docbkx Maven Plugin.
Goals available for this plugin:
General instructions on how to use the Plugin Name can be found on the usage page. Some more specific use cases are described in the examples given below.
In case you still have questions regarding the plugin's usage, please have a look at the FAQ.