Author: sletellier Date: 2012-01-04 14:58:53 +0100 (Wed, 04 Jan 2012) New Revision: 18 Url: http://forge.codelutin.com/repositories/revision/jmexico/18 Log: Improve javadoc Modified: trunk/jmexico-model/src/main/java/fr/reseaumexico/model/DateFormatFactory.java trunk/jmexico-model/src/main/java/fr/reseaumexico/model/InputDesignImpl.java trunk/jmexico-model/src/main/java/fr/reseaumexico/model/MexicoTechnicalException.java trunk/jmexico-model/src/main/java/fr/reseaumexico/model/ScenarioImpl.java trunk/jmexico-model/src/main/java/fr/reseaumexico/model/event/InputDesignFactorEvent.java trunk/jmexico-model/src/main/java/fr/reseaumexico/model/event/InputDesignScenarioEvent.java trunk/jmexico-model/src/main/java/fr/reseaumexico/model/event/ScenarioFactorValueEvent.java trunk/jmexico-model/src/main/java/fr/reseaumexico/model/parser/ExperimentDesignParser.java trunk/jmexico-model/src/main/java/fr/reseaumexico/model/parser/InputDesignParser.java trunk/jmexico-model/src/main/java/fr/reseaumexico/model/parser/MexicoXmlParser.java trunk/jmexico-model/src/main/java/fr/reseaumexico/model/parser/XmlParser.java trunk/jmexico-model/src/main/java/fr/reseaumexico/model/writer/InputDesignXmlWriter.java trunk/jmexico-swing-editor/src/main/resources/i18n/jmexico-swing-editor_en_GB.properties trunk/jmexico-swing-editor/src/main/resources/i18n/jmexico-swing-editor_fr_FR.properties Modified: trunk/jmexico-model/src/main/java/fr/reseaumexico/model/DateFormatFactory.java =================================================================== --- trunk/jmexico-model/src/main/java/fr/reseaumexico/model/DateFormatFactory.java 2012-01-04 10:55:47 UTC (rev 17) +++ trunk/jmexico-model/src/main/java/fr/reseaumexico/model/DateFormatFactory.java 2012-01-04 13:58:53 UTC (rev 18) @@ -28,8 +28,11 @@ import java.text.SimpleDateFormat; /** + * Factory for format all jmexico dates using {@link SimpleDateFormat} + * * @author sletellier <letellier@codelutin.com> * @since 0.1 + * @see SimpleDateFormat */ public class DateFormatFactory { Modified: trunk/jmexico-model/src/main/java/fr/reseaumexico/model/InputDesignImpl.java =================================================================== --- trunk/jmexico-model/src/main/java/fr/reseaumexico/model/InputDesignImpl.java 2012-01-04 10:55:47 UTC (rev 17) +++ trunk/jmexico-model/src/main/java/fr/reseaumexico/model/InputDesignImpl.java 2012-01-04 13:58:53 UTC (rev 18) @@ -39,6 +39,8 @@ import javax.swing.event.EventListenerList; /** + * Implementation of {@link InputDesign} to provide listener API + * * @author sletellier <letellier@codelutin.com> * @since 0.1 */ Modified: trunk/jmexico-model/src/main/java/fr/reseaumexico/model/MexicoTechnicalException.java =================================================================== --- trunk/jmexico-model/src/main/java/fr/reseaumexico/model/MexicoTechnicalException.java 2012-01-04 10:55:47 UTC (rev 17) +++ trunk/jmexico-model/src/main/java/fr/reseaumexico/model/MexicoTechnicalException.java 2012-01-04 13:58:53 UTC (rev 18) @@ -25,6 +25,8 @@ package fr.reseaumexico.model; /** + * Mexico technical exception + * * @author sletellier <letellier@codelutin.com> * @since 0.1 */ Modified: trunk/jmexico-model/src/main/java/fr/reseaumexico/model/ScenarioImpl.java =================================================================== --- trunk/jmexico-model/src/main/java/fr/reseaumexico/model/ScenarioImpl.java 2012-01-04 10:55:47 UTC (rev 17) +++ trunk/jmexico-model/src/main/java/fr/reseaumexico/model/ScenarioImpl.java 2012-01-04 13:58:53 UTC (rev 18) @@ -31,6 +31,8 @@ import javax.swing.event.EventListenerList; /** + * Implementation of {@link Scenario} to provide listener API + * * @author sletellier <letellier@codelutin.com> * @since 0.1 */ Modified: trunk/jmexico-model/src/main/java/fr/reseaumexico/model/event/InputDesignFactorEvent.java =================================================================== --- trunk/jmexico-model/src/main/java/fr/reseaumexico/model/event/InputDesignFactorEvent.java 2012-01-04 10:55:47 UTC (rev 17) +++ trunk/jmexico-model/src/main/java/fr/reseaumexico/model/event/InputDesignFactorEvent.java 2012-01-04 13:58:53 UTC (rev 18) @@ -28,6 +28,8 @@ import fr.reseaumexico.model.Scenario; /** + * Event fired when {@link fr.reseaumexico.model.Factor} change on {@link InputDesign} + * * @author sletellier <letellier@codelutin.com> * @since 0.1 */ Modified: trunk/jmexico-model/src/main/java/fr/reseaumexico/model/event/InputDesignScenarioEvent.java =================================================================== --- trunk/jmexico-model/src/main/java/fr/reseaumexico/model/event/InputDesignScenarioEvent.java 2012-01-04 10:55:47 UTC (rev 17) +++ trunk/jmexico-model/src/main/java/fr/reseaumexico/model/event/InputDesignScenarioEvent.java 2012-01-04 13:58:53 UTC (rev 18) @@ -29,6 +29,8 @@ import java.util.EventObject; /** + * Event fired when {@link Scenario} change on {@link InputDesign} + * * @author sletellier <letellier@codelutin.com> * @since 0.1 */ Modified: trunk/jmexico-model/src/main/java/fr/reseaumexico/model/event/ScenarioFactorValueEvent.java =================================================================== --- trunk/jmexico-model/src/main/java/fr/reseaumexico/model/event/ScenarioFactorValueEvent.java 2012-01-04 10:55:47 UTC (rev 17) +++ trunk/jmexico-model/src/main/java/fr/reseaumexico/model/event/ScenarioFactorValueEvent.java 2012-01-04 13:58:53 UTC (rev 18) @@ -28,6 +28,8 @@ import java.util.EventObject; /** + * Event fired when {@link fr.reseaumexico.model.Factor} change on {@link Scenario} + * * @author sletellier <letellier@codelutin.com> * @since 0.1 */ Modified: trunk/jmexico-model/src/main/java/fr/reseaumexico/model/parser/ExperimentDesignParser.java =================================================================== --- trunk/jmexico-model/src/main/java/fr/reseaumexico/model/parser/ExperimentDesignParser.java 2012-01-04 10:55:47 UTC (rev 17) +++ trunk/jmexico-model/src/main/java/fr/reseaumexico/model/parser/ExperimentDesignParser.java 2012-01-04 13:58:53 UTC (rev 18) @@ -77,6 +77,8 @@ import static fr.reseaumexico.model.MexicoXmlConstant.LEVEL_WEIGHT; /** + * Parser for experiment design xml files, build a {@link ExperimentDesign} model + * * @author sletellier <letellier@codelutin.com> * @since 0.1 */ Modified: trunk/jmexico-model/src/main/java/fr/reseaumexico/model/parser/InputDesignParser.java =================================================================== --- trunk/jmexico-model/src/main/java/fr/reseaumexico/model/parser/InputDesignParser.java 2012-01-04 10:55:47 UTC (rev 17) +++ trunk/jmexico-model/src/main/java/fr/reseaumexico/model/parser/InputDesignParser.java 2012-01-04 13:58:53 UTC (rev 18) @@ -51,6 +51,8 @@ import static fr.reseaumexico.model.MexicoXmlConstant.SCENARIO_ORDER_NUMBER; /** + * Parser for input design xml files, build a {@link InputDesign} model + * * @author sletellier <letellier@codelutin.com> * @since 0.1 */ Modified: trunk/jmexico-model/src/main/java/fr/reseaumexico/model/parser/MexicoXmlParser.java =================================================================== --- trunk/jmexico-model/src/main/java/fr/reseaumexico/model/parser/MexicoXmlParser.java 2012-01-04 10:55:47 UTC (rev 17) +++ trunk/jmexico-model/src/main/java/fr/reseaumexico/model/parser/MexicoXmlParser.java 2012-01-04 13:58:53 UTC (rev 18) @@ -31,6 +31,8 @@ import java.util.Date; /** + * Abstract parser to get model from xml file using XPP3 for mexico + * * @author sletellier <letellier@codelutin.com> * @since 0.1 */ Modified: trunk/jmexico-model/src/main/java/fr/reseaumexico/model/parser/XmlParser.java =================================================================== --- trunk/jmexico-model/src/main/java/fr/reseaumexico/model/parser/XmlParser.java 2012-01-04 10:55:47 UTC (rev 17) +++ trunk/jmexico-model/src/main/java/fr/reseaumexico/model/parser/XmlParser.java 2012-01-04 13:58:53 UTC (rev 18) @@ -38,6 +38,7 @@ * * @author sletellier <letellier@codelutin.com> * @since 0.1 + * @see XmlPullParser */ public abstract class XmlParser<M> extends FileReader { Modified: trunk/jmexico-model/src/main/java/fr/reseaumexico/model/writer/InputDesignXmlWriter.java =================================================================== --- trunk/jmexico-model/src/main/java/fr/reseaumexico/model/writer/InputDesignXmlWriter.java 2012-01-04 10:55:47 UTC (rev 17) +++ trunk/jmexico-model/src/main/java/fr/reseaumexico/model/writer/InputDesignXmlWriter.java 2012-01-04 13:58:53 UTC (rev 18) @@ -41,7 +41,7 @@ import static fr.reseaumexico.model.MexicoXmlConstant.SCENARIO_ORDER_NUMBER; /** - * Writer to create input design file with {@link fr.reseaumexico.model.InputDesign} model + * Writer to create input design file with {@link InputDesign} model * * @author sletellier <letellier@codelutin.com> * @since 0.1 Modified: trunk/jmexico-swing-editor/src/main/resources/i18n/jmexico-swing-editor_en_GB.properties =================================================================== --- trunk/jmexico-swing-editor/src/main/resources/i18n/jmexico-swing-editor_en_GB.properties 2012-01-04 10:55:47 UTC (rev 17) +++ trunk/jmexico-swing-editor/src/main/resources/i18n/jmexico-swing-editor_en_GB.properties 2012-01-04 13:58:53 UTC (rev 18) @@ -1,14 +1,14 @@ -jmexico.add.scenario=Ajout d'un scenario +jmexico.add.scenario=Add a scenario jmexico.error.scenario.name.used=Error \: scenario name '%1$s' is already used. jmexico.error.title=Error jmexico.factor.name=Factor jmexico.file.open.dialog=Open an InputDesign file. -jmexico.input.msg= +jmexico.input.msg=New value jmexico.menu.file=File jmexico.menu.file.open=Open jmexico.menu.file.save=Save -jmexico.remove.scenario=Suppression d'un scenario +jmexico.remove.scenario=Delete a scenario jmexico.scenario.inputName=Name of scenario to add \: -jmexico.scenario.inputName.title= -jmexico.scenario.selectRemove= -jmexico.scenario.selectRemove.title= +jmexico.scenario.inputName.title=Input a name for scenario to add +jmexico.scenario.selectRemove=Select scenario to delete +jmexico.scenario.selectRemove.title=Select scenario to remove Modified: trunk/jmexico-swing-editor/src/main/resources/i18n/jmexico-swing-editor_fr_FR.properties =================================================================== --- trunk/jmexico-swing-editor/src/main/resources/i18n/jmexico-swing-editor_fr_FR.properties 2012-01-04 10:55:47 UTC (rev 17) +++ trunk/jmexico-swing-editor/src/main/resources/i18n/jmexico-swing-editor_fr_FR.properties 2012-01-04 13:58:53 UTC (rev 18) @@ -3,12 +3,12 @@ jmexico.error.title=Erreur jmexico.factor.name=Facteur jmexico.file.open.dialog=Ouvrir un fichier InputDesign -jmexico.input.msg= +jmexico.input.msg=Nouvelle valeur jmexico.menu.file=Fichier jmexico.menu.file.open=Ouvrir jmexico.menu.file.save=Sauvegarder jmexico.remove.scenario=Suppression d'un scenario jmexico.scenario.inputName=Nom du scénario à ajouter \: -jmexico.scenario.inputName.title= -jmexico.scenario.selectRemove= -jmexico.scenario.selectRemove.title= +jmexico.scenario.inputName.title=Enter un nom pour le scenario à ajouter +jmexico.scenario.selectRemove=Selection du scénario à supprimer +jmexico.scenario.selectRemove.title=Select scenario to remove