Author: fdesbois Date: 2010-01-17 21:55:45 +0100 (Sun, 17 Jan 2010) New Revision: 799 Modified: trunk/eugene/src/main/java/org/nuiton/eugene/Template.java trunk/eugene/src/main/java/org/nuiton/eugene/Transformer.java trunk/eugene/src/main/java/org/nuiton/eugene/java/ImportsManagerExtension.java Log: Improve javadoc Modified: trunk/eugene/src/main/java/org/nuiton/eugene/Template.java =================================================================== --- trunk/eugene/src/main/java/org/nuiton/eugene/Template.java 2010-01-17 20:50:08 UTC (rev 798) +++ trunk/eugene/src/main/java/org/nuiton/eugene/Template.java 2010-01-17 20:55:45 UTC (rev 799) @@ -76,7 +76,14 @@ /** Model */ protected M model; - //TODO when deprecate methods, says what to use now or why it was deprecated for + /** + * Old method from EUGene 1.0.1 used to generate files. Now, you have to use a Reader instead of + * directly use a Template. + * + * @param file list of tiles + * @param destDir destination folder + * @deprecated since 2.0.0 + */ @Deprecated public abstract void generate(File[] file, File destDir); Modified: trunk/eugene/src/main/java/org/nuiton/eugene/Transformer.java =================================================================== --- trunk/eugene/src/main/java/org/nuiton/eugene/Transformer.java 2010-01-17 20:50:08 UTC (rev 798) +++ trunk/eugene/src/main/java/org/nuiton/eugene/Transformer.java 2010-01-17 20:55:45 UTC (rev 799) @@ -72,6 +72,7 @@ * - initOutputGenerator : must be override to instanciate output Generator * - initOutputModel : must be override to instanciate output Model * </pre> + * * @param model input model * @since 2.0.0 */ @@ -90,6 +91,7 @@ /** * Initialization of the Output generator. Must be override to instanciate the Generator that will * make the generation of the Output model. + * * @return the output generator * @since 2.0.0 */ @@ -98,6 +100,7 @@ /** * Initialization of the Output model. Must be override to instanciate and initialize the output model. * For ObjectModel you can use, ObjectModelBuilder to build easily an empty ObjectModel. + * * @return the output model * @since 2.0.0 */ @@ -110,6 +113,7 @@ /** * Output properties for output generator. Initially set from build configuration. + * * @return output properties * @since 2.0.0 */ @@ -130,6 +134,7 @@ /** * Old method from previous EUGene 1.0.1 version. Used before creation of ModelReader. + * * @param file * @param destDir * @deprecated no need to manage list of files in input, prefer use input model. @@ -149,6 +154,7 @@ * on the output model of the previous one. In the simple other case, the current transformation transform the input model * into an output model. You must override {@link #initOutputModel} and {@link #initOutputTemplate } methods to initialize * output model and output template to apply (generally a generator). + * * @param model input model to transform and generate * @param destDir destination directory to put generated files * @throws IOException @@ -173,6 +179,7 @@ /** * Transformation method from an input Model. This method also initialize previous transformer, output model * and output generator with ${@link #init(org.nuiton.eugene.models.Model) } method. + * * @param model input model * @since 2.0.0 */ @@ -185,6 +192,7 @@ * Method to override for the transformation. Initialization (PreviousTransformer, OutputModel, OutputGenerator) * is made before transformation call. This method only transform an input model into an output model. * No generation is done neither outputGenerator call. + * * @since 2.0.0 */ protected abstract void transform(); Modified: trunk/eugene/src/main/java/org/nuiton/eugene/java/ImportsManagerExtension.java =================================================================== --- trunk/eugene/src/main/java/org/nuiton/eugene/java/ImportsManagerExtension.java 2010-01-17 20:50:08 UTC (rev 798) +++ trunk/eugene/src/main/java/org/nuiton/eugene/java/ImportsManagerExtension.java 2010-01-17 20:55:45 UTC (rev 799) @@ -59,6 +59,7 @@ /** * Get the ImportsManager associated to the classifier. If not exist, it will be created. + * * @param classifier reference for the ImportsManager * @return the importsManager associated to the classifier (never null) */ @@ -78,6 +79,7 @@ /** * Get imports for a classifier. The ImportsManager must be defined in the model. + * * @param classifier reference for the imports * @return a List of String which contains all imports for the classifier */