Documentation update: Java for Mac OS X Lion, Sun --> Oracle.

mgricken · mgricken · commit d39fc44a2b40 · 2011-07-29T16:29:48.000Z
M    drjava/lib/docs.jar
M    docs/src/quickstart/quickstart.docbook
M    docs/src/user/userdoc.docbook


git-svn-id: file:///tmp/test-svn/trunk@5435 fe72c1cf-3628-48e9-8b72-1c46755d3cff
diff --git a/docs/src/quickstart/quickstart.docbook b/docs/src/quickstart/quickstart.docbook
@@ -35,14 +35,14 @@ introduce you to some of its key features.</para>
 
     <section id="downloadJDK">
       <title>Downloading the JDK</title>
-      <para> To compile programs in DrJava, you must make sure you have a Java JDK (Java Development Kit) installed on your machine.  All Java distributions available for downloading come in two forms: a JDK and a JRE (Java Runtime Environment).  A JDK distribution consists of a JRE distribution (a Java Virtual Machine implementation) plus a collection of development tools including <command>javac</command>, a Java compiler, and <command>javadoc</command>, Java documentation generator. DrJava requires a JDK installation because it uses both <command>javac</command> and <command>javadoc</command> as plugin components.  Without these components, DrJava can only edit Java programs; it cannot execute them or generate documentation for them. If you do not have a JDK installed already, you can download one for Windows, Linux, or Solaris computers directly from the Sun Microsystems webite.  Apple Macintosh machines running Mac OS X already have a JDK installed.  To download a JDK from the Sun website, just follow these steps!  </para>
+      <para> To compile programs in DrJava, you must make sure you have a Java JDK (Java Development Kit) installed on your machine.  All Java distributions available for downloading come in two forms: a JDK and a JRE (Java Runtime Environment).  A JDK distribution consists of a JRE distribution (a Java Virtual Machine implementation) plus a collection of development tools including <command>javac</command>, a Java compiler, and <command>javadoc</command>, Java documentation generator. DrJava requires a JDK installation because it uses both <command>javac</command> and <command>javadoc</command> as plugin components.  Without these components, DrJava can only edit Java programs; it cannot execute them or generate documentation for them. If you do not have a JDK installed already, you can download one for Windows, Linux, or Solaris computers directly from the Oracle webite.  Apple Macintosh machines running Mac OS X already have a JDK installed.  To download a JDK from the Oracle website, just follow these steps!  </para>
 
 <itemizedlist mark="number">
 	<listitem> <para>
-   	 Go to <ulink url="http://java.sun.com">http://java.sun.com.</ulink>
+   	 Go to <ulink url="http://www.oracle.com/technetwork/java/javase/downloads/index.html">http://www.oracle.com/technetwork/java/javase/downloads/index.html</ulink>,
 	</para> </listitem>
 	<listitem> <para>
-	Do a search for "Download Java JDK"
+	Do a search for "JDK"
 	</para> </listitem>
 	<listitem> <para>
 	Select the most recent build of Java from the list of options you see.  We recommend Java 6, assuming that you are using a current release of DrJava.  Recent releases of DrJava are not compatible with versions of the JDK prior to Java 5 (previously called Java 1.5.0).  Older versions of DrJava are compatible with Java 1.3 and Java 1.4.
@@ -347,7 +347,7 @@ read -1, indicating of the end of the stream.</para>
 
     <section id="javadocgen">
       <title>Generating JavaDoc Documentation</title>
-	<para>DrJava offers the ability to generate JavaDoc documentation for the user's java files.  For information about what JavaDoc is and how to format your comments to take advantage of it, see <ulink url="http://java.sun.com/j2se/javadoc/writingdoccomments/index.html">http://java.sun.com/j2se/javadoc/writingdoccomments/index.html</ulink>.</para>
+	<para>DrJava offers the ability to generate JavaDoc documentation for the user's java files.  For information about what JavaDoc is and how to format your comments to take advantage of it, see <ulink url="http://www.oracle.com/technetwork/java/javase/documentation/index-137868.html">http://www.oracle.com/technetwork/java/javase/documentation/index-137868.html</ulink>.</para>
 
 	<para>To generate JavaDoc for all files in the same directories as your open files, click the "JavaDoc" button on the toolbar.  You will then be asked where you want to save the javadoc files.  Select a location and click OK.  Your JavaDoc will be generated for you.</para>
 
