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