Skip to content

Commit d074996

Browse files
ponderosaTXponderosaTX
committed
Tiny revision that fixed a few javadoc documentation bugs and elided some inscrutable commanted-out code
1 parent a6f6025 commit d074996

File tree

4 files changed

+45
-144
lines changed

4 files changed

+45
-144
lines changed

‎drjava/build.xml‎

Lines changed: 36 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,7 @@
8282
<echo message="variables may need to be defined (depending on the target invoked):" />
8383
<echo message="PATH: The 'javac' command is used for compilation;" />
8484
<echo message=" the 'java' command is used by default in testing/running; " />
85-
<echo message="JAVA8_HOME: Home folder of the Java 8 JRE or JDK." />
85+
<echo message="JAVA_HOME: Home folder of the Java JRE or JDK used for the build." />
8686
<echo message="FINDBUGS_HOME: Location of the FindBugs installation" />
8787
<echo message="" />
8888
<echo message="For control over the version of Java used to run Ant, set JAVA_HOME." />
@@ -183,7 +183,7 @@
183183
description="Compile all source files (after generating the source)">
184184
</target>
185185

186-
<target name="do-compile" depends="resolve-java8-runtime, resolve-java8-tools">
186+
<target name="do-compile" depends="resolve-java-runtime, resolve-java-tools">
187187

188188
<echo message="Compiling src directory to classes/base and classes/test with command 'javac'" />
189189

@@ -196,13 +196,13 @@
196196
</move>
197197
<echo message="jrelibs=${toString:jrelibs}" />
198198
<javac srcdir="src" destdir="classes/base" source="1.7" target="1.7"
199-
bootclasspath="${java8-runtime}" sourcepath="" includeAntRuntime="no"
199+
bootclasspath="${java-runtime}" sourcepath="" includeAntRuntime="no"
200200
executable="${java-home}/bin/javac" fork="yes" memoryMaximumSize="1024M"
201201
debug="on" optimize="off" deprecation="on" >
202202
<classpath>
203203
<!-- TODO: Remove this dependency on tools.jar by refactoring and moving all the dependent
204204
debugger code into the "platform" module -->
205-
<pathelement location="${java8-tools}" />
205+
<pathelement location="${java-tools}" />
206206
<fileset refid="libs" />
207207
<fileset refid="jrelibs" />
208208
<fileset refid="extlibs" />
@@ -517,7 +517,7 @@
517517
Documentation Targets
518518
********************* -->
519519

520-
<target name="javadoc" depends="generate-source, resolve-java8-tools, resolve-version-tag"
520+
<target name="javadoc" depends="generate-source, resolve-java-tools, resolve-version-tag"
521521
description="Generate javadocs from the source folder (after generating the source)"
522522
unless="skip-javadoc">
523523
<antcall target="do-javadoc">
@@ -533,22 +533,22 @@
533533
<javadoc sourcepath="src" packagenames="*" destdir="docs/javadoc" maxmemory="512M"
534534
access="private" Use="yes" Version="yes" Author="yes" Windowtitle="${readable-project-name} API (${version-tag})" linksource="${link-source}">
535535
<classpath>
536-
<pathelement location="${java8-tools}" />
536+
<pathelement location="${java-tools}" />
537537
<fileset refid="libs" />
538538
<pathelement location="lib/buildlib/junit.jar" />
539539
<pathelement location="lib/buildlib/netbeans-memory-leak-utils.jar" />
540540
</classpath>
541541

542542
<link href="http://docs.oracle.com/javase/8/docs/api/"/>
543543
<link href="http://junit.org/junit4/javadoc/4.12/index.html?org/junit/"/>
544-
<link href="http://drjava.org/javadoc/plt/" />
545-
<link href="http://drjava.org/javadoc/javalanglevels/" />
546-
<link href="http://drjava.org/javadoc/dynamicjava/" />
544+
<link href="http://www.cs.rice.edu/~javaplt/drjava/javadoc/plt/" />
545+
<link href="http://www.cs.rice.edu/~javaplt/drjava/javadoc/javalanglevels/" />
546+
<link href="http://www.cs.rice.edu/~javaplt/drjava/javadoc/dynamicjava/" />
547547
<!-- Additional external library APIs may be listed here -->
548548
</javadoc>
549549
</target>
550550

551-
<target name="findbugs" depends="assert-findbugs-exists, compile, resolve-java8-tools"
551+
<target name="findbugs" depends="assert-findbugs-exists, compile, resolve-java-tools"
552552
description="Generate a findbugs report (after compiling)">
553553
<taskdef name="findbugs" classpath="lib/buildlib/findbugs-ant.jar"
554554
classname="edu.umd.cs.findbugs.anttask.FindBugsTask" />
@@ -569,7 +569,7 @@
569569
<class location="classes/base" />
570570
<class location="classes/test" />
571571
<auxclasspath>
572-
<pathelement location="${java8-tools}" />
572+
<pathelement location="${java-tools}" />
573573
<pathelement location="classes/lib" />
574574
<pathelement location="lib/buildlib/junit.jar" />
575575
<pathelement location="lib/buildlib/netbeans-memory-leak-utils.jar" />
@@ -844,52 +844,52 @@
844844
Property-resolution Targets
845845
*************************** -->
846846

