Merge pull request #24 from emxsys/fix/javadoc

Fixed JavaDoc errors and warnings

Author: wcmatthysen

build.xml

@@ -87,7 +87,7 @@
         <javadoc destdir="${worldwind.doc.dir}/javadoc"
                  overview="${worldwind.src.dir}/overview.html"
                  encoding="UTF-8"
-                 windowtitle="NASA WorldWind" doctitle="NASA WorldWind" header="NASA WorldWind"
+                 windowtitle="WorldWindJava API" doctitle="NASA WorldWind Java-Community Edition" header="NASA WorldWind-CE"
                  splitindex="true" protected="true" nodeprecated="true" version="false" author="false" use="true"
                  maxmemory="1024m">
             <packageset dir="${worldwind.src.dir}" defaultexcludes="yes">

src/gov/nasa/worldwind/AbstractSceneController.java

@@ -1073,7 +1073,7 @@ protected void drawOrderedSurfaceRenderables(DrawContext dc)
      * gov.nasa.worldwind.render.SurfaceObject#render(gov.nasa.worldwind.render.DrawContext)} in ordered rendering mode.
      * This does nothing if the ordered surface renderable queue is empty, or if it does not contain any
      * SurfaceObjects.
-     * <p/>
+     * <p>
      * This method is called during the preRender phase, and is therefore free to modify the framebuffer contents to
      * create the composite representation.
      *

src/gov/nasa/worldwind/BasicFactory.java

