summaryrefslogtreecommitdiffstats
path: root/doc/user/functions.xml
diff options
context:
space:
mode:
authorSteven Knight <knight@baldmt.com>2010-07-22 04:20:51 (GMT)
committerSteven Knight <knight@baldmt.com>2010-07-22 04:20:51 (GMT)
commit0e027777d2a09da586616f4acd72974feb7bf8eb (patch)
tree55ce1b8bd09263b8c5b394177450c2db5d5d3073 /doc/user/functions.xml
parent9628c70f7783023b917434f09cdcacedb8be5a85 (diff)
downloadSCons-0e027777d2a09da586616f4acd72974feb7bf8eb.zip
SCons-0e027777d2a09da586616f4acd72974feb7bf8eb.tar.gz
SCons-0e027777d2a09da586616f4acd72974feb7bf8eb.tar.bz2
Add the generated function documentation to the User's Guide as an appendix.
Fixes and refactoring in the bin/scons-proc.py script to support this. Fixes to various parts of the XML input.
Diffstat (limited to 'doc/user/functions.xml')
-rw-r--r--doc/user/functions.xml38
1 files changed, 38 insertions, 0 deletions
diff --git a/doc/user/functions.xml b/doc/user/functions.xml
new file mode 100644
index 0000000..1b1b280
--- /dev/null
+++ b/doc/user/functions.xml
@@ -0,0 +1,38 @@
+<!--
+
+ __COPYRIGHT__
+
+ Permission is hereby granted, free of charge, to any person obtaining
+ a copy of this software and associated documentation files (the
+ "Software"), to deal in the Software without restriction, including
+ without limitation the rights to use, copy, modify, merge, publish,
+ distribute, sublicense, and/or sell copies of the Software, and to
+ permit persons to whom the Software is furnished to do so, subject to
+ the following conditions:
+
+ The above copyright notice and this permission notice shall be included
+ in all copies or substantial portions of the Software.
+
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY
+ KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
+ WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+ NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+ LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+ OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+ WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+-->
+
+<para>
+
+This appendix contains descriptions of all of the
+function and construction environment methods
+in this version of &SCons;
+
+</para>
+
+<variablelist>
+
+&functions-gen;
+
+</variablelist>