847-
<target name="resolve-java8-runtime">
847+
<target name="resolve-java-runtime">
848848
<!-- We rely on "location" to generate a platform-specific path; note that properties
849-
are immutable and so java8-runtime will only be set the *first* time. -->
849+
are immutable and so java-runtime will only be set the *first* time. -->
850850

851-
<property name="java8-runtime-1" location="${java-home}/lib/rt.jar" />
852-
<available property="java8-runtime" value="${java8-runtime-1}" file="${java8-runtime-1}" />
851+
<property name="java-runtime-1" location="${java-home}/lib/rt.jar" />
852+
<available property="java-runtime" value="${java-runtime-1}" file="${java-runtime-1}" />
853853

854-
<property name="java8-runtime-2" location="${java-home}/jre/lib/rt.jar" />
855-
<available property="java8-runtime" value="${java8-runtime-2}" file="${java8-runtime-2}" />
854+
<property name="java-runtime-2" location="${java-home}/jre/lib/rt.jar" />
855+
<available property="java-runtime" value="${java-runtime-2}" file="${java-runtime-2}" />
856856

857-
<property name="java8-runtime-3" location="${java-home}/../Classes/classes.jar" />
858-
<available property="java8-runtime" value="${java8-runtime-3}" file="${java8-runtime-3}" />
857+
<property name="java-runtime-3" location="${java-home}/../Classes/classes.jar" />
858+
<available property="java-runtime" value="${java-runtime-3}" file="${java-runtime-3}" />
859859

860-
<echo message="java8-runtime = ${java8-runtime}" />
860+
<echo message="java-runtime = ${java-runtime}" />
861861

862-
<fail message="Can't find rt.jar in the Java 8 home: ${java-home}" unless="java8-runtime" />
862+
<fail message="Can't find rt.jar in the Java 8 home: ${java-home}" unless="java-runtime" />
863863
</target>
864864

865-
<target name="resolve-java8-exec">
865+
<target name="resolve-java-exec">
866866
<!-- We rely on "location" to generate a platform-specific path -->
867867

868-
<property name="java8-exec-1" location="${java-home}/bin/java.exe" />
869-
<condition property="java8-exec" value="${java8-exec-1}">
868+
<property name="java-exec-1" location="${java-home}/bin/java.exe" />
869+
<condition property="java-exec" value="${java-exec-1}">
870870
<and>
871-
<available file="${java8-exec-1}" />
871+
<available file="${java-exec-1}" />
872872
<os family="windows" />
873873
</and>
874874
</condition>
875875

876-
<property name="java8-exec-2" location="${java-home}/bin/java" />
877-
<available property="java8-exec" value="${java8-exec-2}" file="${java8-exec-2}" />
876+
<property name="java-exec-2" location="${java-home}/bin/java" />
877+
<available property="java-exec" value="${java-exec-2}" file="${java-exec-2}" />
878878

879-
<fail message="Can't find the java executable in the Java 8 home: ${java-home}" unless="java8-exec" />
879+
<fail message="Can't find the java executable in the Java home: ${java-home}" unless="java-exec" />
880880
</target>
881881

882-
<target name="resolve-java8-tools">
883-
<property name="java8-tools-1" location="${java-home}/lib/tools.jar" />
884-
<available property="java8-tools" value="${java8-tools-1}" file="${java8-tools-1}" />
882+
<target name="resolve-java-tools">
883+
<property name="java-tools-1" location="${java-home}/lib/tools.jar" />
884+
<available property="java-tools" value="${java-tools-1}" file="${java-tools-1}" />
885885

886-
<property name="java8-tools-2" location="${java-home}/../lib/tools.jar" />
887-
<available property="java8-tools" value="${java8-tools-2}" file="${java8-tools-2}" />
886+
<property name="java-tools-2" location="${java-home}/../lib/tools.jar" />
887+
<available property="java-tools" value="${java-tools-2}" file="${java-tools-2}" />
888888

889-
<property name="java8-tools-3" location="${java-home}/../Classes/classes.jar" />
890-
<available property="java8-tools" value="${java8-tools-3}" file="${java8-tools-3}" />
889+
<property name="java-tools-3" location="${java-home}/../Classes/classes.jar" />
890+
<available property="java-tools" value="${java-tools-3}" file="${java-tools-3}" />
891891

892-
<fail message="Can't find tools.jar in the Java 8 home: ${java-home}" unless="java8-tools" />
892+
<fail message="Can't find tools.jar in the Java home: ${java-home}" unless="java-tools" />
893893
</target>
894894

895895
<target name="resolve-current-tools">

‎drjava/src/edu/rice/cs/drjava/model/compiler/CompilerInterface.java‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -81,8 +81,7 @@ List<? extends DJError> compile(List<? extends File> files, List<? extends File>
8181
/** @return string to display in a combo box (generally {@code getName()}) */
8282
String toString();
8383

84-
/** A compiler can instruct DrJava to include additional elements for the boot
85-
* class path of the Interactions JVM.
84+
/** A compiler can instruct DrJava to include additional elements for the boot class path of the Interactions JVM.
8685
* @return list of files on the class path
8786
*/
8887
List<File> additionalBootClassPathForInteractions();

0 commit comments

Comments
 (0)