diff options
Diffstat (limited to 'src/site')
28 files changed, 3694 insertions, 0 deletions
diff --git a/src/site/apt/index.apt b/src/site/apt/index.apt new file mode 100644 index 0000000..ac4696a --- /dev/null +++ b/src/site/apt/index.apt @@ -0,0 +1,71 @@ +~~ Licensed to the Ant-Contrib Project under one or more +~~ contributor license agreements. See the NOTICE file distributed with +~~ this work for additional information regarding copyright ownership. +~~ The Ant-Contrib Project licenses this file to You under the Apache License, Version 2.0 +~~ (the "License"); you may not use this file except in compliance with +~~ the License. You may obtain a copy of the License at +~~ +~~ http://www.apache.org/licenses/LICENSE-2.0 +~~ +~~ Unless required by applicable law or agreed to in writing, software +~~ distributed under the License is distributed on an "AS IS" BASIS, +~~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +~~ See the License for the specific language governing permissions and +~~ limitations under the License. + ------ +cpptasks for Apache Ant + ------ + ------ + ------ + +cpptasks for Apache Ant + + The cc task can compile various source languages and produce executables, + shared libraries (aka DLL's) and static libraries. Compiler adaptors are currently available + for C/C++, FORTRAN, MIDL and Windows Resource compilers. + + The task can be used with Apache Ant 1.5 and later. This software is not a product + of the Apache Software Foundation (ASF) and no endorsement by the ASF is implied. + + + To use: + * Place cpptasks.jar into Ant's classpath by placing in Ant's lib directory, + adding to CLASSPATH environment variable or using the -lib command line option. + + * Add type and task definitions in build file using either taskdef or antlib. + + * Add {{{antdocs/CCTask.html}cc}} element to some target in your build file. + + * Set path and environment variables to be able to run compiler from command line. + + * Build project. + + Trivial Sample using taskdef (compatible with Ant 1.5 or later): + ++-- +<project name="hello" default="compile"> + <taskdef resource="cpptasks.tasks"/> + <target name="compile"> + <mkdir dir="target/main/obj"/> + <cc outtype="executable" subsystem="console" outfile="target/hello" objdir="target/main/obj"> + <fileset dir="src/main/c" includes="*.c"/> + </cc> + </target> +</project> ++-- + + Trivial Sample using antlib (compatible with Ant 1.6 or later): + ++-- +<project name="hello" default="compile" xmlns:cpptasks="antlib:net.sf.antcontrib.cpptasks"> + <target name="compile"> + <mkdir dir="target/main/obj"/> + <cpptasks:cc outtype="executable" subsystem="console" outfile="target/hello" objdir="target/main/obj"> + <fileset dir="src/main/c" includes="*.c"/> + </cpptasks:cc> + </target> +</project> ++-- + + More complex samples appear in src/samples. + diff --git a/src/site/site.xml b/src/site/site.xml new file mode 100644 index 0000000..ab1d7f5 --- /dev/null +++ b/src/site/site.xml @@ -0,0 +1,69 @@ +<!-- + Licensed to the Ant-Contrib Project under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The Ant-Contrib Project licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. + +--> +<project name="cpptasks: Compile tasks for Apache Ant"> + <bannerLeft> + <name>ant-contrib</name> + <href>http://ant-contrib.sourceforge.net/</href> + </bannerLeft> + <bannerRight> + <name>SourceForge.net Logo</name> + <src>http://sflogo.sourceforge.net/sflogo.php?group_id=36177&type=5</src> + <href>http://www.sourceforge.net/</href> + </bannerRight> + <body> + <breadcrumbs> + <item name="ant-contrib" href="http://ant-contrib.sourceforge.net/"/> + <item name="cpptasks" href="http://ant-contrib.sourceforge.net:80/cpptasks/"/> + </breadcrumbs> + + <menu name="Get cpptasks"> + <item name="Download" href="http://sourceforge.net/project/showfiles.php?group_id=36177"/> + <item name="Changes" href="/changes-report.html"/> + <item name="License" href="/license.html"/> + </menu> + + <menu name="About cpptasks"> + <item name="Usage" href="/index.html"/> + </menu> + + <menu name="Elements"> + <item name="cc" href="/antdocs/CCTask.html"/> + <item name="compiler" href="/antdocs/CompilerDef.html"/> + <item name="defineset" href="/antdocs/DefineSet.html"/> + <item name="distributer" href="/antdocs/DistributerDef.html"/> + <item name="libraryset" href="/antdocs/LibrarySet.html"/> + <item name="linker" href="/antdocs/LinkerDef.html"/> + <item name="syslibraryset" href="/antdocs/SystemLibrarySet.html"/> + <item name="targetplatform" href="/antdocs/TargetDef.html"/> + <item name="versioninfo" href="/antdocs/VersionInfo.html"/> + </menu> + + <menu name="Community"> + <item name="Mailing Lists" href="/mail-lists.html"/> + <item name="Issue Tracking" href="/issue-tracking.html"/> + <item name="Project Page" href="http://sourceforge.net/projects/ant-contrib/"/> + <item name="News" href="http://sourceforge.net/news/?group_id=36177"/> + </menu> + + <menu name="Development"> + <item name="Repository" href="/source-repository.html"/> + <item name="JavaDoc" href="/apidocs/index.html"/> + <item name="Continuous Integration" href="/integration.html"/> + </menu> + </body> +</project> diff --git a/src/site/xdoc/antdocs/CCTask.xml b/src/site/xdoc/antdocs/CCTask.xml new file mode 100644 index 0000000..ce994d9 --- /dev/null +++ b/src/site/xdoc/antdocs/CCTask.xml @@ -0,0 +1,534 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + +Licensed to the Ant-Contrib Project under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The Ant-Contrib Project licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. + + --> +<document xmlns:xhtml="http://www.w3.org/1999/xhtml" xmlns:taskdocs="http://ant-contrib.sf.net/taskdocs"> +<properties> +<title>cc</title> +</properties> +<body> +<section name="cc"> +<subsection name="Description">Compile and link task. + + <p> + This task can compile various source languages and produce executables, + shared libraries (aka DLL's) and static libraries. Compiler adaptors are + currently available for several C/C++ compilers, FORTRAN, MIDL and Windows + Resource files. + </p> + + <p> + Copyright (c) 2001-2008, The Ant-Contrib project. + </p> + + <p> + Licensed under the Apache Software License 2.0, + http://www.apache.org/licenses/LICENSE-2.0. + </p> + + <p> + For use with Apache Ant 1.5 or later. This software is not a product of the + of the Apache Software Foundation and no endorsement is implied. + </p> + + <p> + THIS SOFTWARE IS PROVIDED 'AS-IS', See + http://www.apache.org/licenses/LICENSE-2.0 for additional disclaimers. + </p> + + To use: + <ol> + <li> + Place cpptasks.jar into Ant's classpath by placing it in Ant's lib + directory, adding it to the CLASSPATH environment variable or by using the + -lib command line option. + </li> + <li> + Add type and task definitions to the build file: + <ul> + <li> + Ant 1.6 or later: + <ul> + <li>Add xmlns:cpptasks="antlib:net.sf.antcontrib.cpptasks" to + <project> element. + </li> + <li> + Add <cpptasks:cc/>, <cpptasks:compiler/> and + <cpptasks:linker/> elements to the project. + </li> + </ul> + </li> + <li> + Ant 1.5 or later: + <ul> + <li>Add <taskdef resource="cpptasks.tasks"/> and + <typedef resource="cpptasks.types"/> to body of <project> + element. + </li> + <li> + Add <cc/>, <compiler/> and <linker/> elements to the + project. + </li> + </ul> + </li> + </ul> + </li> + <li> + Set the path and environment variables to be able to run compiler from + command line. + </li> + <li> + Build the project. + </li> + </ol> +</subsection> +<subsection name="parameters"> +<table> +<tr> +<td> +<b>Attribute</b> +</td> +<td> +<b>Description</b> +</td> +<td> +<b>Type</b> +</td> +</tr> +<tr> +<td>classname</td> +<td>Sets the default compiler adapter. Use the "name" attribute when the + compiler is a supported compiler.</td> +<td>String</td> +</tr> +<tr> +<td>dataset</td> +<td>Sets the dataset for OS/390 builds.</td> +<td>String</td> +</tr> +<tr> +<td>debug</td> +<td>Enables or disables generation of debug info.</td> +<td>boolean</td> +</tr> +<tr> +<td>dependencydepth</td> +<td>Deprecated. + + Controls the depth of the dependency evaluation. Used to do a quick + check of changes before a full build. + + Any negative value which will perform full dependency checking. Positive + values will truncate dependency checking. A value of 0 will cause only + those files that changed to be recompiled, a value of 1 which cause + files that changed or that explicitly include a file that changed to be + recompiled. + + Any non-negative value will cause a BuildException to be thrown before + attempting a link or completing the task.</td> +<td>int</td> +</tr> +<tr> +<td>description</td> +<td></td> +<td>String</td> +</tr> +<tr> +<td>exceptions</td> +<td>Enables generation of exception handling code</td> +<td>boolean</td> +</tr> +<tr> +<td>failonerror</td> +<td>Indicates whether the build will continue + even if there are compilation errors; defaults to true.</td> +<td>boolean</td> +</tr> +<tr> +<td>incremental</td> +<td>Enables or disables incremental linking.</td> +<td>boolean</td> +</tr> +<tr> +<td>libtool</td> +<td>Set use of libtool. + + If set to true, the "libtool " will be prepended to the command line for + compatible processors</td> +<td>boolean</td> +</tr> +<tr> +<td>link</td> +<td>Sets the output file type. Supported values "executable", "shared", and + "static". Deprecated, specify outtype instead.</td> +<td> +<a href="../apidocs/net/sf/antcontrib/cpptasks/OutputTypeEnum.html">OutputTypeEnum</a> +</td> +</tr> +<tr> +<td>location</td> +<td></td> +<td>Location</td> +</tr> +<tr> +<td>multithreaded</td> +<td>Enables or disables generation of multithreaded code</td> +<td>boolean</td> +</tr> +<tr> +<td>name</td> +<td>Sets type of the default compiler and linker. + + <table> <thead>Supported compilers </thead> + <tr> + <td>gcc (default)</td> + <td>GCC C++ compiler</td> + </tr> + <tr> + <td>g++</td> + <td>GCC C++ compiler</td> + </tr> + <tr> + <td>c++</td> + <td>GCC C++ compiler</td> + </tr> + <tr> + <td>g77</td> + <td>GNU FORTRAN compiler</td> + </tr> + <tr> + <td>msvc</td> + <td>Microsoft Visual C++</td> + </tr> + <tr> + <td>bcc</td> + <td>Borland C++ Compiler</td> + </tr> + <tr> + <td>msrc</td> + <td>Microsoft Resource Compiler</td> + </tr> + <tr> + <td>brc</td> + <td>Borland Resource Compiler</td> + </tr> + <tr> + <td>df</td> + <td>Compaq Visual Fortran Compiler</td> + </tr> + <tr> + <td>midl</td> + <td>Microsoft MIDL Compiler</td> + </tr> + <tr> + <td>icl</td> + <td>Intel C++ compiler for Windows (IA-32)</td> + </tr> + <tr> + <td>ecl</td> + <td>Intel C++ compiler for Windows (IA-64)</td> + </tr> + <tr> + <td>icc</td> + <td>Intel C++ compiler for Linux (IA-32)</td> + </tr> + <tr> + <td>ecc</td> + <td>Intel C++ compiler for Linux (IA-64)</td> + </tr> + <tr> + <td>CC</td> + <td>Sun ONE C++ compiler</td> + </tr> + <tr> + <td>aCC</td> + <td>HP aC++ C++ Compiler</td> + </tr> + <tr> + <td>os390</td> + <td>OS390 C Compiler</td> + </tr> + <tr> + <td>os400</td> + <td>Icc Compiler</td> + </tr> + <tr> + <td>sunc89</td> + <td>Sun C89 C Compiler</td> + </tr> + <tr> + <td>xlC</td> + <td>VisualAge C Compiler</td> + </tr> + <tr> + <td>uic</td> + <td>Qt user interface compiler (creates .h, .cpp and moc_*.cpp files).</td> + </tr> + <tr> + <td>moc</td> + <td>Qt meta-object compiler</td> + </tr> + <tr> + <td>xpidl</td> + <td>Mozilla xpidl compiler (creates .h and .xpt files).</td> + </tr> + <tr> + <td>wcl</td> + <td>OpenWatcom C/C++ compiler</td> + </tr> + <tr> + <td>wfl</td> + <td>OpenWatcom FORTRAN compiler</td> + </tr> + </table> +</td> +<td> +<a href="../apidocs/net/sf/antcontrib/cpptasks/CompilerEnum.html">CompilerEnum</a> +</td> +</tr> +<tr> +<td>newenvironment</td> +<td>Do not propagate old environment when new environment variables are + specified.</td> +<td>boolean</td> +</tr> +<tr> +<td>objdir</td> +<td>Sets the destination directory for object files. + + Generally this should be a property expression that evaluates to + distinct debug and release object file directories.</td> +<td>File</td> +</tr> +<tr> +<td>optimize</td> +<td>Sets optimization.</td> +<td> +<a href="../apidocs/net/sf/antcontrib/cpptasks/OptimizationEnum.html">OptimizationEnum</a> +</td> +</tr> +<tr> +<td>outfile</td> +<td>Sets the output file name. If not specified, the task will only compile + files and not attempt to link. If an extension is not specified, the + task may use a system appropriate extension and prefix, for example, + outfile="example" may result in "libexample.so" being created.</td> +<td>File</td> +</tr> +<tr> +<td>outputfileproperty</td> +<td>Specifies the name of a property to set with the physical filename that + is produced by the linker</td> +<td>String</td> +</tr> +<tr> +<td>outtype</td> +<td>Sets the output file type. Supported values "executable", "shared", and + "static".</td> +<td> +<a href="../apidocs/net/sf/antcontrib/cpptasks/OutputTypeEnum.html">OutputTypeEnum</a> +</td> +</tr> +<tr> +<td>owningtarget</td> +<td></td> +<td>Target</td> +</tr> +<tr> +<td>projectsonly</td> +<td></td> +<td>boolean</td> +</tr> +<tr> +<td>rebuild</td> +<td>If set to true, all files will be rebuilt.</td> +<td>boolean</td> +</tr> +<tr> +<td>relentless</td> +<td>If set to true, compilation errors will not stop the task until all + files have been attempted.</td> +<td>boolean</td> +</tr> +<tr> +<td>rtti</td> +<td>Enables run-time type information.</td> +<td>boolean</td> +</tr> +<tr> +<td>runtime</td> +<td>Sets the type of runtime library, possible values "dynamic", "static".</td> +<td> +<a href="../apidocs/net/sf/antcontrib/cpptasks/RuntimeType.html">RuntimeType</a> +</td> +</tr> +<tr> +<td>subsystem</td> +<td>Sets the nature of the subsystem under which that the program will + execute. + + <table> <thead>Supported subsystems </thead> + <tr> + <td>gui</td> + <td>Graphical User Interface</td> + </tr> + <tr> + <td>console</td> + <td>Command Line Console</td> + </tr> + <tr> + <td>other</td> + <td>Other</td> + </tr> + </table> +</td> +<td> +<a href="../apidocs/net/sf/antcontrib/cpptasks/SubsystemEnum.html">SubsystemEnum</a> +</td> +</tr> +<tr> +<td>taskname</td> +<td></td> +<td>String</td> +</tr> +<tr> +<td>tasktype</td> +<td></td> +<td>String</td> +</tr> +<tr> +<td>warnings</td> +<td>Enumerated attribute with the values "none", "severe", "default", + "production", "diagnostic", and "aserror".</td> +<td> +<a href="../apidocs/net/sf/antcontrib/cpptasks/WarningLevelEnum.html">WarningLevelEnum</a> +</td> +</tr> +</table> +</subsection> +<subsection name="parameters as nested elements"> +<dl> +<dt> +<a href="CompilerDef.html">compiler</a> +</dt> +<dd>Adds a compiler definition or reference.</dd> +<dt> +<a href="CompilerArgument.html">compilerarg</a> +</dt> +<dd>Adds a compiler command-line arg. Argument will be inherited by all + nested compiler elements that do not have inherit="false".</dd> +<dt> +<a href="DefineSet.html">defineset</a> +</dt> +<dd>Adds a defineset. Will be inherited by all compiler elements that do not + have inherit="false".</dd> +<dt> +<a href="DistributerDef.html">distributer</a> +</dt> +<dd>Adds a distributer definition or reference (Non-functional prototype).</dd> +<dt> +<a href="about:blank">env</a> +</dt> +<dd>Add an environment variable to the launched process.</dd> +<dt> +<a href="ConditionalFileSet.html">fileset</a> +</dt> +<dd>Adds a source file set. + + Files in these filesets will be auctioned to the available compiler + configurations, with the default compiler implied by the cc element + bidding last. If no compiler is interested in the file, it will be + passed to the linker. + + To have a file be processed by a particular compiler configuration, add + a fileset to the corresponding compiler element.</dd> +<dt> +<a href="IncludePath.html">includepath</a> +</dt> +<dd>Adds an include path. + + Include paths will be inherited by nested compiler elements that do not + have inherit="false".</dd> +<dt> +<a href="LibrarySet.html">libset</a> +</dt> +<dd>Adds a library set. + + Library sets will be inherited by all linker elements that do not have + inherit="false".</dd> +<dt> +<a href="LinkerDef.html">linker</a> +</dt> +<dd>Adds a linker definition. The first linker that is not disqualified by + its "if" and "unless" attributes will perform the link. If no child + linker element is active, the linker implied by the cc elements name or + classname attribute will be used.</dd> +<dt> +<a href="LinkerArgument.html">linkerarg</a> +</dt> +<dd>Adds a linker command-line arg. Argument will be inherited by all nested + linker elements that do not have inherit="false".</dd> +<dt> +<a href="PrecompileDef.html">precompile</a> +</dt> +<dd>Specifies precompilation prototype file and exclusions. Inherited by all + compilers that do not have inherit="false".</dd> +<dt> +<a href="ProjectDef.html">project</a> +</dt> +<dd>Specifies the generation of IDE project file. Experimental.</dd> +<dt> +<a href="SystemIncludePath.html">sysincludepath</a> +</dt> +<dd>Adds a system include path. Locations and timestamps of files located + using the system include paths are not used in dependency analysis. + + + Standard include locations should not be specified. The compiler + adapters should recognized the settings from the appropriate environment + variables or configuration files. + + System include paths will be inherited by nested compiler elements that + do not have inherit="false".</dd> +<dt> +<a href="SystemLibrarySet.html">syslibset</a> +</dt> +<dd>Adds a system library set. Timestamps and locations of system library + sets are not used in dependency analysis. + + Essential libraries (such as C Runtime libraries) should not be + specified since the task will attempt to identify the correct libraries + based on the multithread, debug and runtime attributes. + + System library sets will be inherited by all linker elements that do not + have inherit="false".</dd> +<dt> +<a href="TargetDef.html">target</a> +</dt> +<dd>Adds a target definition or reference (Non-functional prototype).</dd> +<dt> +<a href="VersionInfo.html">versioninfo</a> +</dt> +<dd>Adds desriptive version information to be included in the + generated file. The first active version info block will + be used.</dd> +</dl> +</subsection> +</section> +</body> +</document> diff --git a/src/site/xdoc/antdocs/CommentDef.xml b/src/site/xdoc/antdocs/CommentDef.xml new file mode 100644 index 0000000..68373e9 --- /dev/null +++ b/src/site/xdoc/antdocs/CommentDef.xml @@ -0,0 +1,37 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + +Licensed to the Ant-Contrib Project under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The Ant-Contrib Project licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. + + --> +<document xmlns:xhtml="http://www.w3.org/1999/xhtml" xmlns:taskdocs="http://ant-contrib.sf.net/taskdocs"> +<properties> +<title>comment</title> +</properties> +<body> +<section name="comment"> +<subsection name="Description">Defines a comment to place in the generated project files.</subsection> +<subsection name="parameters as nested elements"> +<dl> +<dt> +<a href="about:blank">text</a> +</dt> +<dd/> +</dl> +</subsection> +</section> +</body> +</document> diff --git a/src/site/xdoc/antdocs/CompilerArgument.xml b/src/site/xdoc/antdocs/CompilerArgument.xml new file mode 100644 index 0000000..abbf0dd --- /dev/null +++ b/src/site/xdoc/antdocs/CompilerArgument.xml @@ -0,0 +1,83 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + +Licensed to the Ant-Contrib Project under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The Ant-Contrib Project licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. + + --> +<document xmlns:xhtml="http://www.w3.org/1999/xhtml" xmlns:taskdocs="http://ant-contrib.sf.net/taskdocs"> +<properties> +<title>compilerarg</title> +</properties> +<body> +<section name="compilerarg"> +<subsection name="Description">A compiler command line argument.</subsection> +<subsection name="parameters"> +<table> +<tr> +<td> +<b>Attribute</b> +</td> +<td> +<b>Description</b> +</td> +<td> +<b>Type</b> +</td> +</tr> +<tr> +<td>if</td> +<td>Sets the property name for the 'if' condition. + + The argument will be ignored unless the property is defined. + + The value of the property is insignificant, but values that would imply + misinterpretation ("false", "no") will throw an exception when + evaluated.</td> +<td>String</td> +</tr> +<tr> +<td>location</td> +<td>Specifies relative location of argument on command line. "start" will + place argument at start of command line, "mid" will place argument after + all "start" arguments but before filenames, "end" will place argument + after filenames.</td> +<td> +<a href="../apidocs/net/sf/antcontrib/cpptasks/types/CommandLineArgument/LocationEnum.html">LocationEnum</a> +</td> +</tr> +<tr> +<td>unless</td> +<td>Set the property name for the 'unless' condition. + + If named property is set, the argument will be ignored. + + The value of the property is insignificant, but values that would imply + misinterpretation ("false", "no") of the behavior will throw an + exception when evaluated.</td> +<td>String</td> +</tr> +<tr> +<td>value</td> +<td>Specifies the string that should appear on the command line. The + argument will be quoted if it contains embedded blanks. Use multiple + arguments to avoid quoting.</td> +<td>String</td> +</tr> +</table> +</subsection> +</section> +</body> +</document> diff --git a/src/site/xdoc/antdocs/CompilerDef.xml b/src/site/xdoc/antdocs/CompilerDef.xml new file mode 100644 index 0000000..7d98127 --- /dev/null +++ b/src/site/xdoc/antdocs/CompilerDef.xml @@ -0,0 +1,313 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + +Licensed to the Ant-Contrib Project under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The Ant-Contrib Project licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. + + --> +<document xmlns:xhtml="http://www.w3.org/1999/xhtml" xmlns:taskdocs="http://ant-contrib.sf.net/taskdocs"> +<properties> +<title>compiler</title> +</properties> +<body> +<section name="compiler"> +<subsection name="Description">A compiler definition. compiler elements may be placed either as children of + a cc element or the project element. A compiler element with an id attribute + may be referenced from compiler elements with refid or extends attributes.</subsection> +<subsection name="parameters"> +<table> +<tr> +<td> +<b>Attribute</b> +</td> +<td> +<b>Description</b> +</td> +<td> +<b>Type</b> +</td> +</tr> +<tr> +<td>classname</td> +<td>Sets the default compiler adapter. Use the "name" attribute when the + compiler is a supported compiler.</td> +<td>String</td> +</tr> +<tr> +<td>debug</td> +<td>If set true, all targets will be built for debugging.</td> +<td>boolean</td> +</tr> +<tr> +<td>description</td> +<td>Sets a description of the current data type.</td> +<td>String</td> +</tr> +<tr> +<td>exceptions</td> +<td>Enables or disables exception support.</td> +<td>boolean</td> +</tr> +<tr> +<td>extends</td> +<td>Specifies that this element extends the element with id attribute with a + matching value. The configuration will be constructed from the settings + of this element, element referenced by extends, and the containing cc + element.</td> +<td>Reference</td> +</tr> +<tr> +<td>id</td> +<td>Sets an id that can be used to reference this element.</td> +<td>String</td> +</tr> +<tr> +<td>if</td> +<td>Sets the property name for the 'if' condition. + + The configuration will be ignored unless the property is defined. + + The value of the property is insignificant, but values that would imply + misinterpretation ("false", "no") will throw an exception when + evaluated.</td> +<td>String</td> +</tr> +<tr> +<td>inherit</td> +<td>If inherit has the default value of true, defines, includes and other + settings from the containing cc element will be inherited.</td> +<td>boolean</td> +</tr> +<tr> +<td>libtool</td> +<td>Set use of libtool. + + If set to true, the "libtool " will be prepended to the command line</td> +<td>boolean</td> +</tr> +<tr> +<td>multithreaded</td> +<td>Enables or disables generation of multithreaded code. Unless specified, + multithreaded code generation is enabled.</td> +<td>boolean</td> +</tr> +<tr> +<td>name</td> +<td>Sets compiler type. + + + <table> <thead>Supported compilers </thead> + <tr> + <td>gcc (default)</td> + <td>GCC C++ compiler</td> + </tr> + <tr> + <td>g++</td> + <td>GCC C++ compiler</td> + </tr> + <tr> + <td>c++</td> + <td>GCC C++ compiler</td> + </tr> + <tr> + <td>g77</td> + <td>GNU Fortran compiler</td> + </tr> + <tr> + <td>msvc</td> + <td>Microsoft Visual C++</td> + </tr> + <tr> + <td>bcc</td> + <td>Borland C++ Compiler</td> + </tr> + <tr> + <td>msrc</td> + <td>Microsoft Resource Compiler</td> + </tr> + <tr> + <td>brc</td> + <td>Borland Resource Compiler</td> + </tr> + <tr> + <td>df</td> + <td>Compaq Visual Fortran Compiler</td> + </tr> + <tr> + <td>midl</td> + <td>Microsoft MIDL Compiler</td> + </tr> + <tr> + <td>icl</td> + <td>Intel C++ compiler for Windows (IA-32)</td> + </tr> + <tr> + <td>ecl</td> + <td>Intel C++ compiler for Windows (IA-64)</td> + </tr> + <tr> + <td>icc</td> + <td>Intel C++ compiler for Linux (IA-32)</td> + </tr> + <tr> + <td>ecc</td> + <td>Intel C++ compiler for Linux (IA-64)</td> + </tr> + <tr> + <td>CC</td> + <td>Sun ONE C++ compiler</td> + </tr> + <tr> + <td>aCC</td> + <td>HP aC++ C++ Compiler</td> + </tr> + <tr> + <td>os390</td> + <td>OS390 C Compiler</td> + </tr> + <tr> + <td>os400</td> + <td>Icc Compiler</td> + </tr> + <tr> + <td>sunc89</td> + <td>Sun C89 C Compiler</td> + </tr> + <tr> + <td>xlC</td> + <td>VisualAge C Compiler</td> + </tr> + <tr> + <td>uic</td> + <td>Qt user interface compiler</td> + </tr> + <tr> + <td>moc</td> + <td>Qt meta-object compiler</td> + </tr> + <tr> + <td>wcl</td> + <td>OpenWatcom C/C++ compiler</td> + </tr> + <tr> + <td>wfl</td> + <td>OpenWatcom FORTRAN compiler</td> + </tr> + </table> +</td> +<td> +<a href="../apidocs/net/sf/antcontrib/cpptasks/CompilerEnum.html">CompilerEnum</a> +</td> +</tr> +<tr> +<td>newenvironment</td> +<td>Do not propagate old environment when new environment variables are + specified.</td> +<td>boolean</td> +</tr> +<tr> +<td>optimize</td> +<td>Sets optimization level.</td> +<td> +<a href="../apidocs/net/sf/antcontrib/cpptasks/OptimizationEnum.html">OptimizationEnum</a> +</td> +</tr> +<tr> +<td>rebuild</td> +<td>If set true, all targets will be unconditionally rebuilt.</td> +<td>boolean</td> +</tr> +<tr> +<td>refid</td> +<td>Specifies that this element should behave as if the content of the + element with the matching id attribute was inserted at this location. If + specified, no other attributes or child content should be specified, + other than "if", "unless" and "description".</td> +<td>Reference</td> +</tr> +<tr> +<td>rtti</td> +<td>Enables or disables run-time type information.</td> +<td>boolean</td> +</tr> +<tr> +<td>unless</td> +<td>Set the property name for the 'unless' condition. + + If named property is set, the configuration will be ignored. + + The value of the property is insignificant, but values that would imply + misinterpretation ("false", "no") of the behavior will throw an + exception when evaluated.</td> +<td>String</td> +</tr> +<tr> +<td>warnings</td> +<td>Enumerated attribute with the values "none", "severe", "default", + "production", "diagnostic", and "aserror".</td> +<td> +<a href="../apidocs/net/sf/antcontrib/cpptasks/WarningLevelEnum.html">WarningLevelEnum</a> +</td> +</tr> +</table> +</subsection> +<subsection name="parameters as nested elements"> +<dl> +<dt> +<a href="CompilerArgument.html">compilerarg</a> +</dt> +<dd>Adds a compiler command-line arg.</dd> +<dt> +<a href="CompilerParam.html">compilerparam</a> +</dt> +<dd>Adds a compiler command-line arg.</dd> +<dt> +<a href="DefineSet.html">defineset</a> +</dt> +<dd>Adds a defineset.</dd> +<dt> +<a href="about:blank">env</a> +</dt> +<dd>Add an environment variable to the launched process.</dd> +<dt> +<a href="ConditionalFileSet.html">fileset</a> +</dt> +<dd>Adds a source file set. + + Files in these set will be processed by this configuration and will not + participate in the auction.</dd> +<dt> +<a href="IncludePath.html">includepath</a> +</dt> +<dd>Creates an include path.</dd> +<dt> +<a href="PrecompileDef.html">precompile</a> +</dt> +<dd>Specifies precompilation prototype file and exclusions.</dd> +<dt> +<a href="SystemIncludePath.html">sysincludepath</a> +</dt> +<dd>Creates a system include path. Locations and timestamps of files located + using the system include paths are not used in dependency analysis. + + + Standard include locations should not be specified. The compiler + adapters should recognized the settings from the appropriate environment + variables or configuration files.</dd> +</dl> +</subsection> +</section> +</body> +</document> diff --git a/src/site/xdoc/antdocs/CompilerParam.xml b/src/site/xdoc/antdocs/CompilerParam.xml new file mode 100644 index 0000000..5a3475b --- /dev/null +++ b/src/site/xdoc/antdocs/CompilerParam.xml @@ -0,0 +1,81 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + +Licensed to the Ant-Contrib Project under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The Ant-Contrib Project licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. + + --> +<document xmlns:xhtml="http://www.w3.org/1999/xhtml" xmlns:taskdocs="http://ant-contrib.sf.net/taskdocs"> +<properties> +<title>compilerparam</title> +</properties> +<body> +<section name="compilerparam"> +<subsection name="Description">Place class description here.</subsection> +<subsection name="parameters"> +<table> +<tr> +<td> +<b>Attribute</b> +</td> +<td> +<b>Description</b> +</td> +<td> +<b>Type</b> +</td> +</tr> +<tr> +<td>if</td> +<td>Sets the property name for the 'if' condition. + + The argument will be ignored unless the property is defined. + + The value of the property is insignificant, but values that would imply + misinterpretation ("false", "no") will throw an exception when + evaluated.</td> +<td>String</td> +</tr> +<tr> +<td>name</td> +<td>Specifies relative location of argument on command line. "start" will + place argument at start of command line, "mid" will place argument after + all "start" arguments but before filenames, "end" will place argument + after filenames.</td> +<td>String</td> +</tr> +<tr> +<td>unless</td> +<td>Set the property name for the 'unless' condition. + + If named property is set, the argument will be ignored. + + The value of the property is insignificant, but values that would imply + misinterpretation ("false", "no") of the behavior will throw an + exception when evaluated.</td> +<td>String</td> +</tr> +<tr> +<td>value</td> +<td>Specifies the string that should appear on the command line. The + argument will be quoted if it contains embedded blanks. Use multiple + arguments to avoid quoting.</td> +<td>String</td> +</tr> +</table> +</subsection> +</section> +</body> +</document> diff --git a/src/site/xdoc/antdocs/ConditionalFileSet.xml b/src/site/xdoc/antdocs/ConditionalFileSet.xml new file mode 100644 index 0000000..8566212 --- /dev/null +++ b/src/site/xdoc/antdocs/ConditionalFileSet.xml @@ -0,0 +1,221 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + +Licensed to the Ant-Contrib Project under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The Ant-Contrib Project licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. + + --> +<document xmlns:xhtml="http://www.w3.org/1999/xhtml" xmlns:taskdocs="http://ant-contrib.sf.net/taskdocs"> +<properties> +<title>conditionalfileset</title> +</properties> +<body> +<section name="conditionalfileset"> +<subsection name="Description">An Ant FileSet object augmented with if and unless conditions.</subsection> +<subsection name="parameters"> +<table> +<tr> +<td> +<b>Attribute</b> +</td> +<td> +<b>Description</b> +</td> +<td> +<b>Type</b> +</td> +</tr> +<tr> +<td>casesensitive</td> +<td></td> +<td>boolean</td> +</tr> +<tr> +<td>defaultexcludes</td> +<td></td> +<td>boolean</td> +</tr> +<tr> +<td>description</td> +<td></td> +<td>String</td> +</tr> +<tr> +<td>dir</td> +<td></td> +<td>File</td> +</tr> +<tr> +<td>excludes</td> +<td></td> +<td>String</td> +</tr> +<tr> +<td>excludesfile</td> +<td></td> +<td>File</td> +</tr> +<tr> +<td>file</td> +<td></td> +<td>File</td> +</tr> +<tr> +<td>followsymlinks</td> +<td></td> +<td>boolean</td> +</tr> +<tr> +<td>if</td> +<td>Sets the property name for the 'if' condition. + + The fileset will be ignored unless the property is defined. + + The value of the property is insignificant, but values that would imply + misinterpretation ("false", "no") will throw an exception when + evaluated.</td> +<td>String</td> +</tr> +<tr> +<td>includes</td> +<td></td> +<td>String</td> +</tr> +<tr> +<td>includesfile</td> +<td></td> +<td>File</td> +</tr> +<tr> +<td>refid</td> +<td></td> +<td>Reference</td> +</tr> +<tr> +<td>unless</td> +<td>Set the property name for the 'unless' condition. + + If named property is set, the fileset will be ignored. + + The value of the property is insignificant, but values that would imply + misinterpretation ("false", "no") of the behavior will throw an + exception when evaluated.</td> +<td>String</td> +</tr> +</table> +</subsection> +<subsection name="parameters as nested elements"> +<dl> +<dt> +<a href="about:blank"></a> +</dt> +<dd/> +<dt> +<a href="about:blank">and</a> +</dt> +<dd/> +<dt> +<a href="about:blank">contains</a> +</dt> +<dd/> +<dt> +<a href="about:blank">containsregexp</a> +</dt> +<dd/> +<dt> +<a href="about:blank">custom</a> +</dt> +<dd/> +<dt> +<a href="about:blank">date</a> +</dt> +<dd/> +<dt> +<a href="about:blank">depend</a> +</dt> +<dd/> +<dt> +<a href="about:blank">depth</a> +</dt> +<dd/> +<dt> +<a href="about:blank">different</a> +</dt> +<dd/> +<dt> +<a href="http://ant.apache.org/manual/CoreTypes/patternset.html">exclude</a> +</dt> +<dd/> +<dt> +<a href="http://ant.apache.org/manual/CoreTypes/patternset.html">excludesfile</a> +</dt> +<dd/> +<dt> +<a href="about:blank">filename</a> +</dt> +<dd/> +<dt> +<a href="http://ant.apache.org/manual/CoreTypes/patternset.html">include</a> +</dt> +<dd/> +<dt> +<a href="http://ant.apache.org/manual/CoreTypes/patternset.html">includesfile</a> +</dt> +<dd/> +<dt> +<a href="about:blank">majority</a> +</dt> +<dd/> +<dt> +<a href="about:blank">modified</a> +</dt> +<dd/> +<dt> +<a href="about:blank">none</a> +</dt> +<dd/> +<dt> +<a href="about:blank">not</a> +</dt> +<dd/> +<dt> +<a href="about:blank">or</a> +</dt> +<dd/> +<dt> +<a href="http://ant.apache.org/manual/CoreTypes/patternset.html">patternset</a> +</dt> +<dd/> +<dt> +<a href="about:blank">present</a> +</dt> +<dd/> +<dt> +<a href="about:blank">selector</a> +</dt> +<dd/> +<dt> +<a href="about:blank">size</a> +</dt> +<dd/> +<dt> +<a href="about:blank">type</a> +</dt> +<dd/> +</dl> +</subsection> +</section> +</body> +</document> diff --git a/src/site/xdoc/antdocs/ConditionalPath.xml b/src/site/xdoc/antdocs/ConditionalPath.xml new file mode 100644 index 0000000..0ba7346 --- /dev/null +++ b/src/site/xdoc/antdocs/ConditionalPath.xml @@ -0,0 +1,122 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + +Licensed to the Ant-Contrib Project under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The Ant-Contrib Project licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. + + --> +<document xmlns:xhtml="http://www.w3.org/1999/xhtml" xmlns:taskdocs="http://ant-contrib.sf.net/taskdocs"> +<properties> +<title>conditionalpath</title> +</properties> +<body> +<section name="conditionalpath"> +<subsection name="Description">An Ant Path object augmented with if and unless conditionals</subsection> +<subsection name="parameters"> +<table> +<tr> +<td> +<b>Attribute</b> +</td> +<td> +<b>Description</b> +</td> +<td> +<b>Type</b> +</td> +</tr> +<tr> +<td>description</td> +<td></td> +<td>String</td> +</tr> +<tr> +<td>if</td> +<td>Sets the property name for the 'if' condition. + + The path will be ignored unless the property is defined. + + The value of the property is insignificant, but values that would imply + misinterpretation ("false", "no") will throw an exception when + evaluated.</td> +<td>String</td> +</tr> +<tr> +<td>location</td> +<td></td> +<td>File</td> +</tr> +<tr> +<td>path</td> +<td></td> +<td>String</td> +</tr> +<tr> +<td>refid</td> +<td></td> +<td>Reference</td> +</tr> +<tr> +<td>unless</td> +<td>Set the property name for the 'unless' condition. + + If named property is set, the path will be ignored. + + The value of the property is insignificant, but values that would imply + misinterpretation ("false", "no") of the behavior will throw an + exception when evaluated.</td> +<td>String</td> +</tr> +</table> +</subsection> +<subsection name="parameters as nested elements"> +<dl> +<dt> +<a href="http://ant.apache.org/manual/using.html#path"></a> +</dt> +<dd/> +<dt> +<a href="about:blank">dirset</a> +</dt> +<dd/> +<dt> +<a href="http://ant.apache.org/manual/using.html#path">existing</a> +</dt> +<dd/> +<dt> +<a href="http://ant.apache.org/manual/using.html#path">extdirs</a> +</dt> +<dd/> +<dt> +<a href="about:blank">filelist</a> +</dt> +<dd/> +<dt> +<a href="about:blank">fileset</a> +</dt> +<dd/> +<dt> +<a href="http://ant.apache.org/manual/using.html#path">path</a> +</dt> +<dd/> +<dt> +<a href="http://ant.apache.org/manual/using.html#path">pathelement</a> +</dt> +<dd/> +</dl> +</subsection> +</section> +</body> +</document> diff --git a/src/site/xdoc/antdocs/DebugDef.xml b/src/site/xdoc/antdocs/DebugDef.xml new file mode 100644 index 0000000..c3084e8 --- /dev/null +++ b/src/site/xdoc/antdocs/DebugDef.xml @@ -0,0 +1,76 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + +Licensed to the Ant-Contrib Project under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The Ant-Contrib Project licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. + + --> +<document xmlns:xhtml="http://www.w3.org/1999/xhtml" xmlns:taskdocs="http://ant-contrib.sf.net/taskdocs"> +<properties> +<title>debug</title> +</properties> +<body> +<section name="debug"> +<subsection name="Description">Specifies a debugging configuration for a project.</subsection> +<subsection name="parameters"> +<table> +<tr> +<td> +<b>Attribute</b> +</td> +<td> +<b>Description</b> +</td> +<td> +<b>Type</b> +</td> +</tr> +<tr> +<td>description</td> +<td></td> +<td>String</td> +</tr> +<tr> +<td>dir</td> +<td>Set the working directory of the process.</td> +<td>File</td> +</tr> +<tr> +<td>executable</td> +<td>Set the name of the executable program.</td> +<td>String</td> +</tr> +<tr> +<td>refid</td> +<td></td> +<td>Reference</td> +</tr> +</table> +</subsection> +<subsection name="parameters as nested elements"> +<dl> +<dt> +<a href="http://ant.apache.org/manual/CoreTasks/exec.html">arg</a> +</dt> +<dd>Adds a command-line argument.</dd> +<dt> +<a href="about:blank">env</a> +</dt> +<dd>Add an environment variable.</dd> +</dl> +</subsection> +</section> +</body> +</document> diff --git a/src/site/xdoc/antdocs/DefineArgument.xml b/src/site/xdoc/antdocs/DefineArgument.xml new file mode 100644 index 0000000..996dee8 --- /dev/null +++ b/src/site/xdoc/antdocs/DefineArgument.xml @@ -0,0 +1,76 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + +Licensed to the Ant-Contrib Project under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The Ant-Contrib Project licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. + + --> +<document xmlns:xhtml="http://www.w3.org/1999/xhtml" xmlns:taskdocs="http://ant-contrib.sf.net/taskdocs"> +<properties> +<title>definearg</title> +</properties> +<body> +<section name="definearg"> +<subsection name="Description">Preprocessor macro definition.</subsection> +<subsection name="parameters"> +<table> +<tr> +<td> +<b>Attribute</b> +</td> +<td> +<b>Description</b> +</td> +<td> +<b>Type</b> +</td> +</tr> +<tr> +<td>if</td> +<td>Sets the property name for the 'if' condition. + + The define will be ignored unless the property is defined. + + The value of the property is insignificant, but values that would imply + misinterpretation ("false", "no") will throw an exception when + evaluated.</td> +<td>String</td> +</tr> +<tr> +<td>name</td> +<td>Set the name attribute</td> +<td>String</td> +</tr> +<tr> +<td>unless</td> +<td>Set the property name for the 'unless' condition. + + If named property is set, the define will be ignored. + + The value of the property is insignificant, but values that would imply + misinterpretation ("false", "no") of the behavior will throw an + exception when evaluated.</td> +<td>String</td> +</tr> +<tr> +<td>value</td> +<td>Set the value attribute</td> +<td>String</td> +</tr> +</table> +</subsection> +</section> +</body> +</document> diff --git a/src/site/xdoc/antdocs/DefineSet.xml b/src/site/xdoc/antdocs/DefineSet.xml new file mode 100644 index 0000000..50ef5ca --- /dev/null +++ b/src/site/xdoc/antdocs/DefineSet.xml @@ -0,0 +1,111 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + +Licensed to the Ant-Contrib Project under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The Ant-Contrib Project licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. + + --> +<document xmlns:xhtml="http://www.w3.org/1999/xhtml" xmlns:taskdocs="http://ant-contrib.sf.net/taskdocs"> +<properties> +<title>defineset</title> +</properties> +<body> +<section name="defineset"> +<subsection name="Description">Set of preprocessor macro defines and undefines.</subsection> +<subsection name="parameters"> +<table> +<tr> +<td> +<b>Attribute</b> +</td> +<td> +<b>Description</b> +</td> +<td> +<b>Type</b> +</td> +</tr> +<tr> +<td>define</td> +<td>A comma-separated list of preprocessor macros to define. Use nested + define elements to define macro values.</td> +<td> +<a href="../apidocs/net/sf/antcontrib/cpptasks/CUtil/StringArrayBuilder.html">StringArrayBuilder</a> +</td> +</tr> +<tr> +<td>description</td> +<td>Sets a description of the current data type.</td> +<td>String</td> +</tr> +<tr> +<td>id</td> +<td>Sets an id that can be used to reference this element.</td> +<td>String</td> +</tr> +<tr> +<td>if</td> +<td>Sets the property name for the 'if' condition. + + The define will be ignored unless the property is defined. + + The value of the property is insignificant, but values that would imply + misinterpretation ("false", "no") will throw an exception when + evaluated.</td> +<td>String</td> +</tr> +<tr> +<td>refid</td> +<td>Specifies that this element should behave as if the content of the + element with the matching id attribute was inserted at this location. If + specified, no other attributes or child content should be specified, + other than "description".</td> +<td>Reference</td> +</tr> +<tr> +<td>undefine</td> +<td>A comma-separated list of preprocessor macros to undefine.</td> +<td> +<a href="../apidocs/net/sf/antcontrib/cpptasks/CUtil/StringArrayBuilder.html">StringArrayBuilder</a> +</td> +</tr> +<tr> +<td>unless</td> +<td>Set the property name for the 'unless' condition. + + If named property is set, the define will be ignored. + + The value of the property is insignificant, but values that would imply + misinterpretation ("false", "no") of the behavior will throw an + exception when evaluated.</td> +<td>String</td> +</tr> +</table> +</subsection> +<subsection name="parameters as nested elements"> +<dl> +<dt> +<a href="DefineArgument.html">define</a> +</dt> +<dd>Adds a define element.</dd> +<dt> +<a href="UndefineArgument.html">undefine</a> +</dt> +<dd>Adds an undefine element.</dd> +</dl> +</subsection> +</section> +</body> +</document> diff --git a/src/site/xdoc/antdocs/DependencyDef.xml b/src/site/xdoc/antdocs/DependencyDef.xml new file mode 100644 index 0000000..d0fd35b --- /dev/null +++ b/src/site/xdoc/antdocs/DependencyDef.xml @@ -0,0 +1,64 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + +Licensed to the Ant-Contrib Project under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The Ant-Contrib Project licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. + + --> +<document xmlns:xhtml="http://www.w3.org/1999/xhtml" xmlns:taskdocs="http://ant-contrib.sf.net/taskdocs"> +<properties> +<title>dependency</title> +</properties> +<body> +<section name="dependency"> +<subsection name="Description">Defines a dependency</subsection> +<subsection name="parameters"> +<table> +<tr> +<td> +<b>Attribute</b> +</td> +<td> +<b>Description</b> +</td> +<td> +<b>Type</b> +</td> +</tr> +<tr> +<td>depends</td> +<td></td> +<td>String</td> +</tr> +<tr> +<td>file</td> +<td></td> +<td>File</td> +</tr> +<tr> +<td>id</td> +<td></td> +<td>String</td> +</tr> +<tr> +<td>name</td> +<td></td> +<td>String</td> +</tr> +</table> +</subsection> +</section> +</body> +</document> diff --git a/src/site/xdoc/antdocs/DistributerDef.xml b/src/site/xdoc/antdocs/DistributerDef.xml new file mode 100644 index 0000000..3530039 --- /dev/null +++ b/src/site/xdoc/antdocs/DistributerDef.xml @@ -0,0 +1,113 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + +Licensed to the Ant-Contrib Project under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The Ant-Contrib Project licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. + + --> +<document xmlns:xhtml="http://www.w3.org/1999/xhtml" xmlns:taskdocs="http://ant-contrib.sf.net/taskdocs"> +<properties> +<title>distributer</title> +</properties> +<body> +<section name="distributer"> +<subsection name="Description">Distributed build information (Non-functional prototype).</subsection> +<subsection name="parameters"> +<table> +<tr> +<td> +<b>Attribute</b> +</td> +<td> +<b>Description</b> +</td> +<td> +<b>Type</b> +</td> +</tr> +<tr> +<td>description</td> +<td></td> +<td>String</td> +</tr> +<tr> +<td>hosts</td> +<td>Sets hosts.</td> +<td>String</td> +</tr> +<tr> +<td>id</td> +<td>Sets an id that can be used to reference this element.</td> +<td>String</td> +</tr> +<tr> +<td>if</td> +<td>Sets the property name for the 'if' condition. + + The define will be ignored unless the property is defined. + + The value of the property is insignificant, but values that would imply + misinterpretation ("false", "no") will throw an exception when + evaluated.</td> +<td>String</td> +</tr> +<tr> +<td>protocol</td> +<td>Sets protocol.</td> +<td> +<a href="../apidocs/net/sf/antcontrib/cpptasks/DistributerProtocolEnum.html">DistributerProtocolEnum</a> +</td> +</tr> +<tr> +<td>refid</td> +<td>Specifies that this element should behave as if the content of the + element with the matching id attribute was inserted at this location. If + specified, no other attributes should be specified.</td> +<td>Reference</td> +</tr> +<tr> +<td>tcpcork</td> +<td>Sets TCP_CORK value.</td> +<td>int</td> +</tr> +<tr> +<td>unless</td> +<td>Set the property name for the 'unless' condition. + + If named property is set, the define will be ignored. + + The value of the property is insignificant, but values that would imply + misinterpretation ("false", "no") of the behavior will throw an + exception when evaluated.</td> +<td>String</td> +</tr> +<tr> +<td>user</td> +<td>Sets remote user name.</td> +<td>String</td> +</tr> +</table> +</subsection> +<subsection name="parameters as nested elements"> +<dl> +<dt> +<a href="DistributerMap.html">map</a> +</dt> +<dd>Local to remote filename maps.</dd> +</dl> +</subsection> +</section> +</body> +</document> diff --git a/src/site/xdoc/antdocs/DistributerMap.xml b/src/site/xdoc/antdocs/DistributerMap.xml new file mode 100644 index 0000000..fa7be49 --- /dev/null +++ b/src/site/xdoc/antdocs/DistributerMap.xml @@ -0,0 +1,96 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + +Licensed to the Ant-Contrib Project under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The Ant-Contrib Project licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. + + --> +<document xmlns:xhtml="http://www.w3.org/1999/xhtml" xmlns:taskdocs="http://ant-contrib.sf.net/taskdocs"> +<properties> +<title>distributermap</title> +</properties> +<body> +<section name="distributermap"> +<subsection name="Description">Local to remote filename mapping (Experimental).</subsection> +<subsection name="parameters"> +<table> +<tr> +<td> +<b>Attribute</b> +</td> +<td> +<b>Description</b> +</td> +<td> +<b>Type</b> +</td> +</tr> +<tr> +<td>description</td> +<td></td> +<td>String</td> +</tr> +<tr> +<td>hosts</td> +<td>Sets hosts for which this mapping is valid.</td> +<td>String</td> +</tr> +<tr> +<td>if</td> +<td>Sets the property name for the 'if' condition. + + This object will be ignored unless the property is defined. + + The value of the property is insignificant, but values that would imply + misinterpretation ("false", "no") will throw an exception when + evaluated.</td> +<td>String</td> +</tr> +<tr> +<td>local</td> +<td>Sets local directory for base of mapping.</td> +<td>File</td> +</tr> +<tr> +<td>refid</td> +<td></td> +<td>Reference</td> +</tr> +<tr> +<td>remote</td> +<td>Sets remote name for directory.</td> +<td>String</td> +</tr> +<tr> +<td>remoteseparator</td> +<td>Sets the separator character (/ or \) for the remote system.</td> +<td>String</td> +</tr> +<tr> +<td>unless</td> +<td>Set the property name for the 'unless' condition. + + If named property is set, the define will be ignored. + + The value of the property is insignificant, but values that would imply + misinterpretation ("false", "no") of the behavior will throw an + exception when evaluated.</td> +<td>String</td> +</tr> +</table> +</subsection> +</section> +</body> +</document> diff --git a/src/site/xdoc/antdocs/IncludePath.xml b/src/site/xdoc/antdocs/IncludePath.xml new file mode 100644 index 0000000..a50ec2a --- /dev/null +++ b/src/site/xdoc/antdocs/IncludePath.xml @@ -0,0 +1,125 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + +Licensed to the Ant-Contrib Project under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The Ant-Contrib Project licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. + + --> +<document xmlns:xhtml="http://www.w3.org/1999/xhtml" xmlns:taskdocs="http://ant-contrib.sf.net/taskdocs"> +<properties> +<title>includepath</title> +</properties> +<body> +<section name="includepath"> +<subsection name="Description">An include path. + + Works like other paths in Ant with with the addition of "if" and "unless" + conditions.</subsection> +<subsection name="parameters"> +<table> +<tr> +<td> +<b>Attribute</b> +</td> +<td> +<b>Description</b> +</td> +<td> +<b>Type</b> +</td> +</tr> +<tr> +<td>description</td> +<td></td> +<td>String</td> +</tr> +<tr> +<td>if</td> +<td>Sets the property name for the 'if' condition. + + The path will be ignored unless the property is defined. + + The value of the property is insignificant, but values that would imply + misinterpretation ("false", "no") will throw an exception when + evaluated.</td> +<td>String</td> +</tr> +<tr> +<td>location</td> +<td></td> +<td>File</td> +</tr> +<tr> +<td>path</td> +<td></td> +<td>String</td> +</tr> +<tr> +<td>refid</td> +<td></td> +<td>Reference</td> +</tr> +<tr> +<td>unless</td> +<td>Set the property name for the 'unless' condition. + + If named property is set, the path will be ignored. + + The value of the property is insignificant, but values that would imply + misinterpretation ("false", "no") of the behavior will throw an + exception when evaluated.</td> +<td>String</td> +</tr> +</table> +</subsection> +<subsection name="parameters as nested elements"> +<dl> +<dt> +<a href="http://ant.apache.org/manual/using.html#path"></a> +</dt> +<dd/> +<dt> +<a href="about:blank">dirset</a> +</dt> +<dd/> +<dt> +<a href="http://ant.apache.org/manual/using.html#path">existing</a> +</dt> +<dd/> +<dt> +<a href="http://ant.apache.org/manual/using.html#path">extdirs</a> +</dt> +<dd/> +<dt> +<a href="about:blank">filelist</a> +</dt> +<dd/> +<dt> +<a href="about:blank">fileset</a> +</dt> +<dd/> +<dt> +<a href="http://ant.apache.org/manual/using.html#path">path</a> +</dt> +<dd/> +<dt> +<a href="http://ant.apache.org/manual/using.html#path">pathelement</a> +</dt> +<dd/> +</dl> +</subsection> +</section> +</body> +</document> diff --git a/src/site/xdoc/antdocs/LibrarySet.xml b/src/site/xdoc/antdocs/LibrarySet.xml new file mode 100644 index 0000000..095a182 --- /dev/null +++ b/src/site/xdoc/antdocs/LibrarySet.xml @@ -0,0 +1,114 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + +Licensed to the Ant-Contrib Project under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The Ant-Contrib Project licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. + + --> +<document xmlns:xhtml="http://www.w3.org/1999/xhtml" xmlns:taskdocs="http://ant-contrib.sf.net/taskdocs"> +<properties> +<title>libset</title> +</properties> +<body> +<section name="libset"> +<subsection name="Description">A set of library names. Libraries can also be added to a link by specifying + them in a fileset. + + For most Unix-like compilers, libset will result in a series of -l and -L + linker arguments. For Windows compilers, the library names will be used to + locate the appropriate library files which will be added to the linkers + input file list as if they had been specified in a fileset.</subsection> +<subsection name="parameters"> +<table> +<tr> +<td> +<b>Attribute</b> +</td> +<td> +<b>Description</b> +</td> +<td> +<b>Type</b> +</td> +</tr> +<tr> +<td>casesensitive</td> +<td>Sets case sensitivity of the file system. If not set, will default to + the linker's case sensitivity.</td> +<td>boolean</td> +</tr> +<tr> +<td>dataset</td> +<td>Sets the dataset. Used on OS390 if the libs are in a dataset.</td> +<td>String</td> +</tr> +<tr> +<td>description</td> +<td></td> +<td>String</td> +</tr> +<tr> +<td>dir</td> +<td>Library directory.</td> +<td>File</td> +</tr> +<tr> +<td>if</td> +<td>Sets the property name for the 'if' condition. + + The library set will be ignored unless the property is defined. + + The value of the property is insignificant, but values that would imply + misinterpretation ("false", "no") will throw an exception when + evaluated.</td> +<td>String</td> +</tr> +<tr> +<td>libs</td> +<td>Comma-separated list of library names without leading prefixes, such as + "lib", or extensions, such as ".so" or ".a".</td> +<td> +<a href="../apidocs/net/sf/antcontrib/cpptasks/CUtil/StringArrayBuilder.html">StringArrayBuilder</a> +</td> +</tr> +<tr> +<td>refid</td> +<td></td> +<td>Reference</td> +</tr> +<tr> +<td>type</td> +<td>Sets the preferred library type. Supported values "shared", "static", and + "framework". "framework" is equivalent to "shared" on non-Darwin platforms.</td> +<td> +<a href="../apidocs/net/sf/antcontrib/cpptasks/types/LibraryTypeEnum.html">LibraryTypeEnum</a> +</td> +</tr> +<tr> +<td>unless</td> +<td>Set the property name for the 'unless' condition. + + If named property is set, the library set will be ignored. + + The value of the property is insignificant, but values that would imply + misinterpretation ("false", "no") of the behavior will throw an + exception when evaluated.</td> +<td>String</td> +</tr> +</table> +</subsection> +</section> +</body> +</document> diff --git a/src/site/xdoc/antdocs/LinkerArgument.xml b/src/site/xdoc/antdocs/LinkerArgument.xml new file mode 100644 index 0000000..94b64d2 --- /dev/null +++ b/src/site/xdoc/antdocs/LinkerArgument.xml @@ -0,0 +1,83 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + +Licensed to the Ant-Contrib Project under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The Ant-Contrib Project licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. + + --> +<document xmlns:xhtml="http://www.w3.org/1999/xhtml" xmlns:taskdocs="http://ant-contrib.sf.net/taskdocs"> +<properties> +<title>linkerarg</title> +</properties> +<body> +<section name="linkerarg"> +<subsection name="Description">A linker command line argument.</subsection> +<subsection name="parameters"> +<table> +<tr> +<td> +<b>Attribute</b> +</td> +<td> +<b>Description</b> +</td> +<td> +<b>Type</b> +</td> +</tr> +<tr> +<td>if</td> +<td>Sets the property name for the 'if' condition. + + The argument will be ignored unless the property is defined. + + The value of the property is insignificant, but values that would imply + misinterpretation ("false", "no") will throw an exception when + evaluated.</td> +<td>String</td> +</tr> +<tr> +<td>location</td> +<td>Specifies relative location of argument on command line. "start" will + place argument at start of command line, "mid" will place argument after + all "start" arguments but before filenames, "end" will place argument + after filenames.</td> +<td> +<a href="../apidocs/net/sf/antcontrib/cpptasks/types/CommandLineArgument/LocationEnum.html">LocationEnum</a> +</td> +</tr> +<tr> +<td>unless</td> +<td>Set the property name for the 'unless' condition. + + If named property is set, the argument will be ignored. + + The value of the property is insignificant, but values that would imply + misinterpretation ("false", "no") of the behavior will throw an + exception when evaluated.</td> +<td>String</td> +</tr> +<tr> +<td>value</td> +<td>Specifies the string that should appear on the command line. The + argument will be quoted if it contains embedded blanks. Use multiple + arguments to avoid quoting.</td> +<td>String</td> +</tr> +</table> +</subsection> +</section> +</body> +</document> diff --git a/src/site/xdoc/antdocs/LinkerDef.xml b/src/site/xdoc/antdocs/LinkerDef.xml new file mode 100644 index 0000000..32e802f --- /dev/null +++ b/src/site/xdoc/antdocs/LinkerDef.xml @@ -0,0 +1,284 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + +Licensed to the Ant-Contrib Project under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The Ant-Contrib Project licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. + + --> +<document xmlns:xhtml="http://www.w3.org/1999/xhtml" xmlns:taskdocs="http://ant-contrib.sf.net/taskdocs"> +<properties> +<title>linker</title> +</properties> +<body> +<section name="linker"> +<subsection name="Description">A linker definition. linker elements may be placed either as children of a + cc element or the project element. A linker element with an id attribute may + be referenced by linker elements with refid or extends attributes.</subsection> +<subsection name="parameters"> +<table> +<tr> +<td> +<b>Attribute</b> +</td> +<td> +<b>Description</b> +</td> +<td> +<b>Type</b> +</td> +</tr> +<tr> +<td>base</td> +<td>Sets the base address. May be specified in either decimal or hex.</td> +<td> +<a href="../apidocs/net/sf/antcontrib/cpptasks/types/FlexLong.html">FlexLong</a> +</td> +</tr> +<tr> +<td>classname</td> +<td>Sets the class name for the adapter. Use the "name" attribute when the + tool is supported.</td> +<td>String</td> +</tr> +<tr> +<td>debug</td> +<td>If set true, all targets will be built for debugging.</td> +<td>boolean</td> +</tr> +<tr> +<td>description</td> +<td>Sets a description of the current data type.</td> +<td>String</td> +</tr> +<tr> +<td>entry</td> +<td>Sets the starting address.</td> +<td>String</td> +</tr> +<tr> +<td>extends</td> +<td>Specifies that this element extends the element with id attribute with a + matching value. The configuration will be constructed from the settings + of this element, element referenced by extends, and the containing cc + element.</td> +<td>Reference</td> +</tr> +<tr> +<td>fixed</td> +<td>If true, marks the file to be loaded only at its preferred address.</td> +<td>boolean</td> +</tr> +<tr> +<td>id</td> +<td>Sets an id that can be used to reference this element.</td> +<td>String</td> +</tr> +<tr> +<td>if</td> +<td>Sets the property name for the 'if' condition. + + The configuration will be ignored unless the property is defined. + + The value of the property is insignificant, but values that would imply + misinterpretation ("false", "no") will throw an exception when + evaluated.</td> +<td>String</td> +</tr> +<tr> +<td>incremental</td> +<td>If true, allows incremental linking.</td> +<td>boolean</td> +</tr> +<tr> +<td>inherit</td> +<td>If inherit has the default value of true, defines, includes and other + settings from the containing cc element will be inherited.</td> +<td>boolean</td> +</tr> +<tr> +<td>libtool</td> +<td>Set use of libtool. + + If set to true, the "libtool " will be prepended to the command line</td> +<td>boolean</td> +</tr> +<tr> +<td>map</td> +<td>If set to true, a map file will be produced.</td> +<td>boolean</td> +</tr> +<tr> +<td>name</td> +<td>Sets linker type. + + + <table> <thead>Supported linkers </thead> + <tr> + <td>gcc</td> + <td>Gcc Linker</td> + </tr> + <tr> + <td>g++</td> + <td>G++ Linker</td> + </tr> + <tr> + <td>ld</td> + <td>Ld Linker</td> + </tr> + <tr> + <td>ar</td> + <td>Gcc Librarian</td> + </tr> + <tr> + <td>msvc</td> + <td>Microsoft Linker</td> + </tr> + <tr> + <td>bcc</td> + <td>Borland Linker</td> + </tr> + <tr> + <td>df</td> + <td>Compaq Visual Fortran Linker</td> + </tr> + <tr> + <td>icl</td> + <td>Intel Linker for Windows (IA-32)</td> + </tr> + <tr> + <td>ecl</td> + <td>Intel Linker for Windows (IA-64)</td> + </tr> + <tr> + <td>icc</td> + <td>Intel Linker for Linux (IA-32)</td> + </tr> + <tr> + <td>ecc</td> + <td>Intel Linker for Linux (IA-64)</td> + </tr> + <tr> + <td>CC</td> + <td>Sun ONE Linker</td> + </tr> + <tr> + <td>aCC</td> + <td>HP aC++ Linker</td> + </tr> + <tr> + <td>os390</td> + <td>OS390 Linker</td> + </tr> + <tr> + <td>os390batch</td> + <td>OS390 Linker</td> + </tr> + <tr> + <td>os400</td> + <td>IccLinker</td> + </tr> + <tr> + <td>sunc89</td> + <td>C89 Linker</td> + </tr> + <tr> + <td>xlC</td> + <td>VisualAge Linker</td> + </tr> + <tr> + <td>wcl</td> + <td>OpenWatcom C/C++ linker</td> + </tr> + <tr> + <td>wfl</td> + <td>OpenWatcom FORTRAN linker</td> + </tr> + </table> +</td> +<td> +<a href="../apidocs/net/sf/antcontrib/cpptasks/LinkerEnum.html">LinkerEnum</a> +</td> +</tr> +<tr> +<td>newenvironment</td> +<td>Do not propagate old environment when new environment variables are + specified.</td> +<td>boolean</td> +</tr> +<tr> +<td>rebuild</td> +<td>If set true, all targets will be unconditionally rebuilt.</td> +<td>boolean</td> +</tr> +<tr> +<td>refid</td> +<td>Specifies that this element should behave as if the content of the + element with the matching id attribute was inserted at this location. If + specified, no other attributes or child content should be specified, + other than "if", "unless" and "description".</td> +<td>Reference</td> +</tr> +<tr> +<td>stack</td> +<td>Sets stack size in bytes.</td> +<td>FlexInteger</td> +</tr> +<tr> +<td>unless</td> +<td>Set the property name for the 'unless' condition. + + If named property is set, the configuration will be ignored. + + The value of the property is insignificant, but values that would imply + misinterpretation ("false", "no") of the behavior will throw an + exception when evaluated.</td> +<td>String</td> +</tr> +</table> +</subsection> +<subsection name="parameters as nested elements"> +<dl> +<dt> +<a href="about:blank">env</a> +</dt> +<dd>Add an environment variable to the launched process.</dd> +<dt> +<a href="ConditionalFileSet.html">fileset</a> +</dt> +<dd>Adds a source file set. + + Files in these set will be processed by this configuration and will not + participate in the auction.</dd> +<dt> +<a href="LibrarySet.html">libset</a> +</dt> +<dd>Adds a system library set.</dd> +<dt> +<a href="LinkerArgument.html">linkerarg</a> +</dt> +<dd>Adds a linker command-line arg.</dd> +<dt> +<a href="LinkerParam.html">linkerparam</a> +</dt> +<dd>Adds a compiler command-line arg.</dd> +<dt> +<a href="SystemLibrarySet.html">syslibset</a> +</dt> +<dd>Adds a system library set.</dd> +</dl> +</subsection> +</section> +</body> +</document> diff --git a/src/site/xdoc/antdocs/LinkerParam.xml b/src/site/xdoc/antdocs/LinkerParam.xml new file mode 100644 index 0000000..e5ad6a7 --- /dev/null +++ b/src/site/xdoc/antdocs/LinkerParam.xml @@ -0,0 +1,81 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + +Licensed to the Ant-Contrib Project under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The Ant-Contrib Project licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. + + --> +<document xmlns:xhtml="http://www.w3.org/1999/xhtml" xmlns:taskdocs="http://ant-contrib.sf.net/taskdocs"> +<properties> +<title>linkerparam</title> +</properties> +<body> +<section name="linkerparam"> +<subsection name="Description">Place class description here.</subsection> +<subsection name="parameters"> +<table> +<tr> +<td> +<b>Attribute</b> +</td> +<td> +<b>Description</b> +</td> +<td> +<b>Type</b> +</td> +</tr> +<tr> +<td>if</td> +<td>Sets the property name for the 'if' condition. + + The argument will be ignored unless the property is defined. + + The value of the property is insignificant, but values that would imply + misinterpretation ("false", "no") will throw an exception when + evaluated.</td> +<td>String</td> +</tr> +<tr> +<td>name</td> +<td>Specifies relative location of argument on command line. "start" will + place argument at start of command line, "mid" will place argument after + all "start" arguments but before filenames, "end" will place argument + after filenames.</td> +<td>String</td> +</tr> +<tr> +<td>unless</td> +<td>Set the property name for the 'unless' condition. + + If named property is set, the argument will be ignored. + + The value of the property is insignificant, but values that would imply + misinterpretation ("false", "no") of the behavior will throw an + exception when evaluated.</td> +<td>String</td> +</tr> +<tr> +<td>value</td> +<td>Specifies the string that should appear on the command line. The + argument will be quoted if it contains embedded blanks. Use multiple + arguments to avoid quoting.</td> +<td>String</td> +</tr> +</table> +</subsection> +</section> +</body> +</document> diff --git a/src/site/xdoc/antdocs/PrecompileDef.xml b/src/site/xdoc/antdocs/PrecompileDef.xml new file mode 100644 index 0000000..5b700f7 --- /dev/null +++ b/src/site/xdoc/antdocs/PrecompileDef.xml @@ -0,0 +1,99 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + +Licensed to the Ant-Contrib Project under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The Ant-Contrib Project licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. + + --> +<document xmlns:xhtml="http://www.w3.org/1999/xhtml" xmlns:taskdocs="http://ant-contrib.sf.net/taskdocs"> +<properties> +<title>precompile</title> +</properties> +<body> +<section name="precompile"> +<subsection name="Description">An element that specifies a prototype file and rules for source files that + should not use precompiled headers</subsection> +<subsection name="parameters"> +<table> +<tr> +<td> +<b>Attribute</b> +</td> +<td> +<b>Description</b> +</td> +<td> +<b>Type</b> +</td> +</tr> +<tr> +<td>description</td> +<td>Sets a description of the current data type.</td> +<td>String</td> +</tr> +<tr> +<td>id</td> +<td>Sets an id that can be used to reference this element.</td> +<td>String</td> +</tr> +<tr> +<td>if</td> +<td>Set the 'if' condition. + + The processor will be ignored unless the property is defined. + + The value of property is insignificant, but values that would imply + misinterpretation ("false", "no") will throw an exception when + isActive() is evaluated.</td> +<td>String</td> +</tr> +<tr> +<td>prototype</td> +<td>Sets file to precompile. + + Should be a source file that includes only one unguarded header file. + Default value is "stdafx.cpp".</td> +<td>File</td> +</tr> +<tr> +<td>refid</td> +<td>Specifies that this element should behave as if the content of the + element with the matching id attribute was inserted at this location.</td> +<td>Reference</td> +</tr> +<tr> +<td>unless</td> +<td>Set the 'unless' condition. If named property exists at execution time, + the processor will be ignored. + + Value of property is insignificant, but values that would imply + misinterpretation ("false", "no") of the behavior will throw an + exception when isActive is called.</td> +<td>String</td> +</tr> +</table> +</subsection> +<subsection name="parameters as nested elements"> +<dl> +<dt> +<a href="PrecompileExceptDef.html">except</a> +</dt> +<dd>Adds filesets that specify files that should not be processed with + precompiled headers enabled.</dd> +</dl> +</subsection> +</section> +</body> +</document> diff --git a/src/site/xdoc/antdocs/PrecompileExceptDef.xml b/src/site/xdoc/antdocs/PrecompileExceptDef.xml new file mode 100644 index 0000000..f645473 --- /dev/null +++ b/src/site/xdoc/antdocs/PrecompileExceptDef.xml @@ -0,0 +1,64 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + +Licensed to the Ant-Contrib Project under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The Ant-Contrib Project licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. + + --> +<document xmlns:xhtml="http://www.w3.org/1999/xhtml" xmlns:taskdocs="http://ant-contrib.sf.net/taskdocs"> +<properties> +<title>precompileexcept</title> +</properties> +<body> +<section name="precompileexcept"> +<subsection name="Description">Specifies files that should not be compiled using precompiled headers.</subsection> +<subsection name="parameters"> +<table> +<tr> +<td> +<b>Attribute</b> +</td> +<td> +<b>Description</b> +</td> +<td> +<b>Type</b> +</td> +</tr> +<tr> +<td>dir</td> +<td>Sets the base-directory</td> +<td>File</td> +</tr> +<tr> +<td>includes</td> +<td>Comma or space separated list of file patterns that should not be + compiled using precompiled headers.</td> +<td>String</td> +</tr> +</table> +</subsection> +<subsection name="parameters as nested elements"> +<dl> +<dt> +<a href="ConditionalFileSet.html">fileset</a> +</dt> +<dd>Adds filesets that specify files that should not be processed using + precompiled headers.</dd> +</dl> +</subsection> +</section> +</body> +</document> diff --git a/src/site/xdoc/antdocs/ProjectDef.xml b/src/site/xdoc/antdocs/ProjectDef.xml new file mode 100644 index 0000000..ebafe48 --- /dev/null +++ b/src/site/xdoc/antdocs/ProjectDef.xml @@ -0,0 +1,166 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + +Licensed to the Ant-Contrib Project under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The Ant-Contrib Project licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. + + --> +<document xmlns:xhtml="http://www.w3.org/1999/xhtml" xmlns:taskdocs="http://ant-contrib.sf.net/taskdocs"> +<properties> +<title>project</title> +</properties> +<body> +<section name="project"> +<subsection name="Description">Requests the creation of an IDE project file. Experimental. + + Implementation status: msdev5, msdev6 and cbuilderx + generate reasonable project files for simple projects, + xcode and msdev7 and msdev71 capture source file lists and + a few settings.</subsection> +<subsection name="parameters"> +<table> +<tr> +<td> +<b>Attribute</b> +</td> +<td> +<b>Description</b> +</td> +<td> +<b>Type</b> +</td> +</tr> +<tr> +<td>classname</td> +<td>Class name for a user-supplied project writer. Use the "type" + attribute to specify built-in project writer implementations.</td> +<td>String</td> +</tr> +<tr> +<td>description</td> +<td></td> +<td>String</td> +</tr> +<tr> +<td>failonerror</td> +<td>Sets whether a failure to write the project file should cause the + task to fail. Default is true.</td> +<td>boolean</td> +</tr> +<tr> +<td>if</td> +<td>Sets the property name for the 'if' condition. + + The configuration will be ignored unless the property is defined. + + The value of the property is insignificant, but values that would imply + misinterpretation ("false", "no") will throw an exception when + evaluated.</td> +<td>String</td> +</tr> +<tr> +<td>name</td> +<td>Set name.</td> +<td>String</td> +</tr> +<tr> +<td>outfile</td> +<td>Sets the name for the generated project file.</td> +<td>File</td> +</tr> +<tr> +<td>overwrite</td> +<td>Sets whether an existing project file should be overwritten, + default is true. If false and the project file exists, + the value of failonerror will determine if the task fails.</td> +<td>boolean</td> +</tr> +<tr> +<td>refid</td> +<td></td> +<td>Reference</td> +</tr> +<tr> +<td>type</td> +<td>Set project type. + + + <table> <thead>Supported project formats </thead> + <tr> + <td>cbuilderx</td> + <td>Borland C++BuilderX</td> + </tr> + <tr> + <td>msvc5</td> + <td>Microsoft Visual C++ 97</td> + </tr> + <tr> + <td>msvc6</td> + <td>Microsoft Visual C++ 6</td> + </tr> + <tr> + <td>msvc7</td> + <td>Microsoft Visual C++.NET</td> + </tr> + <tr> + <td>msvc71</td> + <td>Microsoft Visual C++.NET 2003</td> + </tr> + <tr> + <td>msvc8</td> + <td>Microsoft Visual C++ 2005</td> + </tr> + <tr> + <td>msvc9</td> + <td>Microsoft Visual C++ 2008</td> + </tr> + <tr> + <td>xcode</td> + <td>Apple Xcode</td> + </tr> + </table> +</td> +<td> +<a href="../apidocs/net/sf/antcontrib/cpptasks/ide/ProjectWriterEnum.html">ProjectWriterEnum</a> +</td> +</tr> +<tr> +<td>unless</td> +<td>Set the property name for the 'unless' condition. + + If named property is set, the configuration will be ignored. + + The value of the property is insignificant, but values that would imply + misinterpretation ("false", "no") of the behavior will throw an + exception when evaluated.</td> +<td>String</td> +</tr> +</table> +</subsection> +<subsection name="parameters as nested elements"> +<dl> +<dt> +<a href="CommentDef.html">comment</a> +</dt> +<dd>Add comment for the generated project file.</dd> +<dt> +<a href="DependencyDef.html">dependency</a> +</dt> +<dd>Add a dependency definition to the project.</dd> +</dl> +</subsection> +</section> +</body> +</document> diff --git a/src/site/xdoc/antdocs/SystemIncludePath.xml b/src/site/xdoc/antdocs/SystemIncludePath.xml new file mode 100644 index 0000000..0bb789f --- /dev/null +++ b/src/site/xdoc/antdocs/SystemIncludePath.xml @@ -0,0 +1,132 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + +Licensed to the Ant-Contrib Project under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The Ant-Contrib Project licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. + + --> +<document xmlns:xhtml="http://www.w3.org/1999/xhtml" xmlns:taskdocs="http://ant-contrib.sf.net/taskdocs"> +<properties> +<title>systemincludepath</title> +</properties> +<body> +<section name="systemincludepath"> +<subsection name="Description">A system include path. + + Files located using a system include path will not participate in dependency + analysis. + + Standard include paths for a compiler should not be specified since these + should be determined from environment variables or configuration files by + the compiler adapter. + + Works like other paths in Ant with with the addition of "if" and "unless" + conditions.</subsection> +<subsection name="parameters"> +<table> +<tr> +<td> +<b>Attribute</b> +</td> +<td> +<b>Description</b> +</td> +<td> +<b>Type</b> +</td> +</tr> +<tr> +<td>description</td> +<td></td> +<td>String</td> +</tr> +<tr> +<td>if</td> +<td>Sets the property name for the 'if' condition. + + The path will be ignored unless the property is defined. + + The value of the property is insignificant, but values that would imply + misinterpretation ("false", "no") will throw an exception when + evaluated.</td> +<td>String</td> +</tr> +<tr> +<td>location</td> +<td></td> +<td>File</td> +</tr> +<tr> +<td>path</td> +<td></td> +<td>String</td> +</tr> +<tr> +<td>refid</td> +<td></td> +<td>Reference</td> +</tr> +<tr> +<td>unless</td> +<td>Set the property name for the 'unless' condition. + + If named property is set, the path will be ignored. + + The value of the property is insignificant, but values that would imply + misinterpretation ("false", "no") of the behavior will throw an + exception when evaluated.</td> +<td>String</td> +</tr> +</table> +</subsection> +<subsection name="parameters as nested elements"> +<dl> +<dt> +<a href="http://ant.apache.org/manual/using.html#path"></a> +</dt> +<dd/> +<dt> +<a href="about:blank">dirset</a> +</dt> +<dd/> +<dt> +<a href="http://ant.apache.org/manual/using.html#path">existing</a> +</dt> +<dd/> +<dt> +<a href="http://ant.apache.org/manual/using.html#path">extdirs</a> +</dt> +<dd/> +<dt> +<a href="about:blank">filelist</a> +</dt> +<dd/> +<dt> +<a href="about:blank">fileset</a> +</dt> +<dd/> +<dt> +<a href="http://ant.apache.org/manual/using.html#path">path</a> +</dt> +<dd/> +<dt> +<a href="http://ant.apache.org/manual/using.html#path">pathelement</a> +</dt> +<dd/> +</dl> +</subsection> +</section> +</body> +</document> diff --git a/src/site/xdoc/antdocs/SystemLibrarySet.xml b/src/site/xdoc/antdocs/SystemLibrarySet.xml new file mode 100644 index 0000000..0a9b566 --- /dev/null +++ b/src/site/xdoc/antdocs/SystemLibrarySet.xml @@ -0,0 +1,116 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + +Licensed to the Ant-Contrib Project under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The Ant-Contrib Project licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. + + --> +<document xmlns:xhtml="http://www.w3.org/1999/xhtml" xmlns:taskdocs="http://ant-contrib.sf.net/taskdocs"> +<properties> +<title>syslibset</title> +</properties> +<body> +<section name="syslibset"> +<subsection name="Description">A set of system library names. Timestamp or location of system libraries are + not considered in dependency analysis. + + Libraries can also be added to a link by specifying them in a fileset. + + For most Unix-like compilers, syslibset will result in a series of -l and -L + linker arguments. For Windows compilers, the library names will be used to + locate the appropriate library files which will be added to the linkers + input file list as if they had been specified in a fileset.</subsection> +<subsection name="parameters"> +<table> +<tr> +<td> +<b>Attribute</b> +</td> +<td> +<b>Description</b> +</td> +<td> +<b>Type</b> +</td> +</tr> +<tr> +<td>casesensitive</td> +<td>Sets case sensitivity of the file system. If not set, will default to + the linker's case sensitivity.</td> +<td>boolean</td> +</tr> +<tr> +<td>dataset</td> +<td>Sets the dataset. Used on OS390 if the libs are in a dataset.</td> +<td>String</td> +</tr> +<tr> +<td>description</td> +<td></td> +<td>String</td> +</tr> +<tr> +<td>dir</td> +<td>Library directory.</td> +<td>File</td> +</tr> +<tr> +<td>if</td> +<td>Sets the property name for the 'if' condition. + + The library set will be ignored unless the property is defined. + + The value of the property is insignificant, but values that would imply + misinterpretation ("false", "no") will throw an exception when + evaluated.</td> +<td>String</td> +</tr> +<tr> +<td>libs</td> +<td>Comma-separated list of library names without leading prefixes, such as + "lib", or extensions, such as ".so" or ".a".</td> +<td> +<a href="../apidocs/net/sf/antcontrib/cpptasks/CUtil/StringArrayBuilder.html">StringArrayBuilder</a> +</td> +</tr> +<tr> +<td>refid</td> +<td></td> +<td>Reference</td> +</tr> +<tr> +<td>type</td> +<td>Sets the preferred library type. Supported values "shared", "static", and + "framework". "framework" is equivalent to "shared" on non-Darwin platforms.</td> +<td> +<a href="../apidocs/net/sf/antcontrib/cpptasks/types/LibraryTypeEnum.html">LibraryTypeEnum</a> +</td> +</tr> +<tr> +<td>unless</td> +<td>Set the property name for the 'unless' condition. + + If named property is set, the library set will be ignored. + + The value of the property is insignificant, but values that would imply + misinterpretation ("false", "no") of the behavior will throw an + exception when evaluated.</td> +<td>String</td> +</tr> +</table> +</subsection> +</section> +</body> +</document> diff --git a/src/site/xdoc/antdocs/TargetDef.xml b/src/site/xdoc/antdocs/TargetDef.xml new file mode 100644 index 0000000..6274cf7 --- /dev/null +++ b/src/site/xdoc/antdocs/TargetDef.xml @@ -0,0 +1,105 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + +Licensed to the Ant-Contrib Project under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The Ant-Contrib Project licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. + + --> +<document xmlns:xhtml="http://www.w3.org/1999/xhtml" xmlns:taskdocs="http://ant-contrib.sf.net/taskdocs"> +<properties> +<title>targetplatform</title> +</properties> +<body> +<section name="targetplatform"> +<subsection name="Description">Information on the execution platforms for the generated code. + (Non-functional prototype)</subsection> +<subsection name="parameters"> +<table> +<tr> +<td> +<b>Attribute</b> +</td> +<td> +<b>Description</b> +</td> +<td> +<b>Type</b> +</td> +</tr> +<tr> +<td>arch</td> +<td>Sets cpu architecture, compiler may use cpu specific instructions.</td> +<td> +<a href="../apidocs/net/sf/antcontrib/cpptasks/ArchEnum.html">ArchEnum</a> +</td> +</tr> +<tr> +<td>cpu</td> +<td>Sets preferred cpu, but does not use cpu specific instructions.</td> +<td> +<a href="../apidocs/net/sf/antcontrib/cpptasks/CPUEnum.html">CPUEnum</a> +</td> +</tr> +<tr> +<td>description</td> +<td>Sets a description of the current data type.</td> +<td>String</td> +</tr> +<tr> +<td>id</td> +<td>Sets an id that can be used to reference this element.</td> +<td>String</td> +</tr> +<tr> +<td>if</td> +<td>Sets the property name for the 'if' condition. + + The define will be ignored unless the property is defined. + + The value of the property is insignificant, but values that would imply + misinterpretation ("false", "no") will throw an exception when + evaluated.</td> +<td>String</td> +</tr> +<tr> +<td>osfamily</td> +<td>Sets operating system family.</td> +<td> +<a href="../apidocs/net/sf/antcontrib/cpptasks/OSFamilyEnum.html">OSFamilyEnum</a> +</td> +</tr> +<tr> +<td>refid</td> +<td>Specifies that this element should behave as if the content of the + element with the matching id attribute was inserted at this location. If + specified, no other attributes should be specified.</td> +<td>Reference</td> +</tr> +<tr> +<td>unless</td> +<td>Set the property name for the 'unless' condition. + + If named property is set, the define will be ignored. + + The value of the property is insignificant, but values that would imply + misinterpretation ("false", "no") of the behavior will throw an + exception when evaluated.</td> +<td>String</td> +</tr> +</table> +</subsection> +</section> +</body> +</document> diff --git a/src/site/xdoc/antdocs/UndefineArgument.xml b/src/site/xdoc/antdocs/UndefineArgument.xml new file mode 100644 index 0000000..533e227 --- /dev/null +++ b/src/site/xdoc/antdocs/UndefineArgument.xml @@ -0,0 +1,71 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + +Licensed to the Ant-Contrib Project under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The Ant-Contrib Project licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. + + --> +<document xmlns:xhtml="http://www.w3.org/1999/xhtml" xmlns:taskdocs="http://ant-contrib.sf.net/taskdocs"> +<properties> +<title>undefinearg</title> +</properties> +<body> +<section name="undefinearg"> +<subsection name="Description">Preprocessor macro undefinition.</subsection> +<subsection name="parameters"> +<table> +<tr> +<td> +<b>Attribute</b> +</td> +<td> +<b>Description</b> +</td> +<td> +<b>Type</b> +</td> +</tr> +<tr> +<td>if</td> +<td>Sets the property name for the 'if' condition. + + The define will be ignored unless the property is defined. + + The value of the property is insignificant, but values that would imply + misinterpretation ("false", "no") will throw an exception when + evaluated.</td> +<td>String</td> +</tr> +<tr> +<td>name</td> +<td>Set the name attribute</td> +<td>String</td> +</tr> +<tr> +<td>unless</td> +<td>Set the property name for the 'unless' condition. + + If named property is set, the define will be ignored. + + The value of the property is insignificant, but values that would imply + misinterpretation ("false", "no") of the behavior will throw an + exception when evaluated.</td> +<td>String</td> +</tr> +</table> +</subsection> +</section> +</body> +</document> diff --git a/src/site/xdoc/antdocs/VersionInfo.xml b/src/site/xdoc/antdocs/VersionInfo.xml new file mode 100644 index 0000000..37fd97b --- /dev/null +++ b/src/site/xdoc/antdocs/VersionInfo.xml @@ -0,0 +1,187 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + +Licensed to the Ant-Contrib Project under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The Ant-Contrib Project licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. + + --> +<document xmlns:xhtml="http://www.w3.org/1999/xhtml" xmlns:taskdocs="http://ant-contrib.sf.net/taskdocs"> +<properties> +<title>versioninfo</title> +</properties> +<body> +<section name="versioninfo"> +<subsection name="Description">Version Information. + + This information is applied in a platform specific manner + to embed version information into executable images. This + behavior is new and subject to change. + + On the Microsoft Windows platform, a resource is generated and added + to the set of files to be compiled. A resource compiler must + be specified to compile the generated file. + + On Unix platforms, versioninfo is currently not used. + Future versions may append fileversion to the output file name, + use compatibility version for -soname and possibly create + symbolic links.</subsection> +<subsection name="parameters"> +<table> +<tr> +<td> +<b>Attribute</b> +</td> +<td> +<b>Description</b> +</td> +<td> +<b>Type</b> +</td> +</tr> +<tr> +<td>companyname</td> +<td>Sets company name.</td> +<td>String</td> +</tr> +<tr> +<td>compatibilityversion</td> +<td>Sets compatibility version.</td> +<td>String</td> +</tr> +<tr> +<td>description</td> +<td></td> +<td>String</td> +</tr> +<tr> +<td>extends</td> +<td>Specifies that this element extends the element with id attribute with a + matching value. The configuration will be constructed from the settings + of this element, element referenced by extends, and the containing cc + element.</td> +<td>Reference</td> +</tr> +<tr> +<td>filecomments</td> +<td>Sets comments.</td> +<td>String</td> +</tr> +<tr> +<td>filedescription</td> +<td>Sets file description.</td> +<td>String</td> +</tr> +<tr> +<td>fileversion</td> +<td>Sets file version.</td> +<td>String</td> +</tr> +<tr> +<td>id</td> +<td>Sets an id that can be used to reference this element.</td> +<td>String</td> +</tr> +<tr> +<td>if</td> +<td>Sets the property name for the 'if' condition. + + The define will be ignored unless the property is defined. + + The value of the property is insignificant, but values that would imply + misinterpretation ("false", "no") will throw an exception when + evaluated.</td> +<td>String</td> +</tr> +<tr> +<td>internalname</td> +<td>Sets internal name. Internal name will automatically be + specified from build step, only set this value if + intentionally overriding that value.</td> +<td>String</td> +</tr> +<tr> +<td>language</td> +<td>Sets language.</td> +<td>String</td> +</tr> +<tr> +<td>legalcopyright</td> +<td>Sets legal copyright.</td> +<td>String</td> +</tr> +<tr> +<td>legaltrademarks</td> +<td>Sets legal trademark.</td> +<td>String</td> +</tr> +<tr> +<td>originalfilename</td> +<td>Sets original name. Only set this value if + intentionally overriding the value from the build set.</td> +<td>String</td> +</tr> +<tr> +<td>patched</td> +<td>Sets prerelease.</td> +<td>boolean</td> +</tr> +<tr> +<td>prerelease</td> +<td>Sets prerelease.</td> +<td>boolean</td> +</tr> +<tr> +<td>privatebuild</td> +<td>Sets private build.</td> +<td>String</td> +</tr> +<tr> +<td>productname</td> +<td>Sets product name.</td> +<td>String</td> +</tr> +<tr> +<td>productversion</td> +<td>Sets product version.</td> +<td>String</td> +</tr> +<tr> +<td>refid</td> +<td>Specifies that this element should behave as if the content of the + element with the matching id attribute was inserted at this location. If + specified, no other attributes should be specified.</td> +<td>Reference</td> +</tr> +<tr> +<td>specialbuild</td> +<td>Sets private build.</td> +<td>String</td> +</tr> +<tr> +<td>unless</td> +<td>Set the property name for the 'unless' condition. + + If named property is set, the define will be ignored. + + The value of the property is insignificant, but values that would imply + misinterpretation ("false", "no") of the behavior will throw an + exception when evaluated.</td> +<td>String</td> +</tr> +</table> +</subsection> +</section> +</body> +</document> |