ant-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From peterrei...@apache.org
Subject cvs commit: ant/src/main/org/apache/tools/ant/util SourceFileScanner.java
Date Mon, 24 Jan 2005 14:12:41 GMT
peterreilly    2005/01/24 06:12:41

  Modified:    src/main/org/apache/tools/ant/util SourceFileScanner.java
  Log:
  javadoc
  
  Revision  Changes    Path
  1.29      +26 -8     ant/src/main/org/apache/tools/ant/util/SourceFileScanner.java
  
  Index: SourceFileScanner.java
  ===================================================================
  RCS file: /home/cvs/ant/src/main/org/apache/tools/ant/util/SourceFileScanner.java,v
  retrieving revision 1.28
  retrieving revision 1.29
  diff -u -r1.28 -r1.29
  --- SourceFileScanner.java	6 Jan 2005 12:05:08 -0000	1.28
  +++ SourceFileScanner.java	24 Jan 2005 14:12:40 -0000	1.29
  @@ -50,12 +50,13 @@
        * Restrict the given set of files to those that are newer than
        * their corresponding target files.
        *
  -     * @param files   the original set of files
  -     * @param srcDir  all files are relative to this directory
  +     * @param files   the original set of files.
  +     * @param srcDir  all files are relative to this directory.
        * @param destDir target files live here. if null file names
        *                returned by the mapper are assumed to be absolute.
        * @param mapper  knows how to construct a target file names from
        *                source file names.
  +     * @return an array of filenames.
        */
       public String[] restrict(String[] files, File srcDir, File destDir,
                                FileNameMapper mapper) {
  @@ -67,14 +68,15 @@
        * Restrict the given set of files to those that are newer than
        * their corresponding target files.
        *
  -     * @param files   the original set of files
  -     * @param srcDir  all files are relative to this directory
  +     * @param files   the original set of files.
  +     * @param srcDir  all files are relative to this directory.
        * @param destDir target files live here. if null file names
        *                returned by the mapper are assumed to be absolute.
        * @param mapper  knows how to construct a target file names from
        *                source file names.
        * @param granularity The number of milliseconds leeway to give
        *                    before deciding a target is out of date.
  +     * @return an array of filenames.
        *
        * @since Ant 1.6.2
        */
  @@ -104,9 +106,16 @@
       }
   
       /**
  -     * Convinience layer on top of restrict that returns the source
  +     * Convenience layer on top of restrict that returns the source
        * files as File objects (containing absolute paths if srcDir is
        * absolute).
  +     * @param files   the original set of files.
  +     * @param srcDir  all files are relative to this directory.
  +     * @param destDir target files live here. if null file names
  +     *                returned by the mapper are assumed to be absolute.
  +     * @param mapper  knows how to construct a target file names from
  +     *                source file names.
  +     * @return an array of files.
        */
       public File[] restrictAsFiles(String[] files, File srcDir, File destDir,
                                     FileNameMapper mapper) {
  @@ -119,6 +128,15 @@
        * files as File objects (containing absolute paths if srcDir is
        * absolute).
        *
  +     * @param files   the original set of files.
  +     * @param srcDir  all files are relative to this directory.
  +     * @param destDir target files live here. if null file names
  +     *                returned by the mapper are assumed to be absolute.
  +     * @param mapper  knows how to construct a target file names from
  +     *                source file names.
  +     * @param granularity The number of milliseconds leeway to give
  +     *                    before deciding a target is out of date.
  +     * @return an array of files.
        * @since Ant 1.6.2
        */
       public File[] restrictAsFiles(String[] files, File srcDir, File destDir,
  @@ -132,9 +150,9 @@
       }
   
       /**
  -     * returns resource information for a file at destination
  -     * @param name relative path of file at destination
  -     * @return data concerning a file whose relative path to destDir is name
  +     * Returns resource information for a file at destination.
  +     * @param name relative path of file at destination.
  +     * @return data concerning a file whose relative path to destDir is name.
        *
        * @since Ant 1.5.2
        */
  
  
  

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@ant.apache.org
For additional commands, e-mail: dev-help@ant.apache.org


Mime
View raw message