summaryrefslogtreecommitdiff
path: root/src/engine/SCons/Tool/rmic.xml
diff options
context:
space:
mode:
authorLuca Falavigna <dktrkranz@debian.org>2014-04-26 15:11:58 +0200
committerLuca Falavigna <dktrkranz@debian.org>2014-04-26 15:11:58 +0200
commita3a0ab66f0da855e75e3a0e2acfb8aa106b46510 (patch)
tree5352edff1387c3d7e5a8b49ec56524f085c22782 /src/engine/SCons/Tool/rmic.xml
parent51fa4e4acb6fc8fc7a2af0fbdc21fd1e8feddb3a (diff)
parent140d836e9cd54fb67b969fd82ef7ed19ba574d40 (diff)
Merge tag 'upstream/2.3.1'
Upstream version 2.3.1
Diffstat (limited to 'src/engine/SCons/Tool/rmic.xml')
-rw-r--r--src/engine/SCons/Tool/rmic.xml55
1 files changed, 45 insertions, 10 deletions
diff --git a/src/engine/SCons/Tool/rmic.xml b/src/engine/SCons/Tool/rmic.xml
index 198a88e..1c0d10b 100644
--- a/src/engine/SCons/Tool/rmic.xml
+++ b/src/engine/SCons/Tool/rmic.xml
@@ -1,26 +1,48 @@
+<?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="rmic">
<summary>
+<para>
Sets construction variables for the &rmic; utility.
+</para>
</summary>
<sets>
-RMIC
-RMICFLAGS
-RMICCOM
-JAVACLASSSUFFIX
+<item>RMIC</item>
+<item>RMICFLAGS</item>
+<item>RMICCOM</item>
+<item>JAVACLASSSUFFIX</item>
</sets>
<uses>
-RMICCOMSTR
+<item>RMICCOMSTR</item>
</uses>
</tool>
<builder name="RMIC">
<summary>
+<para>
Builds stub and skeleton class files
for remote objects
from Java <filename>.class</filename> files.
@@ -31,7 +53,9 @@ The source can be the names of <filename>.class</filename> files,
or the objects return from the
&b-Java;
builder method.
+</para>
+<para>
If the construction variable
&cv-link-JAVACLASSDIR;
is set, either in the environment
@@ -42,8 +66,9 @@ then the value of the variable
will be stripped from the
beginning of any <filename>.class </filename>
file names.
+</para>
-<example>
+<example_commands>
classes = env.Java(target = 'classdir', source = 'src')
env.RMIC(target = 'outdir1', source = classes)
@@ -53,41 +78,51 @@ env.RMIC(target = 'outdir2',
env.RMIC(target = 'outdir3',
source = ['classes/foo.class', 'classes/bar.class'],
JAVACLASSDIR = 'classes')
-</example>
+</example_commands>
</summary>
</builder>
<cvar name="RMIC">
<summary>
+<para>
The Java RMI stub compiler.
+</para>
</summary>
</cvar>
<cvar name="RMICCOM">
<summary>
+<para>
The command line used to compile stub
and skeleton class files
from Java classes that contain RMI implementations.
Any options specified in the &cv-link-RMICFLAGS; construction variable
are included on this command line.
+</para>
</summary>
</cvar>
<cvar name="RMICCOMSTR">
<summary>
+<para>
The string displayed when compiling
stub and skeleton class files
from Java classes that contain RMI implementations.
If this is not set, then &cv-link-RMICCOM; (the command line) is displayed.
+</para>
-<example>
+<example_commands>
env = Environment(RMICCOMSTR = "Generating stub/skeleton class files $TARGETS from $SOURCES")
-</example>
+</example_commands>
</summary>
</cvar>
<cvar name="RMICFLAGS">
<summary>
+<para>
General options passed to the Java RMI stub compiler.
+</para>
</summary>
</cvar>
+
+</sconsdoc> \ No newline at end of file