From 7e3cf824d7e0fb0720e677686b4c6e8ca894dfe2 Mon Sep 17 00:00:00 2001 From: Eugene Maksymenko Date: Sun, 1 Dec 2024 01:26:48 +0200 Subject: [PATCH] Fix javadoc buid. --- .travis.yml | 14 ----------- build.gradle | 25 +++++++++---------- src/gov/nasa/worldwind/globes/Globe.java | 4 +-- .../worldwind/symbology/TacticalGraphic.java | 8 +++--- .../milstd2525/MilStd2525IconRetriever.java | 8 +++--- .../util/webview/WindowsWebViewJNI.java | 2 +- .../worldwindx/examples/AirspaceBuilder.java | 4 +-- .../examples/util/BalloonController.java | 2 +- .../examples/util/ScreenSelector.java | 2 +- src/overview.html | 14 +++++------ 10 files changed, 34 insertions(+), 49 deletions(-) diff --git a/.travis.yml b/.travis.yml index b0bc0efec6..a646be4e6a 100644 --- a/.travis.yml +++ b/.travis.yml @@ -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 @@ -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 diff --git a/build.gradle b/build.gradle index 7adddb2061..5deaf56ac6 100644 --- a/build.gradle +++ b/build.gradle @@ -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') @@ -14,7 +14,6 @@ ext { gdalVersion = '3.10.0' jacksonVersion = '1.9.13' junitVersion = '4.5' - //systemGDAL = true } repositories { @@ -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" } @@ -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/**' @@ -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" } } } @@ -98,7 +97,7 @@ def pomConfig = { publishing { publications { - bintray(MavenPublication) { + maven(MavenPublication) { from components.java artifact sourcesJar artifact javadocJar @@ -177,7 +176,7 @@ javadoc { artifacts { archives sourcesJar - archives worldwindJar + archives extensionsJar archives javadocJar } diff --git a/src/gov/nasa/worldwind/globes/Globe.java b/src/gov/nasa/worldwind/globes/Globe.java index b1bb238d7f..72b369ad69 100644 --- a/src/gov/nasa/worldwind/globes/Globe.java +++ b/src/gov/nasa/worldwind/globes/Globe.java @@ -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. - *

Computations in Cartesian Coordinates

+ *

Computations in Cartesian Coordinates

*

