summaryrefslogtreecommitdiff
path: root/src/engine/SCons/Tool/c++.xml
diff options
context:
space:
mode:
Diffstat (limited to 'src/engine/SCons/Tool/c++.xml')
-rw-r--r--src/engine/SCons/Tool/c++.xml79
1 files changed, 59 insertions, 20 deletions
diff --git a/src/engine/SCons/Tool/c++.xml b/src/engine/SCons/Tool/c++.xml
index c8da67c..30b93f1 100644
--- a/src/engine/SCons/Tool/c++.xml
+++ b/src/engine/SCons/Tool/c++.xml
@@ -1,102 +1,141 @@
+<?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">
+
<tool name="cXX">
<summary>
+<para>
Sets construction variables for generic POSIX C++ compilers.
+</para>
</summary>
<sets>
-CXX
-CXXFLAGS
-CXXCOM
-SHCXX
-SHCXXFLAGS
-SHCXXCOM
-CPPDEFPREFIX
-CPPDEFSUFFIX
-INCPREFIX
-INCSUFFIX
-SHOBJSUFFIX
-OBJSUFFIX
-<!--STATIC_AND_SHARED_OBJECTS_ARE_THE_SAME-->
-CXXFILESUFFIX
+<item>CXX</item>
+<item>CXXFLAGS</item>
+<item>CXXCOM</item>
+<item>SHCXX</item>
+<item>SHCXXFLAGS</item>
+<item>SHCXXCOM</item>
+<item>CPPDEFPREFIX</item>
+<item>CPPDEFSUFFIX</item>
+<item>INCPREFIX</item>
+<item>INCSUFFIX</item>
+<item>SHOBJSUFFIX</item>
+<item>OBJSUFFIX</item>
+<item><!--STATIC_AND_SHARED_OBJECTS_ARE_THE_SAME--></item>
+<item>CXXFILESUFFIX</item>
</sets>
<uses>
-CXXCOMSTR
+<item>CXXCOMSTR</item>
</uses>
</tool>
<cvar name="CXX">
<summary>
+<para>
The C++ compiler.
+</para>
</summary>
</cvar>
<cvar name="CXXCOM">
<summary>
+<para>
The command line used to compile a C++ source file to an object file.
Any options specified in the &cv-link-CXXFLAGS; and
&cv-link-CPPFLAGS; construction variables
are included on this command line.
+</para>
</summary>
</cvar>
<cvar name="CXXCOMSTR">
<summary>
+<para>
The string displayed when a C++ source file
is compiled to a (static) object file.
If this is not set, then &cv-link-CXXCOM; (the command line) is displayed.
+</para>
-<example>
+<example_commands>
env = Environment(CXXCOMSTR = "Compiling static object $TARGET")
-</example>
+</example_commands>
</summary>
</cvar>
<cvar name="CXXFLAGS">
<summary>
+<para>
General options that are passed to the C++ compiler.
By default, this includes the value of &cv-link-CCFLAGS;,
so that setting &cv-CCFLAGS; affects both C and C++ compilation.
If you want to add C++-specific flags,
you must set or override the value of &cv-link-CXXFLAGS;.
+</para>
</summary>
</cvar>
<cvar name="SHCXX">
<summary>
+<para>
The C++ compiler used for generating shared-library objects.
+</para>
</summary>
</cvar>
<cvar name="SHCXXCOM">
<summary>
+<para>
The command line used to compile a C++ source file
to a shared-library object file.
Any options specified in the &cv-link-SHCXXFLAGS; and
&cv-link-CPPFLAGS; construction variables
are included on this command line.
+</para>
</summary>
</cvar>
<cvar name="SHCXXCOMSTR">
<summary>
+<para>
The string displayed when a C++ source file
is compiled to a shared object file.
If this is not set, then &cv-link-SHCXXCOM; (the command line) is displayed.
+</para>
-<example>
+<example_commands>
env = Environment(SHCXXCOMSTR = "Compiling shared object $TARGET")
-</example>
+</example_commands>
</summary>
</cvar>
<cvar name="SHCXXFLAGS">
<summary>
+<para>
Options that are passed to the C++ compiler
to generate shared-library objects.
+</para>
</summary>
</cvar>
+
+</sconsdoc> \ No newline at end of file