src/engine/SCons/Tool/swig.xml

   1 <!--
   2 __COPYRIGHT__
   3
   4 This file is processed by the bin/SConsDoc.py module.
   5 See its __doc__ string for a discussion of the format.
   6 -->
   7 <tool name="swig">
   8 <summary>
   9 XXX
  10 </summary>
  11 </tool>
  12
  13 <cvar name="SWIG">
  14 <summary>
  15 The scripting language wrapper and interface generator.
  16 </summary>
  17 </cvar>
  18
  19 <cvar name="SWIGCFILESUFFIX">
  20 <summary>
  21 The suffix that will be used for intermediate C
  22 source files generated by
  23 the scripting language wrapper and interface generator.
  24 The default value is
  25 <filename>_wrap</filename>&cv-link-CFILESUFFIX;.
  26 By default, this value is used whenever the
  27 <option>-c++</option>
  28 option is
  29 <emphasis>not</emphasis>
  30 specified as part of the
  31 &cv-link-SWIGFLAGS;
  32 construction variable.
  33 </summary>
  34 </cvar>
  35
  36 <cvar name="SWIGCOM">
  37 <summary>
  38 The command line used to call
  39 the scripting language wrapper and interface generator.
  40 </summary>
  41 </cvar>
  42
  43 <cvar name="SWIGCOMSTR">
  44 <summary>
  45 The string displayed when calling
  46 the scripting language wrapper and interface generator.
  47 If this is not set, then &cv-link-SWIGCOM; (the command line) is displayed.
  48 </summary>
  49 </cvar>
  50
  51 <cvar name="SWIGCXXFILESUFFIX">
  52 <summary>
  53 The suffix that will be used for intermediate C++
  54 source files generated by
  55 the scripting language wrapper and interface generator.
  56 The default value is
  57 <filename>_wrap</filename>&cv-link-CFILESUFFIX;.
  58 By default, this value is used whenever the
  59 <filename>-c++</filename>
  60 option is specified as part of the
  61 &cv-link-SWIGFLAGS;
  62 construction variable.
  63 </summary>
  64 </cvar>
  65
  66 <cvar name="SWIGFLAGS">
  67 <summary>
  68 General options passed to
  69 the scripting language wrapper and interface generator.
  70 This is where you should set
  71 <option>-python</option>,
  72 <option>-perl5</option>,
  73 <option>-tcl</option>,
  74 or whatever other options you want to specify to SWIG.
  75 If you set the
  76 <option>-c++</option>
  77 option in this variable,
  78 &scons;
  79 will, by default,
  80 generate a C++ intermediate source file
  81 with the extension that is specified as the
  82 &cv-link-CXXFILESUFFIX;
  83 variable.
  84 </summary>
  85 </cvar>