summaryrefslogtreecommitdiff
path: root/src/site/xdoc/antdocs/VersionInfo.xml
diff options
context:
space:
mode:
Diffstat (limited to 'src/site/xdoc/antdocs/VersionInfo.xml')
-rw-r--r--src/site/xdoc/antdocs/VersionInfo.xml187
1 files changed, 187 insertions, 0 deletions
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>