src/engine/SCons/Tool/javac.xml

   1 <!--
   2 __COPYRIGHT__
   3
   4 This file is processed by the bin/SConsDoc.py module.
   5 See its __doc__ string for a discussion of the format.
   6 -->
   7 <tool name="javac">
   8 <summary>
   9 XXX
  10 </summary>
  11 </tool>
  12
  13 <builder name="Java">
  14 <summary>
  15 Builds one or more Java class files
  16 from one or more source trees of <filename>.java</filename> files.
  17 The class files will be placed underneath
  18 the specified target directory.
  19 SCons will parse each source <filename>.java</filename> file
  20 to find the classes
  21 (including inner classes)
  22 defined within that file,
  23 and from that figure out the
  24 target <filename>.class</filename> files that will be created.
  25 SCons will also search each Java file
  26 for the Java package name,
  27 which it assumes can be found on a line
  28 beginning with the string
  29 <literal>package</literal>
  30 in the first column;
  31 the resulting <filename>.class</filename> files
  32 will be placed in a directory reflecting
  33 the specified package name.
  34 For example,
  35 the file
  36 <filename>Foo.java</filename>
  37 defining a single public
  38 <classname>Foo</classname>
  39 class and
  40 containing a package name of
  41 <classname>sub.dir</classname>
  42 will generate a corresponding
  43 <filename>sub/dir/Foo.class</filename>
  44 class file.
  45
  46 Example:
  47
  48 <example>
  49 env.Java(target = 'classes', source = 'src')
  50 env.Java(target = 'classes', source = ['src1', 'src2'])
  51 </example>
  52 </summary>
  53 </builder>
  54
  55 <cvar name="JAVAC">
  56 <summary>
  57 The Java compiler.
  58 </summary>
  59 </cvar>
  60
  61 <cvar name="JAVACCOM">
  62 <summary>
  63 The command line used to compile a directory tree containing
  64 Java source files to
  65 corresponding Java class files.
  66 Any options specified in the &cv-link-JAVACFLAGS; construction variable
  67 are included on this command line.
  68 </summary>
  69 </cvar>
  70
  71 <cvar name="JAVACCOMSTR">
  72 <summary>
  73 The string displayed when compiling
  74 a directory tree of Java source files to
  75 corresponding Java class files.
  76 If this is not set, then &cv-link-JAVACCOM; (the command line) is displayed.
  77
  78 <example>
  79 env = Environment(JAVACCOMSTR = "Compiling class files $TARGETS from $SOURCES")
  80 </example>
  81 </summary>
  82 </cvar>
  83
  84 <cvar name="JAVACFLAGS">
  85 <summary>
  86 General options that are passed to the Java compiler.
  87 </summary>
  88 </cvar>
  89
  90 <cvar name="JAVACLASSDIR">
  91 <summary>
  92 The directory in which Java class files may be found.
  93 This is stripped from the beginning of any Java .class
  94 file names supplied to the
  95 <literal>JavaH</literal>
  96 builder.
  97 </summary>
  98 </cvar>
  99
 100 <cvar name="JAVACLASSSUFFIX">
 101 <summary>
 102 The suffix for Java class files;
 103 <filename>.class</filename>
 104 by default.
 105 </summary>
 106 </cvar>
 107
 108 <cvar name="JAVASUFFIX">
 109 <summary>
 110 The suffix for Java files;
 111 <filename>.java</filename>
 112 by default.
 113 </summary>
 114 </cvar>