Author: chatellier Date: 2009-09-02 13:47:17 +0000 (Wed, 02 Sep 2009) New Revision: 2575 Modified: isis-fish/trunk/src/main/java/fr/ifremer/isisfish/export/Export.java isis-fish/trunk/src/main/java/fr/ifremer/isisfish/export/ExportHelper.java Log: Update export doc. Modified: isis-fish/trunk/src/main/java/fr/ifremer/isisfish/export/Export.java =================================================================== --- isis-fish/trunk/src/main/java/fr/ifremer/isisfish/export/Export.java 2009-09-02 13:28:25 UTC (rev 2574) +++ isis-fish/trunk/src/main/java/fr/ifremer/isisfish/export/Export.java 2009-09-02 13:47:17 UTC (rev 2575) @@ -24,7 +24,7 @@ import fr.ifremer.isisfish.datastore.SimulationStorage; /** - * Interface que doivent implanter les classes d'export de resultats + * Interface que doivent implanter les classes d'export de resultats. * * Le nom du fichier d'export qui sera utilisé sera le basé sur le nom de la * classe d'export @@ -40,30 +40,35 @@ public interface Export { /** + * Necessary results names for export execution. + * * @return the necessaryResult name */ public String[] getNecessaryResult(); /** - * Return Export description + * Return Export description. + * * @return string displayable to the end user */ public String getDescription(); /** - * Return filename used to contains export data + * Return filename used to contains export data. + * * @return filename by example "myexport" */ public String getExportFilename(); /** - * Return extension used as filename name extension + * Return extension used as filename name extension. + * * @return extension by example ".csv" */ public String getExtensionFilename(); /** - * Exporte les resultat + * Exporte les resultat. * * @param simulation la simulation dont on souhaite exporter les resultats * @param out la sortie sur lequel il faut ecrire l'export Modified: isis-fish/trunk/src/main/java/fr/ifremer/isisfish/export/ExportHelper.java =================================================================== --- isis-fish/trunk/src/main/java/fr/ifremer/isisfish/export/ExportHelper.java 2009-09-02 13:28:25 UTC (rev 2574) +++ isis-fish/trunk/src/main/java/fr/ifremer/isisfish/export/ExportHelper.java 2009-09-02 13:47:17 UTC (rev 2575) @@ -38,7 +38,7 @@ import fr.ifremer.isisfish.util.ConverterUtil; /** - * Export helper. + * Helper for exports manipulation. * * Created: 20 janv. 2006 01:52:04 *