Skip to content

Commit

Permalink
Fix javadoc buid.
Browse files Browse the repository at this point in the history
  • Loading branch information
ComBatVision committed Nov 30, 2024
1 parent b6d0c4a commit 7e3cf82
Show file tree
Hide file tree
Showing 10 changed files with 34 additions and 49 deletions.
14 changes: 0 additions & 14 deletions .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -48,13 +48,6 @@ script:

# Deploy develop branch javadocs to gh_pages, and create and deploy CHANGELOG.md on tags
deploy:
# Publish SNAPSHOT artifacts to oss.jfrog.org
- provider: script
script: ./gradlew artifactoryPublish -Psnapshot -Pbuild.number=$TRAVIS_BUILD_NUMBER --stacktrace
skip_cleanup: true
on:
branch: develop
jdk: oraclejdk8
# Publish API documentation to GitHub Pages
- provider: pages
github_token: $GITHUB_API_KEY
Expand All @@ -63,13 +56,6 @@ deploy:
on:
branch: develop
jdk: oraclejdk8
# Publish release artifacts to Bintray/JCenter
- provider: script
script: ./gradlew bintrayUpload -Prelease --stacktrace
skip_cleanup: true
on:
tags: true
jdk: oraclejdk8
# Create CHANGELOG.md in the current directory
- provider: script
script: ./travis/changelog.sh >> CHANGELOG.md
Expand Down
25 changes: 12 additions & 13 deletions build.gradle
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ apply plugin: 'java-library'
apply plugin: 'maven-publish'

group = 'earth.worldwind'
version = '2.3.0' + (project.hasProperty('snapshot') ? '-SNAPSHOT' : '')
version = '2.3.1' + (project.hasProperty('snapshot') ? '-SNAPSHOT' : '')

