Full name:
com.logitags:japedo-maven-plugin:1.3:generate
Description:
Attributes:
Name | Type | Since | Description |
---|---|---|---|
<japedoDirectory> | File | - | the directory where japedo executable japedo.jar and license file
(if present) are installed |
Name | Type | Since | Description | ||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
<applications> | List | - | Configuration parameters for the applications to run. An
<application> has the following child parameters:
|
||||||||||||||||||||||||||||||||||||||||||||||||
<longDescriptionTarget> | String | - | Long attribute descriptions can be displayed in a POPUP window or
in the lower right PANEL. Default value is: POPUP. |
||||||||||||||||||||||||||||||||||||||||||||||||
<outputDirectory> | String | - | target directory for the generated html page Default value is: ${project.build.directory}/japedo. |
||||||||||||||||||||||||||||||||||||||||||||||||
<outputFilename> | String | - | name of the generated documentation file. In case of html output,
.html will be appended. Default value is: ${project.artifactId}. |
||||||||||||||||||||||||||||||||||||||||||||||||
<prettyPrint> | boolean | - | flag if the generated data files contain line breaks and
indentations Default value is: false. |
||||||||||||||||||||||||||||||||||||||||||||||||
<proxyHost> | String | - | proxy host |
||||||||||||||||||||||||||||||||||||||||||||||||
<proxyPort> | String | - | proxy port |
||||||||||||||||||||||||||||||||||||||||||||||||
<showAttributesOfHierarchy> | boolean | - | flag if true the attribute table of an entity shows also attributes
inherited from super classes. Default value is: false. |
||||||||||||||||||||||||||||||||||||||||||||||||
<showCounts> | boolean | - | show number of types in the generated html page Default value is: false. |
Name | Type | Description |
---|---|---|
<name> | String | Unique name of the application that is displayed on the generated html page and used for the name of the generated data file. The expression ${date} is resolved to the current date in format YYYYMMdd. Not allowed characters are spaces # = Default value is: ${project.artifactId}-${project.version} or <dataFile> without suffix |
<description> | String | A description of the application. This will be added to the generated documentation. |
<projectVersion> | String | The application version that is used for the source analysis. If set to LATEST or LATEST:ignorefVersions the latest released version is used for the analysis. Ignored versions can be appended optionally as a comma separated list of regular expressionsDefault value is: ${project.version} |
<additionalDependencies> | List<String> | Binary dependencies are required to compile the sources.
Dependencies are resolved from the pom.xml of the analyzed
application. It could be however, that some transitive provided
dependencies could not be resolved by the plugin. The database
driver dependency for example is often missing in the pom.xml. Such
additional dependencies can be added in format
groupId:artifactId:version[:ignoredVersions]. The version accepts
also 'LATEST'. If LATEST is set, ignored versions can be appended
optionally as a comma separated list of regular expressions Additional dependencies can also be added with the full path to the library in the file system. |
<includeSources> | List<String> | By default, the sources of all dependencies of the Maven
project are scanned for JPA implementations, including third-party
dependencies. This is normally not what is wanted. The sources
should be restricted to those containing JPA persistent types. The
dependency sources to scan can be explicitly set in following
formats:
|
<excludeSources> | List<String> | By default, the sources of all dependencies of the Maven
project are scanned for JPA implementations, including third-party
dependencies. This is normally not what is wanted. The sources
should be restricted to those containing JPA persistent types.
Dependency sources can be excluded from scanning in the following
formats:
|
<charset> | String | charset used to parse the sources. Default value is: UTF-8 |
<dbUsername> | String | database user name |
<dbPassword> | String | database password |
<dbConnectionUrl> | String | database connection URL |
<dbDriverClassName> | String | database driver |
<dbSchema> | String | database schema name. Necessary with some jdbc drivers |
<dbNbThreads> | int | number of parallel threads for generation execution. Default value is: 4 |
<ignoredIssues> | String | comma separated list of unique ids of issues that will be ignored in the issue report. Ignored when property dataFile is set. |
<dataFile> | File | a Japedo data file from a previous execution (only supported in premium version). If this property is set, all other parameters of this job are ignored except name. |