diff options
Diffstat (limited to 'src/engine/SCons/Scanner/__init__.xml')
| -rw-r--r-- | src/engine/SCons/Scanner/__init__.xml | 33 |
1 files changed, 30 insertions, 3 deletions
diff --git a/src/engine/SCons/Scanner/__init__.xml b/src/engine/SCons/Scanner/__init__.xml index 9b0e46a..410f388 100644 --- a/src/engine/SCons/Scanner/__init__.xml +++ b/src/engine/SCons/Scanner/__init__.xml @@ -1,15 +1,35 @@ +<?xml version="1.0" encoding="UTF-8"?> <!-- -Copyright (c) 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011, 2012, 2013 The SCons Foundation +Copyright (c) 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011, 2012, 2013, 2014 The SCons Foundation 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.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 |