src/engine/SCons/Tool/c++.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="c++">
   8 <summary>
   9 XXX
  10 </summary>
  11 </tool>
  12
  13 <cvar name="CXX">
  14 <summary>
  15 The C++ compiler.
  16 </summary>
  17 </cvar>
  18
  19 <cvar name="CXXCOM">
  20 <summary>
  21 The command line used to compile a C++ source file to an object file.
  22 Any options specified in the &cv-link-CXXFLAGS; and
  23 &cv-link-CPPFLAGS; construction variables
  24 are included on this command line.
  25 </summary>
  26 </cvar>
  27
  28 <cvar name="CXXCOMSTR">
  29 <summary>
  30 The string displayed when a C++ source file
  31 is compiled to a (static) object file.
  32 If this is not set, then &cv-link-CXXCOM; (the command line) is displayed.
  33
  34 <example>
  35 env = Environment(CXXCOMSTR = "Compiling static object $TARGET")
  36 </example>
  37 </summary>
  38 </cvar>
  39
  40 <cvar name="CXXFLAGS">
  41 <summary>
  42 General options that are passed to the C++ compiler.
  43 By default, this includes the value of &cv-link-CCFLAGS;,
  44 so that setting &cv-CCFLAGS; affects both C and C++ compilation.
  45 If you want to add C++-specific flags,
  46 you must set or override the value of &cv-link-CXXFLAGS;.
  47 </summary>
  48 </cvar>
  49
  50 <cvar name="SHCXX">
  51 <summary>
  52 The C++ compiler used for generating shared-library objects.
  53 </summary>
  54 </cvar>
  55
  56 <cvar name="SHCXXCOM">
  57 <summary>
  58 The command line used to compile a C++ source file
  59 to a shared-library object file.
  60 Any options specified in the &cv-link-SHCXXFLAGS; and
  61 &cv-link-CPPFLAGS; construction variables
  62 are included on this command line.
  63 </summary>
  64 </cvar>
  65
  66 <cvar name="SHCXXCOMSTR">
  67 <summary>
  68 The string displayed when a C++ source file
  69 is compiled to a shared object file.
  70 If this is not set, then &cv-link-SHCXXCOM; (the command line) is displayed.
  71
  72 <example>
  73 env = Environment(SHCXXCOMSTR = "Compiling shared object $TARGET")
  74 </example>
  75 </summary>
  76 </cvar>
  77
  78 <cvar name="SHCXXFLAGS">
  79 <summary>
  80 Options that are passed to the C++ compiler
  81 to generate shared-library objects.
  82 </summary>
  83 </cvar>