summaryrefslogtreecommitdiffstats
path: root/src/engine/SCons/Scanner
diff options
context:
space:
mode:
authorDirk Baechle <dl9obn@darc.de>2013-05-03 22:05:51 (GMT)
committerDirk Baechle <dl9obn@darc.de>2013-05-03 22:05:51 (GMT)
commit4b84b4db45741fa0a0aff1753b08216e9434fcbe (patch)
tree174928381514e32e0735a6f5cad854cc315b4904 /src/engine/SCons/Scanner
parenta0e23f824f8865cb1d3eb7808a3107c7864b579a (diff)
downloadSCons-4b84b4db45741fa0a0aff1753b08216e9434fcbe.zip
SCons-4b84b4db45741fa0a0aff1753b08216e9434fcbe.tar.gz
SCons-4b84b4db45741fa0a0aff1753b08216e9434fcbe.tar.bz2
- rewrote all tool/builder docs to new SCons XSD
Diffstat (limited to 'src/engine/SCons/Scanner')
-rw-r--r--src/engine/SCons/Scanner/__init__.xml31
1 files changed, 29 insertions, 2 deletions
diff --git a/src/engine/SCons/Scanner/__init__.xml b/src/engine/SCons/Scanner/__init__.xml
index f5f7c7b..7e44434 100644
--- a/src/engine/SCons/Scanner/__init__.xml
+++ b/src/engine/SCons/Scanner/__init__.xml
@@ -1,3 +1,4 @@
+<?xml version="1.0" encoding="UTF-8"?>
<!--
__COPYRIGHT__
@@ -5,11 +6,30 @@ This file is processed by the bin/SConsDoc.py module.
See its __doc__ string for a discussion of the format.
-->
+<!DOCTYPE sconsdoc [
+<!ENTITY % scons SYSTEM '../../../../doc/scons.mod'>
+%scons;
+<!ENTITY % builders-mod SYSTEM '../../../../doc/generated/builders.mod'>
+%builders-mod;
+<!ENTITY % functions-mod SYSTEM '../../../../doc/generated/functions.mod'>
+%functions-mod;
+<!ENTITY % tools-mod SYSTEM '../../../../doc/generated/tools.mod'>
+%tools-mod;
+<!ENTITY % variables-mod SYSTEM '../../../../doc/generated/variables.mod'>
+%variables-mod;
+]>
+
+<sconsdoc xmlns="http://www.scons.org/dbxsd/v1.0"
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 scons.xsd">
+
+
<scons_function name="FindPathDirs">
<arguments signature="global">
(variable)
</arguments>
<summary>
+<para>
Returns a function
(actually a callable Python object)
intended to be used as the
@@ -24,7 +44,9 @@ directory paths that should be searched
&cv-link-CPPPATH;,
&cv-link-LIBPATH;,
etc.).
+</para>
+<para>
Note that use of
&f-FindPathDirs;
is generally preferable to
@@ -48,10 +70,13 @@ that evaluate to the same list of directories as,
in fact, the same list,
and avoid re-scanning the directories for files,
when possible.
+</para>
+<para>
Example:
+</para>
-<example>
+<example_commands>
def my_scan(node, env, path, arg):
# Code to scan file contents goes here...
return include_files
@@ -59,6 +84,8 @@ def my_scan(node, env, path, arg):
scanner = Scanner(name = 'myscanner',
function = my_scan,
path_function = FindPathDirs('MYPATH'))
-</example>
+</example_commands>
</summary>
</scons_function>
+
+</sconsdoc> \ No newline at end of file