org.springframework.extensions.surf:spring-surf-doc-plugin:1.0.0.CI-SNAPSHOT:generate-webscript-doc
A maven plugin for generating Spring web script reference document in DocBook XML format.
| Parameter | Optional | Default | Description |
| outputDirectory | true | ${basedir}/target/site/docbook/reference | Output directory of the generated DocBook XML |
| outputFilename | true | appendix-webscript-index.xml | Name of the generated DocBook XML |
| localWebscriptPath | true | Addtional file pathes for seaching local web scripts | |
| localWebscriptOnly | true | false | If true, the mojo will generate DocBook XML elements for local web scripts |
| contextXML | true | Addtional Spring context XMLs for loading web script container | |
| docBookDocumentType | true | appendix | Document type of the generated docbook XML such as appendix, chapter etc. |
| itemElementType | true | itemizedlist | Docbook XMLElement type for the individual Web Script. Supported types includes variablelist and itemizedlist. |
org.springframework.extensions.surf:spring-surf-doc-plugin:1.0.0.CI-SNAPSHOT:generate-javascript-doc
A maven plugin for generating JavaScript root object reference document in DocBook XML format.
| Parameter | Optional | Default | Description |
| outputDirectory | true | ${basedir}/target/site/docbook/reference | Output directory of the generated DocBook XML |
| outputFilename | true | appendix-javascript-index.xml | Name of the generated DocBook XML |
| contextXML | true | Addtional Spring context XMLs for loading web script container | |
| docBookDocumentType | true | appendix | Document type of the generated docbook XML such as appendix, chapter etc. |
| itemElementType | true | itemizedlist | Docbook XMLElement type for the individual Web Script. Supported types includes variablelist and itemizedlist. |
| skipUnannotatedMethods | true | true | If true, the mojo will not generate DocBook XML elements on methods without ScriptMethod annotation. |
org.springframework.extensions.surf:spring-surf-doc-plugin:1.0.0.CI-SNAPSHOT:generate-template-doc
A maven plugin for generating Template root object reference document in DocBook XML format.
| Parameter | Optional | Default | Description |
| outputDirectory | true | ${basedir}/target/site/docbook/reference | Output directory of the generated DocBook XML |
| outputFilename | true | appendix-template-index.xml | Name of the generated DocBook XML |
| contextXML | true | Addtional Spring context XMLs for loading web script container | |
| docBookDocumentType | true | appendix | Document type of the generated docbook XML such as appendix, chapter etc. |
| itemElementType | true | itemizedlist | Docbook XMLElement type for the individual Web Script. Supported types includes variablelist and itemizedlist. |
| skipUnannotatedMethods | true | true | If true, the mojo will not generate DocBook XML elements on methods without ScriptMethod annotation. |
org.springframework.extensions.surf:spring-surf-doc-plugin:1.0.0.CI-SNAPSHOT:generate-javascript-api-doc
A maven plugin for generating custom JavaScript API reference document in DocBook XML format.
| Parameter | Optional | Default | Description |
| outputDirectory | true | ${basedir}/target/site/docbook/reference | Output directory of the generated DocBook XML |
| outputFilename | true | appendix-javascript-index.xml | Name of the generated DocBook XML |
| contextXML | true | Addtional Spring context XMLs for loading web script container | |
| docBookDocumentType | true | appendix | Document type of the generated docbook XML such as appendix, chapter etc. |
| basePackages | true | org | Base package scanning patterns for locating Java classes. It supports multiple patterns which need to be separated by comma, e.g. org,com.springsource |
| itemElementType | true | itemizedlist | Docbook XMLElement type for the individual Web Script. Supported types includes variablelist and itemizedlist. |
| skipUnannotatedMethods | true | true | If true, the mojo will not generate DocBook XML elements on methods without ScriptMethod annotation. |
| localDirectoryScanPattern | true | file:target/classes/** /*.class | Local directory scanning pattern for locating Java classes that provides JavaScript APIs |
| localDirectoryScanOption | true | on | If value is on, the mojo will use the localDirectoryScanPattern to locate JavaScript APIs provided by local classes. If value is off, the mojo will not scan local directories for JavaScript APIs.If value is only, the mojo will only scan local directories for JavaScript APIs. |
org.springframework.extensions.surf:spring-surf-doc-plugin:1.0.0.CI-SNAPSHOT:generate-template-api-doc
A maven plugin for generating Template custom API reference document in DocBook XML format.
| Parameter | Optional | Default | Description |
| outputDirectory | true | ${basedir}/target/site/docbook/reference | Output directory of the generated DocBook XML |
| outputFilename | true | appendix-template-index.xml | Name of the generated DocBook XML |
| contextXML | true | Addtional Spring context XMLs for loading web script container | |
| docBookDocumentType | true | appendix | Document type of the generated docbook XML such as appendix, chapter etc. |
| basePackages | true | org | Base package scanning patterns for locating Java classes. It supports multiple patterns which need to be separated by comma, e.g. org,com.springsource |
| itemElementType | true | itemizedlist | Docbook XMLElement type for the individual Web Script. Supported types includes variablelist and itemizedlist. |
| skipUnannotatedMethods | true | true | If true, the mojo will not generate DocBook XML elements on methods without ScriptMethod annotation. |
| localDirectoryScanPattern | true | file:target/classes/** /*.class | Local directory scanning pattern for locating Java classes that provides Template custom APIs |
| localDirectoryScanOption | true | on | If value is on, the mojo will use the localDirectoryScanPattern to locate Template custom APIs provided by local classes. If value is off, the mojo will not scan local directories for Template custom APIs.If value is only, the mojo will only scan local directories for Template custom APIs. |
