summaryrefslogtreecommitdiff
path: root/src/engine/SCons/Tool/mssdk.xml
diff options
context:
space:
mode:
Diffstat (limited to 'src/engine/SCons/Tool/mssdk.xml')
-rw-r--r--src/engine/SCons/Tool/mssdk.xml35
1 files changed, 31 insertions, 4 deletions
diff --git a/src/engine/SCons/Tool/mssdk.xml b/src/engine/SCons/Tool/mssdk.xml
index c5ec68d..a73bcd9 100644
--- a/src/engine/SCons/Tool/mssdk.xml
+++ b/src/engine/SCons/Tool/mssdk.xml
@@ -1,11 +1,31 @@
+<?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="mssdk">
<summary>
+<para>
Sets variables for Microsoft Platform SDK and/or Windows SDK.
Note that unlike most other Tool modules,
mssdk does not set construction variables,
@@ -16,26 +36,30 @@ the Microsoft toolchain:
<literal>%LIB%</literal>,
<literal>%LIBPATH%</literal> and
<literal>%PATH%</literal>.
+</para>
</summary>
<sets>
</sets>
<uses>
-MSSDK_DIR
-MSSDK_VERSION
-MSVS_VERSION
+<item>MSSDK_DIR</item>
+<item>MSSDK_VERSION</item>
+<item>MSVS_VERSION</item>
</uses>
</tool>
<cvar name="MSSDK_DIR">
<summary>
+<para>
The directory containing the Microsoft SDK
(either Platform SDK or Windows SDK)
to be used for compilation.
+</para>
</summary>
</cvar>
<cvar name="MSSDK_VERSION">
<summary>
+<para>
The version string of the Microsoft SDK
(either Platform SDK or Windows SDK)
to be used for compilation.
@@ -46,5 +70,8 @@ Supported versions include
<literal>2003R2</literal>
and
<literal>2003R1</literal>.
+</para>
</summary>
</cvar>
+
+</sconsdoc> \ No newline at end of file