Javadoc fixes

Author: markpet42

release-build.xml

@@ -90,6 +90,10 @@
                  windowtitle="NASA WorldWind" doctitle="NASA WorldWind" header="NASA WorldWind"
                  splitindex="true" protected="true" nodeprecated="true" version="false" author="false" use="true"
                  maxmemory="1024m">
+            <arg value="-Xmaxerrs" />
+            <arg value="10000" />
+            <arg value="-Xmaxwarns" />
+            <arg value="10000" />
             <packageset dir="${worldwind.src.dir}" defaultexcludes="yes">
                 <include name="gov/nasa/worldwind/**"/>
                 <include name="gov/nasa/worldwindx/**"/>

src/gov/nasa/worldwind/Configuration.java

@@ -502,8 +502,8 @@ 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
+     * <table><caption style="font-weight: bold;">Mapping</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>
      *
@@ -647,7 +647,6 @@ 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>
      *

src/gov/nasa/worldwind/View.java

@@ -22,15 +22,15 @@
  * 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>
+ * The following methods return state values <i>updated in the most recent call to apply</i>. <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>
+ * <li>getProjectionMatrix</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 $

src/gov/nasa/worldwind/WorldWind.java

@@ -232,7 +232,7 @@ public static Object createComponent(String className) throws WWRuntimeException
      * @return the new component
      *
      * @throws IllegalStateException    if no name could be found which corresponds to <code>classNameKey</code>
-     * @throws IllegalArgumentException if <code>classNameKey<code> is null
+     * @throws IllegalArgumentException if <code>classNameKey</code> is null
      * @throws WWRuntimeException       if the component could not be created
      */
     public static Object createConfigurationComponent(String classNameKey)

src/gov/nasa/worldwind/WorldWindowGLAutoDrawable.java

@@ -259,7 +259,6 @@ protected void reinitialize(GLAutoDrawable glAutoDrawable)
      * GLEventListener's dispose method indicates that the GL context has been released, and provides the listener an
      * opportunity to clean up any resources. Dispose does not imply that the component's lifecycle has ended or that
      * the application is closing. There are three cases in which dispose may be called:
-     * <p>
      * <ul> <li>The WorldWindow is removed from its parent component.</li> <li>The WorldWindow's parent frame is
      * closed.</li> <li>The application calls either GLCanvas.dispose or GLJPanel.dispose.</li> </ul>
      * <p>

src/gov/nasa/worldwind/WorldWindowImpl.java

@@ -321,15 +321,19 @@ public static GpuResourceCache createGpuResourceCache()
     }
 
     /**
-     * Configures JOGL's surface pixel scaling on the specified <code>ScalableSurface</code> to ensure backward
-     * compatibility with WorldWind applications developed prior to JOGL pixel scaling's introduction. This method is
-     * used by <code>GLCanvas</code> and <code>GLJPanel</code> to effectively disable JOGL's surface pixel scaling by
-     * requesting a 1:1 scale.
-     * <p>
-     * Since v2.2.0, JOGL defaults to using high-dpi pixel scales where possible. This causes WorldWind screen elements
-     * such as placemarks, the compass, the world map, the view controls, and the scale bar (plus many more) to appear
-     * smaller than they are intended to on screen. The high-dpi default also has the effect of degrading WorldWind
-     * rendering performance.
+     * Configures JOGL's surface pixel scaling on the specified
+     * <code>ScalableSurface</code> to ensure backward compatibility with
+     * WorldWind applications developed prior to JOGL pixel scaling's
+     * introduction.This method is used by <code>GLCanvas</code> and
+     * <code>GLJPanel</code> to effectively disable JOGL's surface pixel scaling
+     * by requesting a 1:1 scale.<p>
+     * Since v2.2.0, JOGL defaults to using high-dpi pixel scales where
+     * possible. This causes WorldWind screen elements such as placemarks, the
+     * compass, the world map, the view controls, and the scale bar (plus many
+     * more) to appear smaller than they are intended to on screen. The high-dpi
+     * default also has the effect of degrading WorldWind rendering performance.
+     *
+     * @param surface The surface to configure.
      */
     public static void configureIdentityPixelScale(ScalableSurface surface)
     {

src/gov/nasa/worldwind/animation/AnimationSupport.java

@@ -80,7 +80,7 @@ public static long getScaledTimeMillisecs(
      * Calculate the angular ratio between two angles
      * @param x The numerator
      * @param y The denominator
-     * @return The angular ratio of <code>x/y></code>
+     * @return The angular ratio of <code>x/y</code>
      */
     public static double angularRatio(Angle x, Angle y)
     {

src/gov/nasa/worldwind/cache/BasicDataFileStore.java

@@ -54,7 +54,6 @@ public class BasicDataFileStore extends AbstractFileStore
      * list to find the content type matching the cached file.
      * <p>
      * This is initialized to the following list of default content types typically used in WorldWind applications:
-     * <p>
      * <ul> <li>application/vnd.google-earth.kml+xml</li> <li>application/vnd.google-earth.kmz</li>
      * <li>model/collada+xml</li> <li>image/dds</li> <li>image/gif</li> <li>image/jpeg</li> <li>image/jpg</li>
      * <li>image/png</li> </ul>
@@ -775,7 +774,6 @@ protected String makeSuffix(String path, String contentType)
      * <p>
      * This removes the key, the value, and any trailing parameter delimiter of all private parameters in the specified
      * query string. Recognized private query parameters are as follows:
-     * <p>
      * <ul> <li>CONNECTID</li> </ul>
      *
      * @param queryString the query string to examine.

src/gov/nasa/worldwind/cache/BasicRasterServerCache.java

@@ -21,7 +21,7 @@
  * The <code>BasicRasterServerCache</code> is an implementation of the memory cache that is specific to store maximum
  * possible cacheable items, until the heap size allows. Once the memory limit is hit, it will drop ALL cached items.
  * Also, BasicRasterServerCache creates a pruner thread that removes all cached items which were not used for 20 seconds
- * or more. The least recent use timeout is configurable via the <code>setLeastRecentUseTimeout()<code> method. In
+ * or more. The least recent use timeout is configurable via the <code>setLeastRecentUseTimeout()</code> method. In
  * addition, the <code>BasicRasterServerCache</code> allocates 100MB memory and keeps only a phantom reference to the
  * allocated 100M memory. Once any part of the application needs more memory the phantom referenced memory will be
  * immediately released and the phantom reference will be added to the internal reference queue, which is monitored by

src/gov/nasa/worldwind/cache/MemoryCache.java

@@ -57,7 +57,7 @@ public interface CacheListener
     void removeCacheListener(CacheListener listener);
 
     /**
-     * Discovers whether or not this cache contains the object referenced by <code> key. Currently no interface exists
+     * Discovers whether or not this cache contains the object referenced by <code> key </code>. Currently no interface exists
      * to discover if an object resides in the cache by referencing itself.
      *
      * @param key the key which the object is referenced by.