summaryrefslogtreecommitdiff
path: root/src/engine/SCons/Tool/javah.xml
diff options
context:
space:
mode:
Diffstat (limited to 'src/engine/SCons/Tool/javah.xml')
-rw-r--r--src/engine/SCons/Tool/javah.xml59
1 files changed, 48 insertions, 11 deletions
diff --git a/src/engine/SCons/Tool/javah.xml b/src/engine/SCons/Tool/javah.xml
index 6244000..1c99bca 100644
--- a/src/engine/SCons/Tool/javah.xml
+++ b/src/engine/SCons/Tool/javah.xml
@@ -1,27 +1,49 @@
+<?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="javah">
<summary>
+<para>
Sets construction variables for the &javah; tool.
+</para>
</summary>
<sets>
-JAVAH
-JAVAHFLAGS
-JAVAHCOM
-JAVACLASSSUFFIX
+<item>JAVAH</item>
+<item>JAVAHFLAGS</item>
+<item>JAVAHCOM</item>
+<item>JAVACLASSSUFFIX</item>
</sets>
<uses>
-JAVAHCOMSTR
-JAVACLASSPATH
+<item>JAVAHCOMSTR</item>
+<item>JAVACLASSPATH</item>
</uses>
</tool>
<builder name="JavaH">
<summary>
+<para>
Builds C header and source files for
implementing Java native methods.
The target can be either a directory
@@ -35,7 +57,9 @@ by calling the &b-link-Java; builder method,
or the objects returned from the
&b-Java;
builder method.
+</para>
+<para>
If the construction variable
&cv-link-JAVACLASSDIR;
is set, either in the environment
@@ -45,10 +69,13 @@ builder method itself,
then the value of the variable
will be stripped from the
beginning of any <filename>.class</filename> file names.
+</para>
+<para>
Examples:
+</para>
-<example>
+<example_commands>
# builds java_native.h
classes = env.Java(target = 'classdir', source = 'src')
env.JavaH(target = 'java_native.h', source = classes)
@@ -61,40 +88,50 @@ env.JavaH(target = 'include',
env.JavaH(target = 'export',
source = ['classes/foo.class', 'classes/bar.class'],
JAVACLASSDIR = 'classes')
-</example>
+</example_commands>
</summary>
</builder>
<cvar name="JAVAH">
<summary>
+<para>
The Java generator for C header and stub files.
+</para>
</summary>
</cvar>
<cvar name="JAVAHCOM">
<summary>
+<para>
The command line used to generate C header and stub files
from Java classes.
Any options specified in the &cv-link-JAVAHFLAGS; construction variable
are included on this command line.
+</para>
</summary>
</cvar>
<cvar name="JAVAHCOMSTR">
<summary>
+<para>
The string displayed when C header and stub files
are generated from Java classes.
If this is not set, then &cv-link-JAVAHCOM; (the command line) is displayed.
+</para>
-<example>
+<example_commands>
env = Environment(JAVAHCOMSTR = "Generating header/stub file(s) $TARGETS from $SOURCES")
-</example>
+</example_commands>
</summary>
</cvar>
<cvar name="JAVAHFLAGS">
<summary>
+<para>
General options passed to the C header and stub file generator
for Java classes.
+</para>
</summary>
</cvar>
+
+</sconsdoc> \ No newline at end of file