Hosted on SourceForge.net Built with Maven

dtddoc:dtddoc

Note:This goal should be used as a Maven report.

Full name:

net.sf.dtddoc:dtddoc-maven-plugin:1.2-SNAPSHOT:dtddoc

Description:

DTDDoc Maven2 plugin, generates DTDDoc report.

Attributes:

  • Requires a Maven project to be executed.

Required Parameters

Name Type Since Description
getAroundNetBeansComments boolean - In case you have comments that start with three hyphens, this option will tell DTDDoc to interpret them as regular double hyphens. This was introduced to support NetBeans comments.
Default value is: true.
User property is: dtddoc.getAroundNetBeansComments.
outputDirectory File - Specifies the destination directory where DTDDoc saves the generated HTML files.
Default value is: ${project.build.directory}/dtddoc/.
showFixmeTags boolean - Tells if the content of the @fixme tags must be part of the documentation
Default value is: true.
User property is: dtddoc.fixme.
showHiddenTags boolean - Tells if the content of the @hidden tags must be part of the documentation
Default value is: false.
User property is: dtddoc.hidden.
sourceDirectory File - Specifies the source directory where DTDDoc searches for DTDs.
Default value is: src/main/resources.

Optional Parameters

Name Type Since Description
docTitle String - Name of the documentation: it will appear at the top of the index.
User property is: dtddoc.title.
excludes String[] - List of patterns used to specify the files that should be excluded in DTD documentation. When not specified, the default excludes will be empty.
includes String[] - List of patterns used to specify the files that should be included in DTD documentation. When not specified, the default includes will be **/*.dtd.
styleSheet File - The stylesheet to use to render the documentation. This stylesheet will be copied into the documentation. If not specified, DTDDoc's default stylesheet is used.
User property is: dtddoc.styleSheet.

Parameter Details

docTitle:

Name of the documentation: it will appear at the top of the index.
  • Type: java.lang.String
  • Required: No
  • User Property: dtddoc.title

excludes:

List of patterns used to specify the files that should be excluded in DTD documentation. When not specified, the default excludes will be empty.
  • Type: java.lang.String[]
  • Required: No

getAroundNetBeansComments:

In case you have comments that start with three hyphens, this option will tell DTDDoc to interpret them as regular double hyphens. This was introduced to support NetBeans comments.
  • Type: boolean
  • Required: Yes
  • User Property: dtddoc.getAroundNetBeansComments
  • Default: true

includes:

List of patterns used to specify the files that should be included in DTD documentation. When not specified, the default includes will be **/*.dtd.
  • Type: java.lang.String[]
  • Required: No

outputDirectory:

Specifies the destination directory where DTDDoc saves the generated HTML files.
  • Type: java.io.File
  • Required: Yes
  • Default: ${project.build.directory}/dtddoc/

showFixmeTags:

Tells if the content of the @fixme tags must be part of the documentation
  • Type: boolean
  • Required: Yes
  • User Property: dtddoc.fixme
  • Default: true

showHiddenTags:

Tells if the content of the @hidden tags must be part of the documentation
  • Type: boolean
  • Required: Yes
  • User Property: dtddoc.hidden
  • Default: false

sourceDirectory:

Specifies the source directory where DTDDoc searches for DTDs.
  • Type: java.io.File
  • Required: Yes
  • Default: src/main/resources

styleSheet:

The stylesheet to use to render the documentation. This stylesheet will be copied into the documentation. If not specified, DTDDoc's default stylesheet is used.
  • Type: java.io.File
  • Required: No
  • User Property: dtddoc.styleSheet