summaryrefslogtreecommitdiff
path: root/src/engine/SCons/Tool/midl.xml
diff options
context:
space:
mode:
Diffstat (limited to 'src/engine/SCons/Tool/midl.xml')
-rw-r--r--src/engine/SCons/Tool/midl.xml49
1 files changed, 42 insertions, 7 deletions
diff --git a/src/engine/SCons/Tool/midl.xml b/src/engine/SCons/Tool/midl.xml
index 51693db..272ebac 100644
--- a/src/engine/SCons/Tool/midl.xml
+++ b/src/engine/SCons/Tool/midl.xml
@@ -1,36 +1,60 @@
+<?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="midl">
<summary>
+<para>
Sets construction variables for the Microsoft IDL compiler.
+</para>
</summary>
<sets>
-MIDL
-MIDLFLAGS
-MIDLCOM
+<item>MIDL</item>
+<item>MIDLFLAGS</item>
+<item>MIDLCOM</item>
</sets>
<uses>
-MIDLCOMSTR
+<item>MIDLCOMSTR</item>
</uses>
</tool>
<builder name="TypeLibrary">
<summary>
+<para>
Builds a Windows type library (<filename>.tlb</filename>)
file from an input IDL file (<filename>.idl</filename>).
In addition, it will build the associated inteface stub and
proxy source files,
naming them according to the base name of the <filename>.idl</filename> file.
For example,
+</para>
-<example>
+<example_commands>
env.TypeLibrary(source="foo.idl")
-</example>
+</example_commands>
+<para>
Will create <filename>foo.tlb</filename>,
<filename>foo.h</filename>,
<filename>foo_i.c</filename>,
@@ -38,31 +62,42 @@ Will create <filename>foo.tlb</filename>,
and
<filename>foo_data.c</filename>
files.
+</para>
</summary>
</builder>
<cvar name="MIDL">
<summary>
+<para>
The Microsoft IDL compiler.
+</para>
</summary>
</cvar>
<cvar name="MIDLCOM">
<summary>
+<para>
The command line used to pass files to the Microsoft IDL compiler.
+</para>
</summary>
</cvar>
<cvar name="MIDLCOMSTR">
<summary>
+<para>
The string displayed when
the Microsoft IDL copmiler is called.
If this is not set, then &cv-link-MIDLCOM; (the command line) is displayed.
+</para>
</summary>
</cvar>
<cvar name="MIDLFLAGS">
<summary>
+<para>
General options passed to the Microsoft IDL compiler.
+</para>
</summary>
</cvar>
+
+</sconsdoc> \ No newline at end of file