Author: tchemit Date: 2008-08-12 14:24:48 +0000 (Tue, 12 Aug 2008) New Revision: 1007 Modified: trunk/commandline/maven-plugin/src/main/java/org/codelutin/option/generate/JavaGeneratorGoal.java trunk/commandline/maven-plugin/src/main/java/org/codelutin/option/generate/RstGeneratorGoal.java Log: mise en place documentation de plugin l'attribut @description dans la javadoc ne sert pas au final) Modified: trunk/commandline/maven-plugin/src/main/java/org/codelutin/option/generate/JavaGeneratorGoal.java =================================================================== --- trunk/commandline/maven-plugin/src/main/java/org/codelutin/option/generate/JavaGeneratorGoal.java 2008-08-12 14:23:28 UTC (rev 1006) +++ trunk/commandline/maven-plugin/src/main/java/org/codelutin/option/generate/JavaGeneratorGoal.java 2008-08-12 14:24:48 UTC (rev 1007) @@ -40,158 +40,181 @@ import java.util.TreeMap; /** - * Permet de générer la factory de définitions d'options de ligne de commande, - * pour un fichier de propriété contenant la definition formelle des options. + * Permet de generer la factory de definitions d'options de ligne de commande, + * pour un fichier de propriete contenant la definition formelle des options. * * @author chemit * @goal genJava - * @phase generate-sources + * @phase process-sources */ public class JavaGeneratorGoal extends AbstractGeneratorGoal<JavaGeneratorContext> { /** - * @description chemin du répertoire de génération des resources. + * chemin du repertoire de generation des resources. + * * @parameter expression="${jaxx.outResource}" default-value="${basedir}/target/generated-sources/resources" */ protected File outResource; /** - * @description chemin du répertoire de compilation des resources. + * chemin du repertoire de compilation des resources. + * * @parameter expression="${jaxx.outClass}" default-value="${basedir}/target/classes" */ protected File outClass; /** - * @description flag to copy generated resource files to outClass + * flag to copy generated resource files to outClass + * * @parameter expression="${jaxx.copyToCP}" default-value="true" */ protected boolean copyToCP; /** - * @description Chemin du fichier de propriétés contenant les définitions d'options à utiliser pour générer la factory de définitions d'options. + * fichier de proprietes contenant les definitions d'options a utiliser. + * * @parameter expression="${commandline.source}" * @required */ protected File source; /** - * @description Répertoire de sortie. + * Repertoire de sortie. + * * @parameter expression="${commandline.out}" default-value="${maven.src.dir}/java" * @required */ protected File out; /** - * @description le FQN de la classe concrete du Context + * le FQN de la classe concrete du Context + * * @parameter expression="${commandline.concreteContextFQN}" * @required */ protected String concreteContextFQN; /** - * @description le parser a utiliser + * le parser a utiliser + * * @parameter expression="${commandline.parserFQN}" default-value="org.codelutin.option.def.DefinitionParserFromProperties" */ protected String parserFQN; /** - * @description flag to show errors of parsing. + * flag to show errors of parsing. + * * @parameter expression="${commandLine.showError}" default-value="true" */ protected boolean showErrors; /** - * @description fqn de la super classe du parseur a generer + * fqn de la super classe du parseur a generer + * * @parameter expression="${commandline.parserSuperClass}" default-value="org.codelutin.option.OptionParser" */ protected String parserSuperClass; /** - * @description fqn de la super classe des options a generer + * fqn de la super classe des options a generer + * * @parameter expression="${commandline.optionSuperClass}" default-value="org.codelutin.option.Option" */ protected String optionSuperClass; /** - * @description fqn de la super classe des configs a generer + * fqn de la super classe des configs a generer + * * @parameter expression="${commandline.configSuperClass}" default-value="org.codelutin.option.Config" */ protected String configSuperClass; /** - * @description fqn de la super classe des actions a generer + * fqn de la super classe des actions a generer + * * @parameter expression="${commandline.actionSuperClass}" default-value="org.codelutin.option.OptionAction" */ protected String actionSuperClass; /** - * @description fqn de la super classe des actions a generer + * fqn de la super classe des actions a generer + * * @parameter expression="${commandline.contextSuperClass}" default-value="org.codelutin.option.AbstractContext" */ protected String contextSuperClass; /** - * @description flag pour indique si les configs generes sont concrete ou abstraites + * flag pour indique si les configs generes sont concrete ou abstraites + * * @parameter expression="${commandline.concreteConfig}" default-value="false" */ protected boolean concreteConfig; /** - * @description le nom du fichier de configuration dans la configuration genere + * le nom du fichier de configuration dans la configuration genere + * * @parameter expression="${commandline._configFileName}" default-value=".${project.artifactId}" * @required */ protected String _configFileName; /** - * @description le nom du projet + * le nom du projet + * * @parameter expression="${commandline._projectName}" default-value="${project.artifactId}" * @required */ protected String _projectName; /** - * @description l'url de l'application + * l'url de l'application + * * @parameter expression="${commandline._projectURL}" * @required */ protected String _projectURL; /** - * @description le nom du projet - * @parameter expression="${commandline.__organisationName}" + * le nom du projet + * + * @parameter expression="${commandline._organisationName}" * @required */ protected String _organisationName; /** - * @description l'url de l'application + * l'url de l'application + * * @parameter expression="${commandline._organisationURL}" * @required */ protected String _organisationURL; /** - * @description l'encoding par default dans la configuration genere + * l'encoding par default dans la configuration genere + * * @parameter expression="${commandline._encoding}" default-value="UTF-8" * @required */ protected String _encoding; /** - * @description la locale par default dans la configuration genere + * la locale par default dans la configuration genere + * * @parameter expression="${commandline._locale}" default-value="en_GB" * @required */ protected String _locale; /** - * @description la version dans la configuration genere + * la version dans la configuration genere + * * @parameter expression="${commandline._version}" default-value="${project.version}" * @required */ protected String _version; /** - * @description la version dans la configuration genere + * la version dans la configuration genere + * * @parameter expression="${commandline._copyright}" * @required */ Modified: trunk/commandline/maven-plugin/src/main/java/org/codelutin/option/generate/RstGeneratorGoal.java =================================================================== --- trunk/commandline/maven-plugin/src/main/java/org/codelutin/option/generate/RstGeneratorGoal.java 2008-08-12 14:23:28 UTC (rev 1006) +++ trunk/commandline/maven-plugin/src/main/java/org/codelutin/option/generate/RstGeneratorGoal.java 2008-08-12 14:24:48 UTC (rev 1007) @@ -40,7 +40,7 @@ import java.util.Locale; /** - * Permet de générer les fichiers d'usages de l'application à partir de la classe de context.. + * Permet de generer les fichiers d'usages de l'application a partir de la classe de context.. * * @author chemit * @goal genRst @@ -49,28 +49,32 @@ public class RstGeneratorGoal extends AbstractGeneratorGoal<RstGeneratorContext> { /** - * @description le chemin où trouver les fichiers de traductions pour l'initialisation I18N, sinon le fichier du - * plugin est utilisé, alors qu'il faut que ce soit celui de l'application + * le chemin ou trouver les fichiers de traductions pour l'initialisation I18N, sinon le fichier du + * plugin est utilise, alors qu'il faut que ce soit celui de l'application + * * @parameter expression="${commandline.i18nCP}" default-value="${basedir}/src/resources" */ protected File i18nCP; /** - * @description Répertoire de sortie. + * Repertoire de sortie. + * * @parameter expression="${commandline.out}" default-value="${basedir}/target/classes" * @required */ protected File out; /** - * @description Target rst file. + * Target rst file. + * * @parameter expression="${commandline.rstFilePath}" * @required */ protected String rstFilePath; /** - * @description Target rst file. + * Target rst file. + * * @parameter expression="${commandline.bundles}" */ protected String[] bundles;