diff --git a/docs/manual/CoreTasks/typedef.html b/docs/manual/CoreTasks/typedef.html index bde94f70a..4ba98a07a 100644 --- a/docs/manual/CoreTasks/typedef.html +++ b/docs/manual/CoreTasks/typedef.html @@ -15,8 +15,8 @@ such that this new type or task can be used in the current project.

- Tasks are any class that extend org.apache.tools.ant.Task or - a class that is adapted to a Task using an adapter class. + A Task is any class that extends org.apache.tools.ant.Task or + can be adapted as a Task using an adapter class.

Data types are things like paths or @@ -25,10 +25,9 @@ Custom data types usually need custom tasks to put them to good use.

- Two attributes are needed to make a definition, - the name that identifies this data type uniquely, and the full - name of the class (including the packages) that implements this - type. + Two attributes are needed to make a definition: the name that + identifies this data type uniquely, and the full name of the class + (including its package name) that implements this type.

You can also define a group of definitions at once using the file or @@ -44,8 +43,7 @@

The xml format is described in the - Antlib - section. + Antlib section.

Parameters

@@ -64,7 +62,7 @@ classname the full class name implementing the data type - Yes, unless file or resource + Yes, unless file or resource have been specified. @@ -75,10 +73,10 @@ resource - Name of the resource to load definitions from. - If there is multiple resources of this name in the classpath, and the - format is "properties", the first resource will be loaded, otherwise - all the resources will be loaded. + Name of the resource to load definitions from. + If multiple resources by this name are found along the classpath, + and the format is "properties", the first resource will be loaded; + otherwise all such resources will be loaded. No @@ -88,41 +86,42 @@ are "properties" or "xml". If the value is "properties" the file/resource is a property file contains name to classname pairs. If the value is "xml", the file/resource is an xml file/resource structured according - to Antlib. + to Antlib. The default is "properties" unless the file/resource name ends with ".xml", in which case the format attribute will have the value "xml". - (introduced in ant1.6) + since Ant 1.6 No classpath the classpath to - use when looking up classname. No + use when looking up classname. + No classpathref - a reference to a classpath to use when looking up classname. + a reference to a classpath to use when looking up classname. + No - loaderRef the name of the loader that is - used to load the class, constructed from the specified classpath. Use this to - allow multiple tasks/types to be loaded with the same loader, so they can call - each other. ( introduced in ant1.5 ) + loaderRef + the name of the loader that is + used to load the class, constructed from the specified classpath. Use + this to allow multiple tasks/types to be loaded with the same loader, + so they can call each other. since Ant 1.5 No onerror The action to take if there was a failure in defining the - type. The values are fail - cause a build exception, report, - output a warning, but continue, ignore, do nothing. - (introduced in ant1.6) - An additional value is failall - causes all behavior of fail but also - causes a build exception for the resource or file attribute - if the resource or file is not found. - (introduced in ant1.7) + type. The values are fail: cause a build exception; report: + output a warning, but continue; ignore: do nothing. + since Ant 1.6 + An additional value is failall: cause all behavior of fail, + as well as a build exception for the resource or file attribute + if the resource or file is not found. since Ant 1.7 The default is fail. No @@ -134,9 +133,8 @@ "org.apache.tools.ant.TypeAdapter". The adapter class will be used to wrap the defined class unless the defined class implements/extends the class defined by the attribute "adaptto". - If "adaptto" is not set, - the defined class will always be wrapped. - (introduced in ant1.6) + If "adaptto" is not set, the defined class will always be wrapped. + since Ant 1.6 No @@ -146,8 +144,7 @@ adapter attribute. If the defined class does not implement/extend the interface/class specified by this attribute, the adaptor class will be used - to wrap the class. - (introduced in ant1.6) + to wrap the class. since Ant 1.6 No @@ -155,7 +152,7 @@ uri The uri that this definition should live in. - since Ant1.6 + since Ant 1.6 No @@ -163,7 +160,7 @@

Parameters specified as nested elements

classpath

Typedef's classpath attribute is a - PATH like structure and can also be set + path-like structure and can also be set via a nested classpath element.

Examples

@@ -177,7 +174,7 @@ extends Task and implements org.apache.tools.ant.TypeAdapter, and in the execute method invokes run on the proxied object, one may use a Runnable class as an Ant task. The following fragment - defines a task called runclock. + defines a task called runclock. 

     <typedef name="runclock"