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