pousse-cafe:generate-doc
Full name:
org.pousse-cafe-framework:pousse-cafe-maven-plugin:0.19.0:generate-doc
Description:
Generates an expert-readable documentation of the Model. The documentation is generated in HTML and as a PDF file.
Documentation is generated by analyzing source code. Further instructions about how to enable documentation generation can be found here.
Attributes:
- Requires a Maven project to be executed.
- Requires dependency resolution of artifacts in scope: compile+runtime.
Required Parameters
| Name | Type | Since | Description |
|---|---|---|---|
| <basePackage> | String | 0.6 | The base package in which domain components are looked for. Any
class not being in the base package or one of its sub-packages will
be ignored. User property is: basePackage. |
| <domainName> | String | 0.6 | The name of the domain represented by the Model. The name is
essentially used in the title of the document. User property is: domainName. |
| <outputDirectory> | File | 0.6 | The output directory for generated documentation files (HTML, PDF,
...). Default value is: ${basedir}/target/ddd-doc/. User property is: outputDirectory. |
| <pdfFileName> | String | 0.9 | The file name for generated PDF file. Default value is: ${project.artifactId}-${project.version}.pdf. User property is: pdfFileName. |
| <skipDoc> | String | 0.9 | Tells not to generate documentation. This flag can be used when the
goal execution has been bound to a phase in the POM but one would
like to skip it. Default value is: false. User property is: skipDoc. |
| <version> | String | 0.6 | The version of the documentation. It is generally synchronized with
the version of the source code. The version is displayed in the
subtitle of the document. Default value is: ${project.version}. User property is: version. |
Optional Parameters
| Name | Type | Since | Description |
|---|---|---|---|
| <customDotExecutable> | String | 0.7 | The path to Graphviz 'dot'
executable. Dot is used to generate process graphs. User property is: customDotExecutable. |
| <customFdpExecutable> | String | 0.7 | The path to Graphviz 'fdp'
executable. Fdp is used to generate relational graphs (i.e. graphs
showing the relation between Entities, Value Objects, ...). User property is: customFdpExecutable. |
Parameter Details
<basePackage>
The base package in which domain components are looked for. Any
class not being in the base package or one of its sub-packages will
be ignored.
- Type: java.lang.String
- Since: 0.6
- Required: Yes
- User Property: basePackage
<customDotExecutable>
The path to Graphviz 'dot'
executable. Dot is used to generate process graphs.
- Type: java.lang.String
- Since: 0.7
- Required: No
- User Property: customDotExecutable
<customFdpExecutable>
The path to Graphviz 'fdp'
executable. Fdp is used to generate relational graphs (i.e. graphs
showing the relation between Entities, Value Objects, ...).
- Type: java.lang.String
- Since: 0.7
- Required: No
- User Property: customFdpExecutable
<domainName>
The name of the domain represented by the Model. The name is
essentially used in the title of the document.
- Type: java.lang.String
- Since: 0.6
- Required: Yes
- User Property: domainName
<outputDirectory>
The output directory for generated documentation files (HTML, PDF,
...).
- Type: java.io.File
- Since: 0.6
- Required: Yes
- User Property: outputDirectory
- Default: ${basedir}/target/ddd-doc/
<pdfFileName>
The file name for generated PDF file.
- Type: java.lang.String
- Since: 0.9
- Required: Yes
- User Property: pdfFileName
- Default: ${project.artifactId}-${project.version}.pdf
<skipDoc>
Tells not to generate documentation. This flag can be used when the
goal execution has been bound to a phase in the POM but one would
like to skip it.
- Type: java.lang.String
- Since: 0.9
- Required: Yes
- User Property: skipDoc
- Default: false
<version>
The version of the documentation. It is generally synchronized with
the version of the source code. The version is displayed in the
subtitle of the document.
- Type: java.lang.String
- Since: 0.6
- Required: Yes
- User Property: version
- Default: ${project.version}