ant {
property(file: 'release-build.properties')
Expand All @@ -14,7 +14,6 @@ ext {
gdalVersion = '3.10.0'
jacksonVersion = '1.9.13'
junitVersion = '4.5'
//systemGDAL = true
}

repositories {
Expand All @@ -24,11 +23,11 @@ repositories {
}

dependencies {
implementation group: 'org.jogamp.jogl', name: 'jogl-all-main', version:"$project.joglVersion"
implementation group: 'org.jogamp.gluegen', name: 'gluegen-rt-main', version:"$project.joglVersion"
implementation "org.jogamp.jogl:jogl-all-main:$project.joglVersion"
implementation "org.jogamp.gluegen:gluegen-rt-main:$project.joglVersion"

if (project.hasProperty('systemGDAL')) {
implementation files("C:\\Program Files\\GDAL\\java\\gdal.jar")
implementation files("${ant.properties['gdal.jar.dir']}/gdal.jar")
} else {
implementation "org.gdal:gdal:$project.gdalVersion"
}
Expand All @@ -50,10 +49,10 @@ task sourcesJar(type: Jar, dependsOn: classes) {
}
}

task worldwindJar(type: Jar) {
task extensionsJar(type: Jar) {
group = 'build'
description = 'Assembles a jar archive containing the WorldWind classes.'
archivesBaseName = 'worldwind'
description = 'Assembles a jar archive containing the extension classes.'
baseName = 'worldwindx'
from (sourceSets.main.output) {
exclude 'com/**'
exclude 'config/**'
Expand All @@ -62,9 +61,9 @@ task worldwindJar(type: Jar) {
}
doLast {
copy {
from "$buildDir/libs/$worldwindJar.archiveFileName"
from "$buildDir/libs/$extensionsJar.archiveFileName"
into project.projectDir
rename "$worldwindJar.archiveFileName", "$worldwindJar.baseName.$worldwindJar.extension"
rename "$extensionsJar.archiveFileName", "$extensionsJar.baseName.$extensionsJar.extension"
}
}
}
Expand Down Expand Up @@ -98,7 +97,7 @@ def pomConfig = {

publishing {
publications {
bintray(MavenPublication) {
maven(MavenPublication) {
from components.java
artifact sourcesJar
artifact javadocJar
Expand Down Expand Up @@ -177,7 +176,7 @@ javadoc {

artifacts {
archives sourcesJar
archives worldwindJar
archives extensionsJar
archives javadocJar
}

Expand Down
4 changes: 2 additions & 2 deletions src/gov/nasa/worldwind/globes/Globe.java
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@
* elevations for geographic positions on the surface of the globe. Globe provides methods for converting geographic
* positions (latitude, longitude, and elevation) to cartesian coordinates, and for converting cartesian to geographic.
* The origin and orientation of the cartesian coordinate system are determined by implementations of this interface.
* <h1>Computations in Cartesian Coordinates</h1>
* <h2>Computations in Cartesian Coordinates</h2>
* <p>
* Globe provides methods for performing computations in the coordinate system represented by a globe's surface in
* cartesian coordinates. These methods perform work with respect to the globe's actual shape in 3D cartesian
Expand All @@ -51,7 +51,7 @@
* #computeSurfaceNormalAtLocation(gov.nasa.worldwind.geom.Angle, gov.nasa.worldwind.geom.Angle)}</li> <li>{@link
* #computeSurfaceOrientationAtPosition(gov.nasa.worldwind.geom.Angle, gov.nasa.worldwind.geom.Angle, double)}</li>
* </ul>
* <h1>Computations in Ellipsoidal Coordinates</h1>
* <h2>Computations in Ellipsoidal Coordinates</h2>
* <p>
* Globe provides methods for performing computation on the ellipsoid represented by a globe's equatorial radius and its
* polar radius. These methods perform work with respect to the ellipsoid in 3D cartesian coordinates. Calling any of
Expand Down
8 changes: 4 additions & 4 deletions src/gov/nasa/worldwind/symbology/TacticalGraphic.java
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@
* <p>
* See the {@link gov.nasa.worldwindx.examples.symbology.Symbology} and {@link gov.nasa.worldwindx.examples.symbology.TacticalGraphics}
* example applications for examples of how to use tactical graphics.
* <h1>Construction</h1>
* <h2>Construction</h2>
* <p>
* TacticalGraphics are typically created by an instance of {@link TacticalGraphicFactory}. Each graphic within a symbol
* set is identified by a string identifier. The format of this identifier depends on the symbol set. For example, a
Expand Down Expand Up @@ -91,7 +91,7 @@
* graphic should be styled. In the example above we added a text modifier of "Alpha" to identify our shape. These
* parameters can be specified using a parameter list when the TacticalGraphic is created, as shown above. They can also
* be set after creation using setters in the TacticalGraphic interface.
* <h1>Modifiers</h1>
* <h2>Modifiers</h2>
* <p>
* Many graphics support text or graphic modifiers. Each modifier is identified by a String key. The set of possible
* modifiers is determined by the symbol set. Modifiers can be specified in the parameter list when a graphic is
Expand All @@ -114,7 +114,7 @@
* TacticalGraphic graphic = milstd2525Factory.createGraphic("GHGPGAG----AUSX", positions, null);
* graphic.setModifier(SymbologyConstants.UNIQUE_DESIGNATION, "Boston");
* </pre>
* <h1>Position</h1>
* <h2>Position</h2>
* <p>
* Each tactical graphic is positioned by one or more control points. How many points are required depends on the type
* of graphic. A point graphic will only require one point. A more complex shape may require three or four, and a line
Expand All @@ -139,7 +139,7 @@
*
* TacticalGraphic graphic = milstd2525Factory.createGraphic("GFGPSLA----AUSX", positions, null);
* </pre>
* <h1>Sub-interfaces of TacticalGraphic</h1>
* <h2>Sub-interfaces of TacticalGraphic</h2>
* <p>
* TacticalGraphic describes any tactical graphic in the most general terms: a list of positions and modifiers. However,
* this general interface is not convenient for all graphics. For example, when creating a circle graphic it is more
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -55,10 +55,10 @@
* <table><caption style="font-weight: bold;">createIcon Parameters</caption> <tr><th>Key</th><th>Type</th><td><th>Description</th></tr> <tr><td>SymbologyConstants.SHOW_ICON</td><td>Boolean</td><td>Determines
* if the symbol will be created with an icon.</td></tr> <tr><td>SymbologyConstants.SHOW_FRAME</td><td>Boolean</td><td>Determines
* if the symbol will be created with a frame.</td></tr> <tr><td>SymbologyConstants.SHOW_FILL</td><td>Boolean</td><td>Determines
* if the symbol will be created with a fill color.</td></tr><tr><td valign="top">AVKey.COLOR</td><td
* valign="top">java.awt.Color</td><td valign="top">Fill color applied to the symbol. If the symbol is drawn with a
* frame, then this color will be used to fill the frame. If the symbol is not drawn with a frame, then the fill will be
* applied to the icon itself. The fill color has no effect if Show Fill is False.</td></tr> </table>
* if the symbol will be created with a fill color.</td></tr><tr><td>AVKey.COLOR</td><td>java.awt.Color</td>
* <td>Fill color applied to the symbol. If the symbol is drawn with a frame, then this color will be used to fill the frame.
* If the symbol is not drawn with a frame, then the fill will be applied to the icon itself.
* The fill color has no effect if Show Fill is False.</td></tr> </table>
*
* @author ccrick
* @version $Id: MilStd2525IconRetriever.java 1171 2013-02-11 21:45:02Z dcollins $
Expand Down
2 changes: 1 addition & 1 deletion src/gov/nasa/worldwind/util/webview/WindowsWebViewJNI.java
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@
/**
* JNI bindings for the Windows WebView library. This library provides functions for creating and destroying native
* WebViews, sending user input to a WebView, and adding listeners to a WebView.
* <h3>Message loops</h3>
* <h2>Message loops</h2>
* <p>
* WebViews created by this library must be managed by a message loop in native code. This class provides methods for
* creating and running a native message loop using a Java thread. Each WebView must be associated with one message
Expand Down
4 changes: 2 additions & 2 deletions src/gov/nasa/worldwindx/examples/AirspaceBuilder.java
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@
* Illustrates runtime construction of 3D extruded polygons and spheres using WorldWind <code>{@link Airspace}</code>
* shapes. This uses a <code>{@link PolygonEditor}</code> and a <code>{@link SphereAirspaceEditor}</code> to enable
* runtime editing of <code>{@link Polygon}</code> airspace and <code>{@link SphereAirspace}</code> shapes.
* <h1>Usage Instructions</h1>
* <h2>Usage Instructions</h2>
* <p>
* <strong>Adding and Removing Shapes</strong> <br> Add a shape by selecting either <code>Polygon</code> or
* <code>Sphere</code> in the drop down box then clicking <code>New shape</code>. Delete a shape by left-clicking it
Expand All @@ -75,7 +75,7 @@
* near the polygon. Remove a polygon control point by holding the <code>Control</code> key and left-clicking the blue
* sphere at the vertex. Move a polygon vertex by left-clicking and dragging it. Change a polygon's bottom or top height
* by holding the <code>Shift</code> key then left-click any blue sphere at a vertex and drag it.
* <h1>Demo Shapes</h1>
* <h2>Demo Shapes</h2>
* <p>
* Select <code>File -&gt; Load Demo Shapes</code> to display a set of polygon airspace shapes built with this editor.
* The data for these shapes is located in the WorldWind project under
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -180,7 +180,7 @@ private MouseEvent glMouseEvent(MouseEvent awtMouseEvent) {
* Handle a mouse click. If the top picked object has a balloon attached to it the balloon will be made visible. A
* balloon may be attached to a KML feature, or to any picked object though {@link AVKey#BALLOON}.
*
* @param e Mouse event
* @param awtEv Mouse event
*/
@Override
public void mouseClicked(MouseEvent awtEv)
Expand Down
2 changes: 1 addition & 1 deletion src/gov/nasa/worldwindx/examples/util/ScreenSelector.java
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@
* and tracks the list of objects intersecting the screen rectangle. The screen rectangle is displayed on a layer
* created by ScreenSelector, and is used as the WorldWindow's pick rectangle to perform object selection. Objects
* intersecting the screen rectangle can be accessed by calling {@link #getSelectedObjects()}.
* <h3>Using ScreenSelector</h3>
* <h2>Using ScreenSelector</h2>
* <p>
* To use ScreenSelector in an application, create a new instance of ScreenSelector and specify the application's
* WorldWindow as the sole parameter. When the user wants to define a screen selection, call {@link #enable} and the
Expand Down
14 changes: 7 additions & 7 deletions src/overview.html
Original file line number Diff line number Diff line change
Expand Up @@ -42,15 +42,15 @@
Most of WorldWind's components are defined by interfaces. This allows application developers to create their own
implementations and easily integrate them into WorldWind. </p>

<h2>The <code>WorldWind</code> Class</h2>
<h1>The <code>WorldWind</code> Class</h1>

<p>TODO</p>

<h2>Multiple WorldWind Windows</h2>
<h1>Multiple WorldWind Windows</h1>

<p>TODO</p>

<h2>Data Retrieval</h2>
<h1>Data Retrieval</h1>

<p>
WorldWind works with enormous quantities of data and information, all of which exist primarily on remote data
Expand Down Expand Up @@ -99,7 +99,7 @@ <h2>Data Retrieval</h2>
Retriever</code> and requests retrieval. Later, after retrieval has placed the data on disk, the situation will be
the local case and data can be loaded into memory within the <code>Runnable</code>. </p>

<h2>Memory Cache</h2>
<h1>Memory Cache</h1>

<p>So that data can be shared among caching objects, most cached data used within WorldWind is cached in a {@link
gov.nasa.worldwind.cache.MemoryCache}. <code>MemoryCache</code> enable cached data to be shared among all
Expand All @@ -114,7 +114,7 @@ <h2>File Cache</h2>
No object manages its own storage. The file cache cache manages multiple disk storage locations and unifies access to
them. The file cache is a singleton, accessible through the <code>WorldWind</code> singleton.</p>

<h2>Picking and Selection</h2>
<h1>Picking and Selection</h1>

<p>WorldWind can determine the displayed objects at a given screen position in a <code>WorldWindow</code>. When the
application wants to know what's displayed at a particular point, say the cursor position, it calls a method on
Expand Down Expand Up @@ -158,7 +158,7 @@ <h2>Picking and Selection</h2>
<p>WorldWind provides utility classes to make it simple for layers to participate in this picking scheme. See {@link
gov.nasa.worldwind.pick.PickSupport} </p>

<h2>Use of Proxies</h2>
<h1>Use of Proxies</h1>

<p>A proxy is set by calling {@link gov.nasa.worldwind.Configuration#setValue} for each of the following keys:</p>
<ul>
Expand All @@ -176,7 +176,7 @@ <h2>Offline Mode</h2>
to attempting retrieval of a network resource &mdash; anything addressed by a URL &mdash; WorldWind checks the
offline-mode setting and does not attempt retrieval if the value is true.</p>

<h2 id="path-types">Path Types</h2>
<h1 id="path-types">Path Types</h1>

<p>There is only one way to draw a straight line on a plane, but there are several ways to draw a straight line on the
surface of a globe. Most shapes support the following path types:</p>
Expand Down

0 comments on commit 7e3cf82

Please sign in to comment.