Skip to content

Commit ffabb74

Browse files
committed
Javadoc fixes
1 parent 2c66130 commit ffabb74

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

54 files changed

+1421
-1568
lines changed

src/gov/nasa/worldwind/data/package-info.java

Lines changed: 795 additions & 0 deletions
Large diffs are not rendered by default.

src/gov/nasa/worldwind/data/package.html

Lines changed: 0 additions & 805 deletions
This file was deleted.
Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
/*
2+
* Copyright (C) 2012 United States Government as represented by the Administrator of the
3+
* National Aeronautics and Space Administration.
4+
* All Rights Reserved.
5+
*/
6+
7+
/**
8+
* <p>
9+
* Provides classes for representing the shape and terrain of a planet. A {@link gov.nasa.worldwind.globes.Globe} is
10+
* part of a {@link gov.nasa.worldwind.Model}, and provides methods for converting between geographic and Cartesian
11+
* coordinates. {@link gov.nasa.worldwind.globes.EllipsoidalGlobe} captures features of globes modelled with an
12+
* ellipsoid, and {@link gov.nasa.worldwind.globes.Earth} is an ellipsoidal model of the Earth using the <a
13+
* href="http://en.wikipedia.org/wiki/World_Geodetic_System" target="_blank">World Geodetic System</a> (WGS84).
14+
* {@link gov.nasa.worldwind.globes.FlatGlobe} represents a globe projected onto a plane.</p>
15+
*
16+
*/
17+
package gov.nasa.worldwind.globes;

src/gov/nasa/worldwind/globes/package.html

Lines changed: 0 additions & 24 deletions
This file was deleted.
Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
/*
2+
* Copyright (C) 2012 United States Government as represented by the Administrator of the
3+
* National Aeronautics and Space Administration.
4+
* All Rights Reserved.
5+
*/
6+
7+
/**
8+
* <p>
9+
* Provides classes for rendering COLLADA documents. The {@link gov.nasa.worldwind.ogc.collada.impl.ColladaController}
10+
* can be used to render a parsed COLLADA document in WorldWind.</p>
11+
*
12+
*/
13+
package gov.nasa.worldwind.ogc.collada.impl;

src/gov/nasa/worldwind/ogc/collada/impl/package.html

Lines changed: 0 additions & 17 deletions
This file was deleted.
Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
/*
2+
* Copyright (C) 2012 United States Government as represented by the Administrator of the
3+
* National Aeronautics and Space Administration.
4+
* All Rights Reserved.
5+
*/
6+
7+
/**
8+
* <p>
9+
* Provides classes for COLLADA file and stream I/O and relative-path resolution.</p>
10+
*
11+
*/
12+
package gov.nasa.worldwind.ogc.collada.io;

src/gov/nasa/worldwind/ogc/collada/io/package.html

Lines changed: 0 additions & 16 deletions
This file was deleted.
Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
/*
2+
* Copyright (C) 2012 United States Government as represented by the Administrator of the
3+
* National Aeronautics and Space Administration.
4+
* All Rights Reserved.
5+
*/
6+
7+
/**
8+
* <p>
9+
* Provides classes for parsing COLLADA files and streams.</p>
10+
* <h3>How to Parse a COLLADA File or Stream</h3>
11+
* <ol>
12+
* <li>
13+
* Create a {@link gov.nasa.worldwind.ogc.collada.ColladaRoot} via one of its constructors, such as {@link
14+
* gov.nasa.worldwind.ogc.collada.ColladaRoot#ColladaRoot(java.io.File)}, passing the COLLADA source to the constructor.
15+
* A <code>ColladaRoot</code> provides access to the COLLADA contents. The source can be either a file, an input stream,
16+
* or a URL.
17+
* </li>
18+
* <li>
19+
* Call {@link gov.nasa.worldwind.ogc.collada.ColladaRoot#parse(Object[])} to parse the document.
20+
* </li>
21+
* <li>
22+
* The <code>ColladaRoot</code> class provides accessor methods for the <code>COLLADA</code> element of the COLLADA
23+
* file, its root. The content includes the element's <i>asset</i> and <i>scene</i> elements. Once the root is parsed,
24+
* use these methods to obtain objects representing these elements, and use the accessor methods of those objects in
25+
* turn to obtain their contents.
26+
* </li>
27+
* <li>
28+
* Each COLLADA element defined in the <a href="http://www.khronos.org/collada/">COLLADA specification version 1.4.1</a>
29+
* has a corresponding class provided in this package. Each of those classes contains methods to obtain the element's
30+
* contents as defined by the specification.
31+
* </li>
32+
* </ol>
33+
*
34+
<h4>Extending the Classes</h4>
35+
*
36+
<p>
37+
* This package's classes are designed for easy behavior modification and replacement, and for straightforward addition
38+
* of operations to be performed during parsing. See the description of {@link
39+
* gov.nasa.worldwind.util.xml.AbstractXMLEventParser} for further information.</p>
40+
*
41+
<h4>Relative References</h4>
42+
*
43+
<p>
44+
* By default, relative references will be resolved relative to the location of the COLLADA file that includes the
45+
* reference. However, this behavior can be overridden by providing the ColladaRoot with a {@link
46+
* gov.nasa.worldwind.ogc.collada.ColladaResourceResolver}.</p>
47+
*
48+
*/
49+
package gov.nasa.worldwind.ogc.collada;

src/gov/nasa/worldwind/ogc/collada/package.html

Lines changed: 0 additions & 52 deletions
This file was deleted.

0 commit comments

Comments
 (0)