diff --git a/docs/src/user/userdoc.docbook b/docs/src/user/userdoc.docbook
@@ -71,15 +71,16 @@
     <section id="gs-requirements">
       <title>System Requirements</title>
       <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>
-      <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>
+      <para>We recommend downloading and using Oracle's JDK 6 (from <ulink url="http://www.oracle.com/technetwork/java/javase/downloads/index.html">http://www.oracle.com/technetwork/java/javase/downloads/index.html</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>
+      <para>Mac OS X 10.7 "Lion" does not include a default Java runtime anymore. Therefore, the operating system may prompt you to install Java if you have not installed it before. You can also download <ulink url="http://support.apple.com/kb/DL1421">Java for OS X Lion</ulink> from Apple's website, or <ulink url="http://support.apple.com/kb/index?page=search&amp;fac=Downloads&amp;q=java%20for%20os%20x&amp;src=support_site.kbase.search.advanced">search for Java downloads for Mac OS X</ulink>.</para>
       <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>
       <para>Note that there is an incompatibility between Java's Swing
 GUI library and the Compiz window manager on Linux. We, the developers
 of DrJava, cannot do anything to fix this problem. We hope that future
 versions of Java and Compiz will address the incompatibility. In the
 meantime, we recommend that you disable Compiz if you experience
 problems. We also suggest that you use the latest versions of Compiz
-and Java, so you can benefit from possible bug fixes made by Sun and
+and Java, so you can benefit from possible bug fixes made by Oracle and
 the Compiz developers. For more information, see <ulink url="http://drjava.org/compiz/">http://drjava.org/compiz/</ulink>.</para>
     </section>
 
@@ -957,9 +958,9 @@ can be compiled by the regular Java compiler.</para>
   <!-- Chapter: Javadoc Integration -->
   <chapter id="javadoc">
     <title>Documentation with Javadoc</title>
