Package fr.ifremer.isisfish.util

Class JavadocHelper

java.lang.Object
fr.ifremer.isisfish.util.JavadocHelper
public class JavadocHelper extends Object
Helper for javadoc. Use "javadoc" executable tools located in JAVA_HOME.
Since:
3.2.0.4
Version:
$Revision$ Last update: $Date$ by : $Author$
Author:
chatellier
See Also:

  • Constructor Details

    • JavadocHelper

      public JavadocHelper()

  • Method Details

    • generateJavadoc

      public static int generateJavadoc(JavaSourceStorage source, File destDir, boolean force, PrintWriter out)
      Generate javadoc of current.
      Parameters:
      source - source storage
      destDir - javadoc destination directory
      force - force (if html file is newer than java file)
      out - out writer (javadoc output, can be null)
      Returns:
      javadoc tool result

    • generateJavadoc

      public static int generateJavadoc(File rootSrc, File dest, PrintWriter out)
      Generate javadoc on all java file in a directory.
      Parameters:
      rootSrc - le repertoire de toutes les sources
      dest - le répertoire de destination de la javadoc
      out - le flux de sortie (peut etre null)
      Returns:
      le resulat de sortie de l'executable javadoc (0 si ok)

    • generateJavadoc

      public static int generateJavadoc(File rootSrc, File fileSrc, File dest, PrintWriter out)
      Generate single file javadoc.
      Parameters:
      rootSrc - le repertoire de toutes les sources
      fileSrc - le fichier dont on veut la javadoc
      dest - le répertoire de destination de la javadoc
      out - le flux de sortie (peut etre null)
      Returns:
      le resulat de sortie de l'executable javadoc (0 si ok)

    • generateJavadoc

      public static int generateJavadoc(File rootSrc, Collection<File> filesSrc, File dest, PrintWriter out)
      Generate file collection javadoc.
      Parameters:
      rootSrc - le repertoire de toutes les sources
      filesSrc - les fichiers dont on veut la javadoc
      dest - le répertoire de destination de la javadoc
      out - le flux de sortie (peut etre null)
      Returns:
      le resulat de sortie de l'executable javadoc (0 si ok)

    • generateJavadoc

      protected static int generateJavadoc(List<File> classpath, Collection<File> filesSrc, File dest, PrintWriter out)
      Generate file collection javadoc.
      Parameters:
      classpath - common classpath
      filesSrc - les fichiers dont on veut la javadoc
      dest - le répertoire de destination de la javadoc
      out - le flux de sortie (peut etre null)
      Returns:
      le resulat de sortie de l'executable javadoc (0 si ok)