* 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 @@ -51,7 +51,7 @@ * #computeSurfaceNormalAtLocation(gov.nasa.worldwind.geom.Angle, gov.nasa.worldwind.geom.Angle)}

  • {@link * #computeSurfaceOrientationAtPosition(gov.nasa.worldwind.geom.Angle, gov.nasa.worldwind.geom.Angle, double)}
    • * - *

    Computations in Ellipsoidal Coordinates

    + *

    Computations in Ellipsoidal Coordinates

    *

    * 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 diff --git a/src/gov/nasa/worldwind/symbology/TacticalGraphic.java b/src/gov/nasa/worldwind/symbology/TacticalGraphic.java index a3bd2654f8..ceed4f80ed 100644 --- a/src/gov/nasa/worldwind/symbology/TacticalGraphic.java +++ b/src/gov/nasa/worldwind/symbology/TacticalGraphic.java @@ -43,7 +43,7 @@ *

    * 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. - *

    Construction

    + *

    Construction

    *

    * 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 @@ -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. - *

    Modifiers

    + *

    Modifiers

    *

    * 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 @@ -114,7 +114,7 @@ * TacticalGraphic graphic = milstd2525Factory.createGraphic("GHGPGAG----AUSX", positions, null); * graphic.setModifier(SymbologyConstants.UNIQUE_DESIGNATION, "Boston"); * - *

    Position

    + *

    Position

    *

    * 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 @@ -139,7 +139,7 @@ * * TacticalGraphic graphic = milstd2525Factory.createGraphic("GFGPSLA----AUSX", positions, null); * - *

    Sub-interfaces of TacticalGraphic

    + *

    Sub-interfaces of TacticalGraphic

    *

    * 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 diff --git a/src/gov/nasa/worldwind/symbology/milstd2525/MilStd2525IconRetriever.java b/src/gov/nasa/worldwind/symbology/milstd2525/MilStd2525IconRetriever.java index 6523602520..3f66453745 100644 --- a/src/gov/nasa/worldwind/symbology/milstd2525/MilStd2525IconRetriever.java +++ b/src/gov/nasa/worldwind/symbology/milstd2525/MilStd2525IconRetriever.java @@ -55,10 +55,10 @@ *
    createIcon Parameters
    KeyTypeDescription
    SymbologyConstants.SHOW_ICONBooleanDetermines * if the symbol will be created with an icon.
    SymbologyConstants.SHOW_FRAMEBooleanDetermines * if the symbol will be created with a frame.
    SymbologyConstants.SHOW_FILLBooleanDetermines - * if the symbol will be created with a fill color.
    AVKey.COLORjava.awt.ColorFill 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.
    + * if the symbol will be created with a fill color.AVKey.COLORjava.awt.Color + * 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. * * @author ccrick * @version $Id: MilStd2525IconRetriever.java 1171 2013-02-11 21:45:02Z dcollins $ diff --git a/src/gov/nasa/worldwind/util/webview/WindowsWebViewJNI.java b/src/gov/nasa/worldwind/util/webview/WindowsWebViewJNI.java index 74e5b23c41..254c506f8e 100644 --- a/src/gov/nasa/worldwind/util/webview/WindowsWebViewJNI.java +++ b/src/gov/nasa/worldwind/util/webview/WindowsWebViewJNI.java @@ -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. - *

    Message loops

    + *

    Message loops

    *

    * 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 diff --git a/src/gov/nasa/worldwindx/examples/AirspaceBuilder.java b/src/gov/nasa/worldwindx/examples/AirspaceBuilder.java index 6a83dbb063..32dbb83776 100644 --- a/src/gov/nasa/worldwindx/examples/AirspaceBuilder.java +++ b/src/gov/nasa/worldwindx/examples/AirspaceBuilder.java @@ -57,7 +57,7 @@ * Illustrates runtime construction of 3D extruded polygons and spheres using WorldWind {@link Airspace} * shapes. This uses a {@link PolygonEditor} and a {@link SphereAirspaceEditor} to enable * runtime editing of {@link Polygon} airspace and {@link SphereAirspace} shapes. - *

    Usage Instructions

    + *

    Usage Instructions

    *

    * Adding and Removing Shapes
    Add a shape by selecting either Polygon or * Sphere in the drop down box then clicking New shape. Delete a shape by left-clicking it @@ -75,7 +75,7 @@ * near the polygon. Remove a polygon control point by holding the Control 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 Shift key then left-click any blue sphere at a vertex and drag it. - *

    Demo Shapes

    + *

    Demo Shapes

    *

    * Select File -> Load Demo Shapes to display a set of polygon airspace shapes built with this editor. * The data for these shapes is located in the WorldWind project under diff --git a/src/gov/nasa/worldwindx/examples/util/BalloonController.java b/src/gov/nasa/worldwindx/examples/util/BalloonController.java index ccd2c2abd9..63d1718990 100644 --- a/src/gov/nasa/worldwindx/examples/util/BalloonController.java +++ b/src/gov/nasa/worldwindx/examples/util/BalloonController.java @@ -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) diff --git a/src/gov/nasa/worldwindx/examples/util/ScreenSelector.java b/src/gov/nasa/worldwindx/examples/util/ScreenSelector.java index b6a42bdbbd..4716064555 100644 --- a/src/gov/nasa/worldwindx/examples/util/ScreenSelector.java +++ b/src/gov/nasa/worldwindx/examples/util/ScreenSelector.java @@ -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()}. - *

    Using ScreenSelector

    + *

    Using ScreenSelector

    *

    * 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 diff --git a/src/overview.html b/src/overview.html index e8cb93b2e3..faba690f87 100644 --- a/src/overview.html +++ b/src/overview.html @@ -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.

    -

    The WorldWind Class

    +

    The WorldWind Class

    TODO

    -

    Multiple WorldWind Windows

    +

    Multiple WorldWind Windows

    TODO

    -

    Data Retrieval

    +

    Data Retrieval

    WorldWind works with enormous quantities of data and information, all of which exist primarily on remote data @@ -99,7 +99,7 @@

    Data Retrieval

    Retriever 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 Runnable.

    -

    Memory Cache

    +

    Memory Cache

    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}. MemoryCache enable cached data to be shared among all @@ -114,7 +114,7 @@

    File Cache

    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 WorldWind singleton.

    -

    Picking and Selection

    +

    Picking and Selection

    WorldWind can determine the displayed objects at a given screen position in a WorldWindow. When the application wants to know what's displayed at a particular point, say the cursor position, it calls a method on @@ -158,7 +158,7 @@

    Picking and Selection

    WorldWind provides utility classes to make it simple for layers to participate in this picking scheme. See {@link gov.nasa.worldwind.pick.PickSupport}

    -

    Use of Proxies

    +

    Use of Proxies

    A proxy is set by calling {@link gov.nasa.worldwind.Configuration#setValue} for each of the following keys: