Optional Parameters

Name	Type	Description
docTitle	String	Name of the documentation: it will appear at the top of the index.
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.
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.
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.
outputDirectory	File	Specifies the destination directory where DTDDoc saves the generated HTML files.
showFixmeTags	boolean	Tells if the content of the @fixme tags must be part of the documentation Default value is true.
showHiddenTags	boolean	Tells if the content of the @hidden tags must be part of the documentation Default value is false.
siteRenderer	Renderer	Doxia Site Renderer.
sourceDirectory	File	Specifies the source directory where DTDDoc searches for DTDs.
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.

Parameter Details

docTitle

Name of the documentation: it will appear at the top of the index.

• Type: java.lang.String
• Required: No
• Expression: ${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: No
• Expression: ${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: No
• Expression: ${project.build.directory}/dtddoc/

---

showFixmeTags Tells if the content of the @fixme tags must be part of the documentation

• Type: boolean
• Required: No
• Expression: ${dtddoc.fixme}
• Default: true

---

showHiddenTags Tells if the content of the @hidden tags must be part of the documentation

• Type: boolean
• Required: No
• Expression: ${dtddoc.hidden}
• Default: false

---

siteRenderer Doxia Site Renderer.

• Type: org.apache.maven.doxia.siterenderer.Renderer
• Required: No

---

sourceDirectory Specifies the source directory where DTDDoc searches for DTDs.

• Type: java.io.File
• Required: No
• Expression: 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
• Expression: ${dtddoc.styleSheet}