Skip to content

Commit 6207c0d

Browse files
author
mgricken
committed
Working on documentation.
git-svn-id: file:///tmp/test-svn/trunk@5241 fe72c1cf-3628-48e9-8b72-1c46755d3cff
1 parent 522f2ab commit 6207c0d

File tree

3 files changed

+76
-11
lines changed

3 files changed

+76
-11
lines changed

‎docs/src/user/userdoc.docbook‎

Lines changed: 68 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@
7070

7171
<section id="gs-requirements">
7272
<title>System Requirements</title>
73-
<para>DrJava requires Java version 5 or later. Note that you will need to have the JDK (not the JRE) installed if you wish to use the compiler or debugger within DrJava.</para>
73+
<para>DrJava requires Java version 5 or later. Note that you will need to have the JDK (not the JRE) installed if you wish to use the debugger or create Javadoc within DrJava.</para>
7474
<para>We recommend downloading and using Sun's JDK 6 (from <ulink url="http://java.sun.com">http://java.sun.com</ulink>) for Solaris, Linux, and Windows. Other users should use the Java virtual machine that comes with their operating system (including Mac OS X).</para>
7575
<para>DrJava uses two Java Virtual Machines (one for the main program, and one for the Interactions Pane) that use Java's Remote Method Invocation (RMI) to communicate with each other. RMI uses TCP/IP as the default transport mechanism, so you must have those drivers installed. Without TCP/IP, DrJava will not start properly.</para>
7676
<para>Note that there is an incompatibility between Java's Swing
@@ -546,10 +546,11 @@ File f
546546

547547
<section id="compiling-selecting">
548548
<title>Selecting a Compiler</title>
549-
<para>DrJava supports the use of different Java compilers, such as different versions of the "Javac" compiler supplied with the JDK. DrJava will attempt to locate the your Java compiler on startup by searching for standard installation directories, but sometimes it is unable to find a compiler. In this case, it will prompt you to specify the location of a compiler, or allow you to continue using DrJava without any compiler. Note that the location of the compiler can be specified in the Preferences (see <link linkend="configuration">Configuring DrJava</link>). If more than one compiler is specified, the active compiler can be selected from a menu on the Compiler Output tab itself.
549+
<para>DrJava supports the use of different Java compilers, such as different versions of the "Javac" compiler supplied with the JDK. DrJava will attempt to locate the your Java compiler on startup by searching for standard installation directories, but sometimes it is unable to find a compiler. In this case, it will use the included Eclipse compiler instead. Note that the location of the compiler can be specified in the Preferences (see <link linkend="configuration">Configuring DrJava</link>). If more than one compiler is specified, the active compiler can be selected from a menu on the Compiler Output tab itself.
550550
<!-- You may notice that the same compiler may appear multiple times in the menu. This happens because DrJava looks for compilers in three different places: on the user classpath, the user specified location in Preferences, and in the usual locations that the compiler can be found (the default installation directory, where java is located, etc.). -->
551551
</para>
552552
<para>DrJava will only display one compiler for each major version even though you have more than one update the JDK installed (Example: you have JDK 6 Updates 10 and 14 installed; DrJava will only display JDK 6 Update 14). If you want to display all compiler versions that were found, enable "Show all compiler versions" in the Preferences (see <link linkend="configuration">Configuring DrJava</link>).</para>
553+
<para>The preferred compiler can also be selected permanently by setting the <link linkend="config-options-compiler">Compiler Preference</link> in the Compiler Options category of the Preferences. DrJava will then choose the selected compiler at startup.</para>
553554
</section>
554555
</chapter>
555556

@@ -1180,6 +1181,63 @@ start DrJava nonetheless. The dialog has three buttons.</para>
11801181
DrJava</link>).</para>
11811182
</section>
11821183

