jaxx:generate-help
Nom complet :
org.nuiton.jaxx:jaxx-maven-plugin:2.46:generate-help
Description :
Mojo to generate all the javax help stuff for your project. This
mojo will chain all others help mojo required.
Attributs :
- Exige un projet Maven pour être exécuté.
- Exige une résolution des dépendances des artefacts dans le scope :
compile
. - Depuis la version :
1.3
. - S'associe par défaut dans la phase du cycle de vie :
process-sources
. - Appelle l'exécution du goal de ce plugin
generate-help-search
avant de s'exécuter.
Paramètres requis
Nom | Type | Depuis | Description |
---|---|---|---|
<generateSearch> |
boolean |
1.3 |
Flag to generate the search index. Valeur par défaut : true .Propriété utilisateur : jaxx.generateSearch . |
<helpIdsFilename> |
String |
1.3 |
The store of helpIds generated by the goal
GenerateMojo and then used by the goal
GenerateHelpMojo .Valeur par défaut : helpIds.txt .Propriété utilisateur : jaxx.helpIdsFilename . |
<locales> |
String |
2.0.0 |
The locales to generate for help, separeted by comma. The first
locale given is the default locale. Propriété utilisateur : jaxx.locales . |
<mergeHelpIdsFilename> |
String |
1.3 |
The store of cumulate helpIds generated by the goal
GenerateMojo and then used by the goal
GenerateHelpMojo .Valeur par défaut : helpIds-all.txt .Propriété utilisateur : jaxx.mergeHelpIdsFilename . |
<outputHelpIds> |
File |
1.3 |
Where to generate helpIds files. Valeur par défaut : target/generated-sources/jaxx .Propriété utilisateur : jaxx.outputHelpIds . |
Paramètres optionnels
Nom | Type | Depuis | Description |
---|---|---|---|
<encoding> |
String |
2.0.0 |
Encoding used for file generation. Note: If nothing is
filled here, we will use the system property
file.encoding .Valeur par défaut : ${project.build.sourceEncoding} .Propriété utilisateur : jaxx.encoding . |
<force> |
boolean |
1.3 |
To force generation of java source for any jaxx files with no
timestamp checking. By default, never force generation. Valeur par défaut : false .Propriété utilisateur : jaxx.force . |
<generateHelp> |
boolean |
1.3 |
Flag to activate help id detection while parsing jaxx files. By
default, not active. Valeur par défaut : false .Propriété utilisateur : jaxx.generateHelp . |
<verbose> |
boolean |
1.3 |
Verbose flag. Valeur par défaut : false .Propriété utilisateur : jaxx.verbose . |
Détails des paramètres
<encoding>
Encoding used for file generation. Note: If nothing is
filled here, we will use the system property
file.encoding
.- Type :
java.lang.String
- Depuis :
2.0.0
- Exigé :
Non
- Propriété utilisateur :
jaxx.encoding
- Défaut :
${project.build.sourceEncoding}
<force>
To force generation of java source for any jaxx files with no
timestamp checking. By default, never force generation.
- Type :
boolean
- Depuis :
1.3
- Exigé :
Non
- Propriété utilisateur :
jaxx.force
- Défaut :
false
<generateHelp>
Flag to activate help id detection while parsing jaxx files. By
default, not active.
- Type :
boolean
- Depuis :
1.3
- Exigé :
Non
- Propriété utilisateur :
jaxx.generateHelp
- Défaut :
false
<generateSearch>
Flag to generate the search index.
- Type :
boolean
- Depuis :
1.3
- Exigé :
Oui
- Propriété utilisateur :
jaxx.generateSearch
- Défaut :
true
<helpIdsFilename>
The store of helpIds generated by the goal
GenerateMojo
and then used by the goal
GenerateHelpMojo
.- Type :
java.lang.String
- Depuis :
1.3
- Exigé :
Oui
- Propriété utilisateur :
jaxx.helpIdsFilename
- Défaut :
helpIds.txt
<locales>
The locales to generate for help, separeted by comma. The first
locale given is the default locale.
- Type :
java.lang.String
- Depuis :
2.0.0
- Exigé :
Oui
- Propriété utilisateur :
jaxx.locales
<mergeHelpIdsFilename>
The store of cumulate helpIds generated by the goal
GenerateMojo
and then used by the goal
GenerateHelpMojo
.- Type :
java.lang.String
- Depuis :
1.3
- Exigé :
Oui
- Propriété utilisateur :
jaxx.mergeHelpIdsFilename
- Défaut :
helpIds-all.txt
<outputHelpIds>
Where to generate helpIds files.
- Type :
java.io.File
- Depuis :
1.3
- Exigé :
Oui
- Propriété utilisateur :
jaxx.outputHelpIds
- Défaut :
target/generated-sources/jaxx
<verbose>
Verbose flag.
- Type :
boolean
- Depuis :
1.3
- Exigé :
Non
- Propriété utilisateur :
jaxx.verbose
- Défaut :
false