Skip to content

Commit 642e4c8

Browse files
committed
Updated documentation #180
1 parent f39fdb0 commit 642e4c8

File tree

1 file changed

+12
-10
lines changed

1 file changed

+12
-10
lines changed

fj-doc-maven-plugin/README.md

Lines changed: 12 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,8 @@ All basic features are implemented.
2020
| verify | 8.7.0 | verify the templates in a FreeMarker configuration (folder), note: it can be used on any Apache FreeMarker configuration, not only Fugerit Venus Doc. |
2121
| init | 8.7.2 | create a new project project already configured (actually an extension to 'add' goal); an UI is available on the [playground](https://docs.fugerit.org/fj-doc-playground/home) too. |
2222

23+
NOTE: Even though possible, it is not a recommended to run the 'add' or 'init' plugin with setting a 'version' parmeter lower than '8.7.4' (see issue [#180](https://github.com/fugerit-org/fj-doc/issues/180))
24+
2325
## Goal : add
2426

2527
add Venus Doc Configuration to an existing project
@@ -41,16 +43,16 @@ mvn org.fugerit.java:fj-doc-maven-plugin:add \
4143

4244
### Add Fugerit Venus, parameters
4345

44-
| parameter | required | default | description |
45-
|-----------------|----------|-----------------|---------------------------------------------------------------------------------------------------|
46-
| version | true | latest stable | fj-doc version to add to the project (i.e. '8.7.4') |
47-
| extensions | true | base,freemarker | List of fj-doc core modules to add (*) |
48-
| projectFolder | true | . | Maven project base folder |
49-
| addDocFacade | true | true | If true, a stub doc configuration helper will be created |
50-
| force | false | false | Will force project setup even if fj-doc already configured (warning: can overwrite configuration) |
51-
| excludeXmlApis | false | false | It will exclude dependency xml-apis:xml-apis |
52-
| addExclusions | false | | Add comma separated exclusion, for instance : xml-apis:xml-apis,${groupId}:${artificatId} |
53-
| addVerifyPlugin | true | true | If set to true, it will configure the 'verify' goal on the project |
46+
| parameter | required | default | description |
47+
|-----------------|----------|-----------------|-----------------------------------------------------------------------------------------------------------------------------------|
48+
| version | true | latest stable | fj-doc version to add to the project (i.e. '8.7.4'), *advice*: **keep the default** unless a specific version is striclty needed. |
49+
| extensions | true | base,freemarker | List of fj-doc core modules to add (*) |
50+
| projectFolder | true | . | Maven project base folder |
51+
| addDocFacade | true | true | If true, a stub doc configuration helper will be created |
52+
| force | false | false | Will force project setup even if fj-doc already configured (warning: can overwrite configuration) |
53+
| excludeXmlApis | false | false | It will exclude dependency xml-apis:xml-apis |
54+
| addExclusions | false | | Add comma separated exclusion, for instance : xml-apis:xml-apis,${groupId}:${artificatId} |
55+
| addVerifyPlugin | true | true | If set to true, it will configure the 'verify' goal on the project |
5456
### Add Fugerit Venus, available extensions
5557

5658
| short name | full name | type handler | description |

0 commit comments

Comments
 (0)