1184+
<section id="other-dialogs-generate-custom-drjava">
1185+
<title>Generate Custom drjava.jar File</title>
1186+
<para>This dialog can be found in the Tools, Advanced menu. This
1187+
dialog lets you generate a custom drjava.jar file based on the
1188+
currently running version of DrJava, and you can include additional
1189+
jar files, zip files or directories. These additional files are added
1190+
to the drjava.jar and are immediately available in the generated
1191+
DrJava application without having to set up extra classpaths.</para>
1192+
1193+
<para>If a file is contained in more than one source, the file
1194+
contained in the first source will be included; conflicting files from
1195+
sources further down the list will be skipped. Files belonging to
1196+
DrJava always take precedence.</para>
1197+
1198+
<para>Note: This implies that DrJava's manifest file will be used.</para>
1199+
1200+
<para>Please note that the added files may produce a copy of
1201+
DrJava does not work as intended, and that it will be more difficult
1202+
for us to help you with these problems. YOU ARE USING THE CUSTOM
1203+
DRJAVA.JAR FILE AT YOUR OWN RISK.</para>
1204+
1205+
<para>The dialog contains the following components:</para>
1206+
1207+
<formalpara>
1208+
<title>Output Jar File</title>
1209+
<para>The file that the custom drjava.jar should be written to.</para>
1210+
</formalpara>
1211+
1212+
<formalpara>
1213+
<title>Additional Sources</title>
1214+
<para>The list of additional jar or zip files or directories
1215+
that should be added to the custom drjava.jar file. If a file is
1216+
contained in more than one source, the file contained in the first
1217+
source will be included; conflicting files from sources further down
1218+
the list will be skipped. Files belonging to DrJava always take
1219+
precedence.The file that the custom drjava.jar should be written
1220+
to.</para>
1221+
</formalpara>
1222+
1223+
<formalpara>
1224+
<title>Check Conflicts</title>
1225+
<para>Pressing this button causes DrJava to scan itself and the additional sources to identify conflicts. If any conflicts are found, they are listed in a dialog.</para>
1226+
</formalpara>
1227+
1228+
<formalpara>
1229+
<title>Generate</title>
1230+
<para>Pressing this button lets DrJava generate the specified output file. It first checks for conflicts, though, and if conflicts are found they are displayed;
1231+
the user then has the option of aborting the generation or generating anyway.</para>
1232+
</formalpara>
1233+
1234+
<formalpara>
1235+
<title>Close</title>
1236+
<para>This closes the dialog.</para>
1237+
</formalpara>
1238+
1239+
</section>
1240+
11831241
</chapter>
11841242

11851243

@@ -1687,6 +1745,13 @@ DrJava</link>).</para>
16871745
</listitem>
16881746
</varlistentry>
16891747

1748+
<varlistentry>
1749+
<term>Compiler Preference (<varname>default.compiler.preference = No Preference</varname>)</term>
1750+
<listitem>
1751+
<para>Controls which compiler DrJava should choose when it starts. If no preference is set, DrJava will choose the newest compiler it can find.</para>
1752+
</listitem>
1753+
</varlistentry>
1754+
16901755
</variablelist>
16911756
</section>
16921757

@@ -2358,7 +2423,7 @@ url="http://drjava.org/compiz/">http://drjava.org/compiz/</ulink>.</para>
23582423
<listitem><para>Please enter a short description in the "Summary" field, and a more detailed description that includes the information from the "DrJava Errors" window in the "Detailed Description" field. Try to be as specific as you can. Here's a list of questions you might want to consider in your description:</para>
23592424
<itemizedlist>
23602425
<listitem><para>What operating system are you using?</para></listitem>
2361-
<listitem><para>What version of the Java JDK are you using (1.4.2, 1.5.0, etc.)? Do you have multiple versions of the JDK (or maybe the JRE) installed? </para></listitem>
2426+
<listitem><para>What version of the Java JDK are you using (1.5, 6, etc.)? Do you have multiple versions of the JDK (or maybe the JRE) installed? </para></listitem>
23622427
<listitem><para>Did you have a project open, or where you using just a bunch of files not part of a project?</para></listitem>
23632428
<listitem><para>What were you doing just before the error occurred? Were you compiling, saving a file, debugging, using find/replace, etc.?</para></listitem>
23642429
<listitem><para>What happened after the error occurred? Could you continue with your work, or was it so bad that you had to quit DrJava?</para></listitem>

‎drjava/lib/docs.jar‎

1.78 KB
Binary file not shown.

‎drjava/src/edu/rice/cs/drjava/ui/config/ConfigFrame.java‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1114,6 +1114,14 @@ private void _setupNotificationsPanel(ConfigPanel panel) {
11141114
"changes will not be applied until DrJava is restarted.</html>.",
11151115
false)
11161116
.setEntireColumn(true));
1117+
addOptionComponent(panel,
1118+
new BooleanOptionComponent(OptionConstants.WARN_CHANGE_DCP,
1119+
"Warn to Restart to Change Default Compiler Preference",
1120+
this,
1121+
"<html>Whether DrJava should warn the user that default compiler preference<br>" +
1122+
"changes will not be applied until DrJava is restarted.</html>.",
1123+
false)
1124+
.setEntireColumn(true));
11171125
addOptionComponent(panel,
11181126
new BooleanOptionComponent(OptionConstants.WARN_CHANGE_MISC,
11191127
"Warn to Restart to Change Preferences (other)",
@@ -1158,14 +1166,6 @@ private void _setupNotificationsPanel(ConfigPanel panel) {
11581166
"Compiz and Java Swing are incompatible and can lead to crashes.</html>",
11591167
false)
11601168
.setEntireColumn(true));
1161-
addOptionComponent(panel,
1162-
new BooleanOptionComponent(OptionConstants.WARN_CHANGE_DCP,
1163-
"Warn to Restart to Change Default Compiler Preference",
1164-
this,
1165-
"<html>Whether DrJava should warn the user that default compiler preference<br>" +
1166-
"changes will not be applied until DrJava is restarted.</html>.",
1167-
false)
1168-
.setEntireColumn(true));
11691169

11701170

11711171
addOptionComponent(panel,

0 commit comments

Comments
 (0)