diff options
Diffstat (limited to 'docs/manual/ant.html')
| -rw-r--r-- | docs/manual/ant.html | 110 |
1 files changed, 72 insertions, 38 deletions
diff --git a/docs/manual/ant.html b/docs/manual/ant.html index bc3a3b4..0837bbb 100644 --- a/docs/manual/ant.html +++ b/docs/manual/ant.html @@ -1,10 +1,21 @@ -<!doctype html PUBLIC "-//W3C//DTD HTML 3.2 Final//EN"> +<!doctype html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> <html> <head> <meta http-equiv="content-type" content="text/html; charset=iso-8859-1"> <meta http-equiv="content-style-type" content="text/css"> <link rel="stylesheet" type="text/css" href="style.css"> <title>Ant Task</title> +<script type="text/javascript" language="JavaScript"> +<!-- +if (window.self==window.top) + window.top.location.replace("../index.html#"+window.location.pathname+window.location.hash); +else { + var hash="#"+window.location.pathname.replace(window.top.location.pathname.replace("index.html", ""), ""); + if (window.top.location.hash!=hash) + window.top.location.hash=hash; +} +//--> +</script> </head> <body> @@ -28,10 +39,14 @@ this new task. The easiest way is to add the following line to your Please make sure the class path is set correctly for your system. <p> -There are three ways to configure the ProGuard task: using an external -configuration file, using embedded ProGuard configuration options, or using -the equivalent XML configuration tags. These three ways can be combined, -depending on practical circumstances and personal preference. +There are three ways to configure the ProGuard task: +<ol> +<li>using an external configuration file,</li> +<li>using embedded ProGuard configuration options, or</li> +<li>using the equivalent XML configuration tags.</li> +</ol> +These three ways can be combined, depending on practical circumstances and +personal preference. <p> <h3>1. An external ProGuard configuration file</h3> @@ -89,11 +104,11 @@ can be removed. <p> Secondly, the use of <code><</code> and <code>></code> characters would -upset the structure of the XML build file. Environment variables are now -enclosed by an opening <code>${</code> and a closing <code>}</code>. This -syntax also allows you to use Ant properties within the ProGuard -configuration. Other occurrences of <code><</code> and <code>></code> -have to be encoded as <code>&lt;</code> and <code>&gt;</code>. +upset the structure of the XML build file. Environment variables can be +specified with the usual Ant style <code>${...}</code>, instead of the ProGuard +style <code><...></code>. Other occurrences of <code><</code> and +<code>></code> have to be encoded as <code>&lt;</code> and +<code>&gt;</code> respectively. <p> <h3>3. XML configuration tags</h3> @@ -107,8 +122,7 @@ href="usage.html">Usage</a> section. You can find some sample configuration files in the <code>examples/ant</code> directory of the ProGuard distribution. <p> -<a name="proguard"> </a> -<h2>Task Attributes and Nested Elements</h2> +<h2><a name="proguard">Task Attributes and Nested Elements</a></h2> The <code><b><proguard></b></code> task and the <code><b><proguardconfiguration></b></code> task can have the following @@ -120,13 +134,14 @@ elements: <dt><a name="configuration_attribute"><code><b>configuration</b></code></a> = "<i>filename</i>"</dt> <dd>Read and merge options from the given ProGuard-style configuration - file. Note: for reading XML-style configurations, use the <a + file. Note: for reading multiple configuration files or XML-style + configurations, use the <a href="#configuration_element"><code>configuration</code></a> <i>element</i>.</dd> -<dt><a href="usage.html#dontskipnonpubliclibraryclasses"><code><b>skipnonpubliclibraryclasses</b></code></a> +<dt><a href="usage.html#skipnonpubliclibraryclasses"><code><b>skipnonpubliclibraryclasses</b></code></a> = "<i>boolean</i>" - (default = true)</dt> + (default = false)</dt> <dd>Ignore non-public library classes.</dd> <dt><a href="usage.html#dontskipnonpubliclibraryclassmembers"><code><b>skipnonpubliclibraryclassmembers</b></code></a> @@ -242,6 +257,11 @@ elements: <dd>Repackage all class files that are renamed into the single given package.</dd> +<dt><a href="usage.html#keepparameternames"><code><b>keepparameternames</b></code></a> + = "<i>boolean</i>" + (default = false)</dt> +<dd>Keep the parameter names and types of methods that are kept.</dd> + <dt><a href="usage.html#renamesourcefileattribute"><code><b>renamesourcefileattribute</b></code></a> = "<i>string</i>" (default = none)</dt> @@ -257,7 +277,7 @@ elements: <dt><a href="usage.html#microedition"><code><b>microedition</b></code></a> = "<i>boolean</i>" (default = false)</dt> -<dd>Targets the processed class files at Java Micro Edition.</dd> +<dd>Target the processed class files at Java Micro Edition.</dd> <dt><a href="usage.html#verbose"><code><b>verbose</b></code></a> = "<i>boolean</i>" @@ -305,7 +325,7 @@ elements: <dt><a href="usage.html#outjars"><code><b><outjar</b></code></a> <a href="#classpath"><i>class_path</i></a> <code><b>/></b></code></dt> -<dd>Specifies the name of the output jars (or wars, ears, zips, or +<dd>Specifies the names of the output jars (or wars, ears, zips, or directories).</dd> <dt><a href="usage.html#libraryjars"><code><b><libraryjar</b></code></a> @@ -436,23 +456,27 @@ elements: filter. <i>Only use this option if you know what you're doing!</i></dd> <dt><a name="configuration_element"><code><b><configuration refid = </b></code></a>"<i>ref_id</i>" + <code><b>/></b></code><br/> + <code><b><configuration file = </b></code>"<i>name</i>" <code><b>/></b></code></dt> -<dd>Includes the configuration specified in the +<dd>The first form includes the XML-style configuration specified in a <code><proguardconfiguration></code> task (or - <code><proguard></code> task) with the attribute <code>id</code> = - "<i>ref_id</i>". Note that only the nested elements of this configuration - are considered, not the attributes. Also note: for reading ProGuard-style - configuration files, use the <a - href="#configuration_attribute"><code>configuration</code></a> - <i>attribute</i>.</dd> + <code><proguard></code> task) with attribute <code>id</code> = + "<i>ref_id</i>". Only the nested elements of this configuration are + considered, not the attributes. + <p> + The second form includes the ProGuard-style configuration from the specified + file. The element is actually a <code>fileset</code> element and supports + all of its attributes and nested elements, including multiple files. + </dd> </dl> -<a name="classpath"> </a> -<h2>Class Path Attributes and Nested Elements</h2> +<h2><a name="classpath">Class Path Attributes and Nested Elements</a></h2> -The jar tags are path tags, so they can have any of the path attributes (or -nested elements). The most common attributes are: +The jar elements are <code>path</code> elements, so they can have any of the +standard <code>path</code> attributes and nested elements. The most common +attributes are: <dl> @@ -472,7 +496,7 @@ nested elements). The most common attributes are: </dl> -In addition, the jar tags can have ProGuard-style filter attributes: +In addition, the jar elements can have ProGuard-style filter attributes: <dl> @@ -499,8 +523,7 @@ In addition, the jar tags can have ProGuard-style filter attributes: </dl> -<a name="keepmodifier"> </a> -<h2>Keep Modifier Attributes</h2> +<h2><a name="keepmodifier">Keep Modifier Attributes</a></h2> The keep tags can have the following <i>modifier</i> attributes: @@ -526,8 +549,7 @@ The keep tags can have the following <i>modifier</i> attributes: </dl> -<a name="classspecification"> </a> -<h2>Class Specification Attributes and Nested Elements</h2> +<h2><a name="classspecification">Class Specification Attributes and Nested Elements</a></h2> The keep tags can have the following <i>class_specification</i> attributes and <i>class_member_specifications</i> nested elements: @@ -538,6 +560,10 @@ The keep tags can have the following <i>class_specification</i> attributes and <dd>The optional access modifiers of the class. Any space-separated list of "public", "final", and "abstract", with optional negators "!".</dd> +<dt><code><b>annotation</b></code> = "<i>annotation_name</i>"</dt> +<dd>The optional fully qualified name of an annotation of the class, with + optional wildcards.</dd> + <dt><code><b>type</b></code> = "<i>type</i>"</dt> <dd>The optional type of the class: one of "class", "interface", or "!interface".</dd> @@ -546,6 +572,10 @@ The keep tags can have the following <i>class_specification</i> attributes and <dd>The optional fully qualified name of the class, with optional wildcards.</dd> +<dt><code><b>extendsannotation</b></code> = "<i>annotation_name</i>"</dt> +<dd>The optional fully qualified name of an annotation of the the class that + the specified classes must extend, with optional wildcards.</dd> + <dt><code><b>extends</b></code> = "<i>class_name</i>"</dt> <dd>The optional fully qualified name of the class the specified classes must extend, with optional wildcards.</dd> @@ -571,8 +601,7 @@ The keep tags can have the following <i>class_specification</i> attributes and </dl> -<a name="classmemberspecification"> </a> -<h2>Class Member Specification Attributes</h2> +<h2><a name="classmemberspecification">Class Member Specification Attributes</a></h2> The class member tags can have the following <i>class_member_specification</i> attributes: @@ -584,6 +613,10 @@ attributes: "public", "protected", "private", "static", etc., with optional negators "!".</dd> +<dt><code><b>annotation</b></code> = "<i>annotation_name</i>"</dt> +<dd>The optional fully qualified name of an annotation of the class member, + with optional wildcards.</dd> + <dt><code><b>type</b></code> = "<i>type</i>"</dt> <dd>The optional fully qualified type of the class member, with optional wildcards. Not applicable for constructors, but required for methods for @@ -601,10 +634,11 @@ attributes: </dl> -<hr> +<hr /> +<noscript><div><a target="_top" href="../index.html" class="button">Show menu</a></div></noscript> <address> -Copyright © 2002-2009 -<a href="http://www.graphics.cornell.edu/~eric/">Eric Lafortune</a>. +Copyright © 2002-2013 +<a target="other" href="http://www.lafortune.eu/">Eric Lafortune</a>. </address> </body> </html> |