diff --git a/docs/index.html b/docs/index.html index 738f002f0..72f61539f 100644 --- a/docs/index.html +++ b/docs/index.html @@ -299,12 +299,10 @@ task attributes. This is done by placing the property name between "build", then this could be used in an attribute like this: "${builddir}/classes". This is resolved as "build/classes".

Token Filters

-

A project can have a set of tokens that will be automatically expanded if -found when a file is copied. These might be set in the buildfile -by the filter task. If no filter task is specified, all -file copying works normally and the files are not modified during the copy in -any way. Otherwise, if a filter is set, the files will be filtered and -each occurrency of the specified token will be replaced.

+

A project can have a set of tokens that might be automatically expanded if +found when a file is copied, when the filtering-copy behavior is selected in the +tasks that support this. These might be set in the buildfile +by the filter task. 

Since this can be a very harmful behavior, the tokens in the files must be of the form @token@ where token is the token name that is set in the filter task. This token syntax matches the syntax of other build systems @@ -330,7 +328,7 @@ this should not cause problems.

</target> <target name="compile" depends="prepare"> - <javac srcdir="${src}" destdir="${build}" /> + <javac srcdir="${src}" destdir="${build}" filtering="on"/> </target> <target name="dist" depends="compile"> @@ -636,6 +634,12 @@ this attribute has been replaced by the excludes attribute.

("yes"/"no"). Default excludes are used when omitted. No + + filtering + indicates whether token filtering should take place during + the copy + No +

Examples

  <copydir src="${src}/resources"
@@ -679,6 +683,12 @@ does not exist.

     the filename of the file where to copy to.
     Yes
   
+  
+    filtering
+    indicates whether token filtering should take place during
+      the copy
+    No
+  
 
 
Examples

 

@@ -1041,13 +1051,13 @@ archive with http/ftp.

 
 
Examples

 
  <fixcrlf srcdir="${src}"
-       cr="remove" eof="remove"
+       cr="remove" eof="remove"
        includes="**/*.sh"
   />

 
Removes carriage return and eof characters from the shell scripts.  Tabs and
 spaces are left as is.
 
  <fixcrlf srcdir="${src}"
-       cr="add"
+       cr="add"
        includes="**/*.bat"
   />

 
Ensures that there are carriage return characters prior to evey line feed.
@@ -1055,7 +1065,7 @@ Tabs and spaces are left as is.
 EOF characters are left alone if run on
 DOS systems, and are removed if run on Unix systems.

 
  <fixcrlf srcdir="${src}"
-       tabs="add"
+       tabs="add"
        includes="**/Makefile"
   />

 
Adds or removes CR characters to match local OS conventions, and
@@ -1063,7 +1073,7 @@ converts spaces to tabs when appropriate.  EOF characters are left alone if
 run on DOS systems, and are removed if run on Unix systems.
 Many versions of make require tabs prior to commands.

 
  <fixcrlf srcdir="${src}"
-       tabs="remove"
+       tabs="remove"
        includes="**/README*"
   />

 
Adds or removes CR characters to match local OS conventions, and
@@ -1326,6 +1336,11 @@ relative to the srcdir directory.

       information ("on").
     No
   
+  
+    filtering
+    indicates whether token filtering should take place
+    No
+  
 
 
Examples

 
  <javac srcdir="${src}"
@@ -1384,13 +1399,13 @@ instead.

     sourcepath
     Specify where to find source files
     all
-    yes
+    Yes
   
   
     destdir
     Destination directory for output files
     all
-    yes
+    Yes
   
   
     sourcefiles
@@ -1408,217 +1423,217 @@ instead.

     Classpath
     Specify where to find user class files
     all
-    no
+    No
   
   
     Bootclasspath
     Override location of class files loaded by the bootstrap
       class loader
     1.2
-    no
+    No
   
   
     Extdirs
     Override location of installed extensions
     1.2
-    no
+    No
   
   
     Overview
     Read overview documentation from HTML file
     1.2
-    no
+    No
   
   
     Public
     Show only public classes and members
     all
-    no
+    No
   
   
     Protected
     Show protected/public classes and members (default)
     all
-    no
+    No
   
   
     Package
     Show package/protected/public classes and members
     all
-    no
+    No
   
   
     Private
     Show all classes and members
     all
-    no
+    No
   
   
     Old
     Generate output using JDK 1.1 emulating doclet
     1.2
-    no
+    No
   
   
     Verbose
     Output messages about what Javadoc is doing
     1.2
-    no
+    No
   
   
     Locale
     Locale to be used, e.g. en_US or en_US_WIN
     1.2
-    no
+    No
   
   
     Encoding
     Source file encoding name
     all
-    no
+    No
   
   
     Version
     Include @version paragraphs
     all
-    no
+    No
   
   
     Use
     Create class and package usage pages
     1.2
-    no
+    No
   
   
     Author
     Include @author paragraphs
     all
-    no
+    No
   
   
     Splitindex
     Split index into one file per letter
     1.2
-    no
+    No
   
   
     Windowtitle
     Browser window title for the documenation (text)
     1.2
-    no
+    No
   
   
     Doctitle
     Include title for the package index(first) page (html-code)
     1.2
-    no
+    No
   
   
     Header
     Include header text for each page (html-code)
     1.2
-    no
+    No
   
   
     Footer
     Include footer text for each page (html-code)
     1.2
-    no
+    No
   
   
     bottom
     Include bottom text for each page (html-code)
     1.2
-    no
+    No
   
   
     link
     Create links to javadoc output at the given URL
     1.2
-    no
+    No
   
   
     linkoffline
     Link to docs at <url> using package list at
       <url2>
     1.2
-    no
+    No
   
   
     group
     Group specified packages together in overview page
     1.2
-    no
+    No
   
   
     nodeprecated
     Do not include @deprecated information
     all
-    no
+    No
   
   
     nodeprecatedlist
     Do not generate deprecated list
     1.2
-    no
+    No
   
   
     notree
     Do not generate class hierarchy
     all
-    no
+    No
   
   
     noindex
     Do not generate index
     all
-    no
+    No
   
   
     nohelp
     Do not generate help link
     1.2
-    no
+    No
   
   
     nonavbar
     Do not generate navigation bar
     1.2
-    no
+    No
   
   
     serialwarn
     Generate warning about @serial tag
     1.2
-    no
+    No
   
   
     helpfile
     Specifies the HTML help file to use
     1.2
-    no
+    No
   
   
     stylesheetfile
     Specifies the CSS stylesheet to use
     1.2
-    no
+    No
   
   
     charset
     Charset for cross-platform viewing of generated
       documentation
     1.2
-    no
+    No
   
   
     docencoding
     Output file encoding name
     1.1
-    no
+    No
   
 
-
Examples

+
Example

 
  <javadoc packagenames="com.dummy.test.*"
            sourcepath="src"
            destdir="docs/api"
@@ -1806,6 +1821,11 @@ This also holds for properties loaded from a property file.

     the class for which to run rmic.
     Yes
   
+  
+    filtering
+    indicates whether token filtering should take place
+    No
+  
 
 
Examples

 
  <rmic class="com.xyz.FooBar" base="${build}/classes" />