-    <para>Documenting your code is crucial to help others understand it, and even to remind yourself how your own older programs work.  Unfortunately, it is easy for most external documentation to become out of date as a program changes.  For this reason, it is useful to write documentation as comments in the code itself, where they can be easily updated with other changes.  Javadoc is a documentation tool which defines a standard format for such comments, and which can generate HTML files to view the documentation from a web broswer.  (As an example, see Sun's Javadoc documentation for the Java libraries at <ulink url="http://java.sun.com/j2se/1.4/docs/api/index.html">http://java.sun.com/j2se/1.4/docs/api/index.html</ulink>.)</para>
+    <para>Documenting your code is crucial to help others understand it, and even to remind yourself how your own older programs work.  Unfortunately, it is easy for most external documentation to become out of date as a program changes.  For this reason, it is useful to write documentation as comments in the code itself, where they can be easily updated with other changes.  Javadoc is a documentation tool which defines a standard format for such comments, and which can generate HTML files to view the documentation from a web broswer.  (As an example, see Oracle's Javadoc documentation for the Java libraries at <ulink url="http://download.oracle.com/javase/6/docs/api/">http://download.oracle.com/javase/6/docs/api/</ulink>.)</para>
 
-    <para>You can easily run Javadoc over your programs from within DrJava, using the "Javadoc All Documents" and "Preview Javadoc for Current Document" commands in the Tools menu.  These commands will generate Javadoc HTML files from the comments you have written and display them in a browser.  This chapter gives a brief overview of these commands and how to write Javadoc comments.  More detailed information on writing Javadoc comments can be found online at <ulink url="http://java.sun.com/j2se/javadoc/writingdoccomments/">http://java.sun.com/j2se/javadoc/writingdoccomments/</ulink>.</para>
+    <para>You can easily run Javadoc over your programs from within DrJava, using the "Javadoc All Documents" and "Preview Javadoc for Current Document" commands in the Tools menu.  These commands will generate Javadoc HTML files from the comments you have written and display them in a browser.  This chapter gives a brief overview of these commands and how to write Javadoc comments.  More detailed information on writing Javadoc comments can be found online at <ulink url="http://www.oracle.com/technetwork/java/javase/documentation/index-137868.html">http://www.oracle.com/technetwork/java/javase/documentation/index-137868.html</ulink>.</para>
 
 
     <section id="javadoc-writing">
@@ -1034,7 +1035,7 @@ public class Student {
 
     <formalpara>
       <title>Configuring Javadoc</title>
-      <para>You can configure many aspects of how Javadoc files are generated.  Most prominent is the ability to hide fields and methods below a particular access level (eg. <literal>public</literal> or <literal>protected</literal>).  By default, no private fields or methods are shown.  Other options include specifying a URL to link to the Java library API (which defaults to Sun's own website), specifying a default destination directory for all Javadoc files, and specifying any custom parameters to pass to the Javadoc tool itself.  Finally, for programs with many nested packages (folders), DrJava provides an option to always generate Javadoc for all packages in the program, rather than just the sub-packages of the open documents.</para>
+      <para>You can configure many aspects of how Javadoc files are generated.  Most prominent is the ability to hide fields and methods below a particular access level (eg. <literal>public</literal> or <literal>protected</literal>).  By default, no private fields or methods are shown.  Other options include specifying a URL to link to the Java library API (which defaults to Oracle's own website), specifying a default destination directory for all Javadoc files, and specifying any custom parameters to pass to the Javadoc tool itself.  Finally, for programs with many nested packages (folders), DrJava provides an option to always generate Javadoc for all packages in the program, rather than just the sub-packages of the open documents.</para>
     </formalpara>    
 
     </section>
@@ -1168,13 +1169,13 @@ pane (see <link linkend="configuration">Configuring DrJava</link>).</para>
     <section id="other-dialogs-compiz">
       <title>Compiz Detected</title>
       <para>DrJava suffers from an incompatibility between the Linux
-window manager Compiz and Sun's Swing Java GUI library. We, the
+window manager Compiz and Oracle's Swing Java GUI library. We, the
 developers of DrJava, cannot do anything to fix this problem. We hope
 that future versions of Java and Compiz will address the
 incompatibility. In the meantime, we recommend that you disable Compiz
 if you experience problems. We also suggest that you use the latest
 versions of Compiz and Java, so you can benefit from possible bug
-fixes made by Sun and the Compiz developers. For more information, see
+fixes made by Oracle and the Compiz developers. For more information, see
 <ulink
 url="http://drjava.org/compiz/">http://drjava.org/compiz/</ulink>.</para>
       <para>When DrJava detects that you are using Compiz, it will
@@ -2105,13 +2106,13 @@ to.</para>
    <listitem>
      <para>Whether DrJava should warn the user if Compiz is
 detected (see <link linkend="other-dialogs-compiz">Compiz Detected</link> dialog). DrJava suffers from an incompatibility between the Linux
-window manager Compiz and Sun's Swing Java GUI library. We, the
+window manager Compiz and Oracle's Swing Java GUI library. We, the
 developers of DrJava, cannot do anything to fix this problem. We hope
 that future versions of Java and Compiz will address the
 incompatibility. In the meantime, we recommend that you disable Compiz
 if you experience problems. We also suggest that you use the latest
 versions of Compiz and Java, so you can benefit from possible bug
-fixes made by Sun and the Compiz developers. For more information, see
+fixes made by Oracle and the Compiz developers. For more information, see
 <ulink
 url="http://drjava.org/compiz/">http://drjava.org/compiz/</ulink>.</para>
    </listitem>
diff --git a/drjava/lib/docs.jar b/drjava/lib/docs.jar