@@ -94,7 +94,7 @@ public static Object create(String factoryKey, Object configSource, AVList param
      * <li>{@link gov.nasa.worldwind.ogc.wcs.wcs100.WCS100Capabilities}</li>
      * <li>{@link String} holding a file name, a name of a resource on the classpath, or a string representation of a
      * URL</li></ul>
-     * <p/>
+     * <p>
      *
      * @param configSource the configuration source. See above for supported types.
      * @param params       key-value parameters to override or supplement the information provided in the specified

src/gov/nasa/worldwind/BasicModel.java

@@ -244,7 +244,7 @@ public Extent getExtent()
 
     /**
      * {@inheritDoc}
-     * <p/>
+     * <p>
      * This implementation forwards the message each layer in the model.
      *
      * @param msg The message that was received.

src/gov/nasa/worldwind/Configuration.java

@@ -22,35 +22,35 @@
  * contents. Configurations files contain the names of classes to create at run-time, the initial model definition,
  * including the globe, elevation model and layers, and various control quantities such as cache sizes and data
  * retrieval timeouts.
- * <p/>
+ * <p>
  * The Configuration class is a singleton, but its instance is not exposed publicly. It is addressed only via static
  * methods of the class. It is constructed upon first use of any of its static methods.
- * <p/>
+ * <p>
  * When the Configuration class is first instantiated it reads the XML document <code>config/worldwind.xml</code> and
  * registers all the information there. The information can subsequently be retrieved via the class' various
  * <code>getValue</code> methods. Many WorldWind start-up objects query this information to determine the classes to
  * create. For example, the first WorldWind object created by an application is typically a {@link
  * gov.nasa.worldwind.awt.WorldWindowGLCanvas}. During construction that class causes WorldWind's internal classes to
  * be constructed, using the names of those classes drawn from the Configuration singleton, this class.
- * <p/>
+ * <p>
  * The default WorldWind configuration document is <code>config/worldwind.xml</code>. This can be changed by setting
  * the Java property <code>gov.nasa.worldwind.config.file</code> to a different file name or a valid URL prior to
  * creating any WorldWind object or invoking any static methods of WorldWind classes, including the Configuration
  * class. When an application specifies a different configuration location it typically does so in its main method prior
  * to using WorldWind. If a file is specified its location must be on the classpath. (The contents of application and
  * WorldWind jar files are typically on the classpath, in which case the configuration file may be in the jar file.)
- * <p/>
+ * <p>
  * Additionally, an application may set another Java property, <code>gov.nasa.worldwind.app.config.document</code>, to a
  * file name or URL whose contents contain configuration values to override those of the primary configuration document.
  * WorldWind overrides only those values in this application document, it leaves all others to the value specified in
  * the primary document. Applications usually specify an override document in order to specify the initial layers in the
  * model.
- * <p/>
+ * <p>
  * See <code>config/worldwind.xml</code> for documentation on setting configuration values.
- * <p/>
+ * <p>
  * Configuration values can also be set programatically via {@link Configuration#setValue(String, Object)}, but they are
  * not retroactive so affect only Configuration queries made subsequent to setting the value.
- * <p/>
+ * <p>
  * <em>Note:</em> Prior to September of 2009, configuration properties were read from the file
  * <code>config/worldwind.properties</code>. An alternate file could be specified via the
  * <code>gov.nasa.worldwind.config.file</code> Java property. These mechanisms remain available but are deprecated.
@@ -381,7 +381,7 @@ public static synchronized Double getDoubleValue(String key)
 
     /**
      * Return as a Boolean the value associated with a specified key.
-     * <p/>
+     * <p>
      * Valid values for true are '1' or anything that starts with 't' or 'T'. ie. 'true', 'True', 't' Valid values for
      * false are '0' or anything that starts with 'f' or 'F'. ie. 'false', 'False', 'f'
      *
@@ -399,7 +399,7 @@ public static synchronized Boolean getBooleanValue(String key, Boolean defaultVa
 
     /**
      * Return as a Boolean the value associated with a specified key.
-     * <p/>
+     * <p>
      * Valid values for true are '1' or anything that starts with 't' or 'T'. ie. 'true', 'True', 't' Valid values for
      * false are '0' or anything that starts with 'f' or 'F'. ie. 'false', 'False', 'f'
      *
@@ -502,10 +502,12 @@ public static String getSystemTempDirectory()
      * Returns the path to the current user's application data directory. The path returned depends on the operating
      * system on which the Java Virtual Machine is running. The following table provides the path for all supported
      * operating systems:
-     * <p/>
-     * <table> <tr><th>Operating System</th><th>Path</th></tr> <tr><td>Mac OS X</td><td>~/Library/Application
-     * Support</td></tr> <tr><td>Windows</td><td>~\\Application Data</td></tr> <tr><td>Linux, Unix,
-     * Solaris</td><td>~/</td></tr> </table>
+     * <table><caption>Returned Paths</caption>
+     * <tr><th>Operating System</th><th>Path</th></tr> 
+     * <tr><td>Mac OS X</td><td>~/Library/Application Support</td></tr> 
+     * <tr><td>Windows</td><td>~\\Application Data</td></tr> 
+     * <tr><td>Linux, Unix, Solaris</td><td>~/</td></tr> 
+     * </table>
      *
      * @return the absolute path to the current user's application data directory.
      */
@@ -647,9 +649,11 @@ public static float getJavaVersion()
      * Returns the highest OpenGL profile available on the current graphics device that is compatible with WorldWind.
      * The returned profile favors hardware acceleration over software acceleration. With JOGL version 2.0, this returns
      * the highest available profile from the following list:
-     * <p/>
-     * <ul> <li>OpenGL compatibility profile 4.x</li> <li>OpenGL compatibility profile 3.x</li> <li>OpenGL profile 1.x
-     * up to 3.0</li> </ul>
+     * <ul> 
+     * <li>OpenGL compatibility profile 4.x</li> 
+     * <li>OpenGL compatibility profile 3.x</li> 
+     * <li>OpenGL profile 1.x up to 3.0</li> 
+     * </ul>
      *
      * @return the highest compatible OpenGL profile.
      */

src/gov/nasa/worldwind/Exportable.java

@@ -12,13 +12,13 @@
  * Exportable marks an object that can be exported in different data formats. Implementing classes may support one or
  * more export formats. Formats are identified by MIME type. Call {@link #isExportFormatSupported(String)} to determine
  * if an object supports export in a certain format.
- * <p/>
+ * <p>
  * Example of use:
- * <p/>
+ * 
  * <pre>
  * // Export a PointPlacemark in KML format
  * PointPlacemark placemark;
- * <p/>
+ * 
  * StringWriter kml = new StringWriter();
  * placemark.export(KMLConstants.KML_MIME_TYPE, kml);
  * </pre>

src/gov/nasa/worldwind/SceneController.java

@@ -109,7 +109,7 @@ public interface SceneController extends WWObject, Disposable
      * Specifies the current pick point in AWT screen coordinates, or <code>null</code> to indicate that there is no
      * pick point. Each frame, this scene controller determines which objects are drawn at the pick point and places
      * them in a PickedObjectList. This list can be accessed by calling {@link #getPickedObjectList()}.
-     * <p/>
+     * <p>
      * If the pick point is <code>null</code>, this scene controller ignores the pick point and the list of objects
      * returned by getPickedObjectList is empty.
      *
@@ -130,7 +130,7 @@ public interface SceneController extends WWObject, Disposable
      * Specifies the current pick rectangle in AWT screen coordinates, or <code>null</code> to indicate that there is no
      * pick rectangle. Each frame, this scene controller determines which objects intersect the pick rectangle and
      * places them in a PickedObjectList. This list can be accessed by calling {@link #getObjectsInPickRectangle()}.
-     * <p/>
+     * <p>
      * If the pick rectangle is <code>null</code>, this scene controller ignores the pick rectangle and the list of
      * objects returned by getObjectsInPickRectangle is empty.
      *

src/gov/nasa/worldwind/StereoOptionSceneController.java

@@ -15,18 +15,17 @@
 /**
  * TODO: This file needs to be updated to implement "correct" stereo, as described at:
  * http://www.orthostereo.com/geometryopengl.html
- * <p/>
- * <p/>
+ * <p>
  * This scene controller draws in stereo, either red-blue anaglyph or device supported if the display device provides
  * stereo directly. It can also draw without applying stereo. To select stereo, prior to calling this class' constructor
  * set the Java VM property <code>gov.nasa.worldwind.stereo.mode</code> to "device" for device supported stereo (if
  * provided by the device) or "redblue" for red-blue anaglyph stereo. If the property is not set or is any other value,
  * this class does not draw in stereo.
- * <p/>
+ * <p>
  * The {@link WorldWindow} instance must support stereo in order to use device-supported stereo. A stereo
  * <code>WorldWindow</code> is selected by specifying the Java VM property described above prior to creating it. See
  * {@link gov.nasa.worldwind.awt.WorldWindowGLCanvas} for further details.
- * <p/>
+ * <p>
  * Note: The logic and much of the code here was contributed by Xander Enzmann of Mitre Corporation.
  *
  * @author tag
@@ -114,7 +113,7 @@ public boolean isHardwareStereo()
 
     /**
      * {@inheritDoc}
-     * <p/>
+     * <p>
      * If the display device is providing stereo -- {@link #isHardwareStereo()} is <code>true</code> -- this method
      * returns true even if the stereo mode is {@link AVKey#STEREO_MODE_NONE}. In this case, individual stereo images
      * are drawn for left and right eyes in order to prevent a blurred scene.
@@ -158,7 +157,7 @@ else if (AVKey.STEREO_MODE_RED_BLUE.equals(this.stereoMode) && pitchInRange)
 
     /**
      * Implement no stereo ("Mono") while using a stereo device.
-     * <p/>
+     * <p>
      * Note that this method draws the image twice, once to each of the left and right eye buffers, even when stereo is
      * not in effect. This is to prevent the stereo device from drawing blurred scenes.
      *

src/gov/nasa/worldwind/StereoSceneController.java

@@ -10,7 +10,7 @@
 
 /**
  * An interface for scene controllers that provide stereo.
- * <p/>
+ * <p>
  * Note: The {@link WorldWindow} instance must support stereo display in order to use device-supported stereo. See
  * {@link gov.nasa.worldwind.awt.WorldWindowGLCanvas} to learn how to select a stereo device.
  *
@@ -24,10 +24,10 @@ public interface StereoSceneController extends SceneController
      * gov.nasa.worldwind.avlist.AVKey#STEREO_MODE_DEVICE} to request device supported stereo, {@link
      * gov.nasa.worldwind.avlist.AVKey#STEREO_MODE_RED_BLUE} to request red-blue anaglyph stereo implemented in
      * software, or {@link gov.nasa.worldwind.avlist.AVKey#STEREO_MODE_NONE} (the default) to request no stereo effect.
-     * <p/>
+     * <p>
      * If <code>STEREO_MODE_DEVICE</code> is requested but the display device does not support stereo, stereo is not
      * applied.
-     * <p/>
+     * <p>
      * See the implementing class to determine how it detects the initial stereo mode.
      *
      * @param mode the technique used to provide the stereo effect. If null, the mode is set to {@link

src/gov/nasa/worldwind/View.java

@@ -18,19 +18,21 @@
  * follows the OpenGL convention of a right-handed coordinate system with the origin at the eye point and looking down
  * the negative Z axis. <code>View</code> also provides a transformation from eye coordinates to screen coordinates,
  * following the OpenGL convention of an origin in the lower left hand screen corner.
- * <p/>
+ * <p>
  * Most of the accessor and computation methods on <code>View</code> will use viewing state computed in the last call to
  * {@link #apply(gov.nasa.worldwind.render.DrawContext) apply}.
- * <p/>
- * The following methods return state values <i>updated in the most recent call to apply</i>. <code> <ul>
- * <li>getEyePosition</li> <li>getEyePoint</li> <li>getUpVector</li> <li>getForwardVector</li>
- * <li>getModelviewMatrix</li> <li>getViewport</li> <li>getFrustum</li> <li>getFrustumInModelCoordinates</li>
- * <li>getProjectionMatrix</li> </code> </ul>
- * <p/>
+ * <p>
+ * The following methods return state values <i>updated in the most recent call to apply</i>.<ul>
+ * <li><code>getEyePosition</code></li> <li><code>getEyePoint</code></li> 
+ * <li><code>getUpVector</code></li> <li><code>getForwardVector</code></li> 
+ * <li><code>getModelviewMatrix</code></li> <li><code>getViewport</code></li> 
+ * <li><code>getFrustum</code></li> <li><code>getFrustumInModelCoordinates</code></li> 
+ * <li><code>getProjectionMatrix</code></li> </ul> 
+ * <p>
  * The following methods return computed values using state that was updated in the most recent call to
- * <code>apply</code>. <code> <ul> <li>project</li> <li>unproject</li> <li>computeRayFromScreenPoint</li>
+ * <code>apply</code>. <ul> 
+ * <li>project</li> <li>unproject</li> <li>computeRayFromScreenPoint</li>
  * <li>computePositionFromScreenPoint</li> <li>computePixelSizeAtDistance</li> <li>computeHorizonDistance</li> </ul>
- * </code>
  *
  * @author Paul Collins
  * @version $Id: View.java 1171 2013-02-11 21:45:02Z dcollins $
@@ -47,7 +49,7 @@ public interface View extends WWObject, Restorable
     /**
      * Returns the current geographic coordinates of this view's eye position, as computed for the most recent model
      * traversal.
-     * <p/>
+     * <p>
      * Note: The value returned is not necessarily the value specified to {@link #setEyePosition(gov.nasa.worldwind.geom.Position)}
      * but is the eye position corresponding to this view's most recently applied state.
      *
@@ -68,7 +70,7 @@ public interface View extends WWObject, Restorable
     /**
      * Returns the current geographic coordinates of this view's eye position, as determined from this view's current
      * parameters.
-     * <p/>
+     * <p>
      * Note: The value returned is not necessarily the value specified to {@link #setEyePosition(gov.nasa.worldwind.geom.Position)}
      * but is the eye position corresponding to this view's current parameters.
      *