Update pom.xml for release 2.1 and fix Javadoc warnings.

jfree · May 24, 2021 · 02cd558 · 02cd558
1 parent 4b60037
commit 02cd558
Show file tree

Hide file tree

Showing 32 changed files with 179 additions and 41 deletions.
diff --git a/pom.xml b/pom.xml
@@ -10,7 +10,7 @@
 
     <groupId>org.jfree</groupId>
     <artifactId>org.jfree.fx.demos</artifactId>
-    <version>2.0</version>
+    <version>2.1</version>
     <packaging>jar</packaging>
 
     <organization>
@@ -46,12 +46,12 @@
         <dependency>
             <groupId>org.openjfx</groupId>
             <artifactId>javafx-controls</artifactId>
-            <version>15</version>
+            <version>16</version>
         </dependency>  
         <dependency>
             <groupId>org.openjfx</groupId>
             <artifactId>javafx-web</artifactId>
-            <version>15</version>
+            <version>16</version>
         </dependency>  
         <dependency>
             <groupId>org.jfree</groupId>
@@ -61,13 +61,13 @@
         <dependency>
             <groupId>org.jfree</groupId>
             <artifactId>org.jfree.chart3d.fx</artifactId>
-            <version>2.0</version>
+            <version>2.1</version>
         </dependency>
 
         <dependency>
             <groupId>org.jfree</groupId>
             <artifactId>jfreechart</artifactId>
-            <version>1.5.1</version>
+            <version>1.5.3</version>
         </dependency>
 
         <dependency>
@@ -90,10 +90,15 @@
 
     <build>
         <plugins>
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-clean-plugin</artifactId>
+                <version>3.1.0</version>
+            </plugin>
             <plugin>
                 <groupId>org.openjfx</groupId>
                 <artifactId>javafx-maven-plugin</artifactId>
-                <version>0.0.4</version>
+                <version>0.0.6</version>
                 <configuration>
                     <mainClass>org.jfree.chart3d.fx.demo.OrsonChartsFXDemo</mainClass>
                 </configuration>
@@ -120,7 +125,7 @@
                 <inherited>true</inherited>
                 <groupId>org.apache.maven.plugins</groupId>
                 <artifactId>maven-javadoc-plugin</artifactId>
-                <version>3.2.0</version>
+                <version>3.3.0</version>
                 <configuration>
                     <docfilessubdirs>true</docfilessubdirs>
                     <linksource>true</linksource>
@@ -135,6 +140,11 @@
                     </execution>
                 </executions>
             </plugin>
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-jar-plugin</artifactId>
+                <version>3.2.0</version>
+            </plugin>
             <plugin>
                 <artifactId>maven-assembly-plugin</artifactId>
                 <version>3.1.0</version>
@@ -158,6 +168,11 @@
                     </execution>
                 </executions>
             </plugin>
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-install-plugin</artifactId>
+                <version>3.0.0-M1</version>
+            </plugin>
         </plugins> 
 
     </build>

diff --git a/src/main/java/org/jfree/chart/fx/demo/BarChartFXDemo1.java b/src/main/java/org/jfree/chart/fx/demo/BarChartFXDemo1.java
@@ -2,7 +2,7 @@
  * BarChartFXDemo1.java
  * ====================
  * 
- * Copyright (c) 2014-2020 Object Refinery Limited.
+ * Copyright (c) 2014-2021 Object Refinery Limited.
  * All rights reserved.
  *
  * https://github.com/jfree/jfree-fxdemos

diff --git a/src/main/java/org/jfree/chart/fx/demo/CrosshairOverlayFXDemo1.java b/src/main/java/org/jfree/chart/fx/demo/CrosshairOverlayFXDemo1.java
@@ -1,7 +1,7 @@
 /* ----------------------------
  * CrosshairOverlayFXDemo1.java
  * ----------------------------
- * Copyright (c) 2014-2020, Object Refinery Limited.
+ * Copyright (c) 2014-2021, Object Refinery Limited.
  * All rights reserved.
  *
  * https://github.com/jfree/jfree-fxdemos

diff --git a/src/main/java/org/jfree/chart/fx/demo/PieChartFXDemo1.java b/src/main/java/org/jfree/chart/fx/demo/PieChartFXDemo1.java
@@ -2,7 +2,7 @@
  * PieChartFXDemo1.java
  * ====================
  * 
- * Copyright (c) 2014-2020, Object Refinery Limited.
+ * Copyright (c) 2014-2021, Object Refinery Limited.
  * All rights reserved.
  *
  * https://github.com/jfree/jfree-fxdemos

diff --git a/src/main/java/org/jfree/chart/fx/demo/TimeSeriesChartFXDemo1.java b/src/main/java/org/jfree/chart/fx/demo/TimeSeriesChartFXDemo1.java
@@ -2,7 +2,7 @@
  * TimeSeriesChartFXDemo1.java
  * ===========================
  * 
- * Copyright (c) 2014-2020, Object Refinery Limited.
+ * Copyright (c) 2014-2021, Object Refinery Limited.
  * All rights reserved.
  *
  * https://github.com/jfree/jfree-fxdemos

diff --git a/src/main/java/org/jfree/chart3d/fx/demo/AreaChart3DFXDemo1.java b/src/main/java/org/jfree/chart3d/fx/demo/AreaChart3DFXDemo1.java
@@ -2,7 +2,7 @@
  * Orson Charts - Demo
  * ===================
  * 
- * Copyright (c) 2013-2020, Object Refinery Limited.
+ * Copyright (c) 2013-2021, Object Refinery Limited.
  * All rights reserved.
  *
  * https://github.com/jfree/jfree-fxdemos
@@ -79,6 +79,11 @@ public static Chart3D createChart(CategoryDataset3D dataset) {
         return chart;
     }
 
+    /**
+     * Creates and returns a node for the demo chart.
+     * 
+     * @return A node for the demo chart.
+     */
     public static Node createDemoNode() {
         CategoryDataset3D dataset = SampleData.createCompanyRevenueDataset();
         Chart3D chart = createChart(dataset);

diff --git a/src/main/java/org/jfree/chart3d/fx/demo/AreaChart3DFXDemo2.java b/src/main/java/org/jfree/chart3d/fx/demo/AreaChart3DFXDemo2.java
@@ -2,7 +2,7 @@
  * Orson Charts - Demo
  * ===================
  * 
- * Copyright (c) 2013-2020, Object Refinery Limited.
+ * Copyright (c) 2013-2021, Object Refinery Limited.
  * All rights reserved.
  *
  * https://github.com/jfree/jfree-fxdemos
@@ -147,6 +147,11 @@ private static CategoryDataset3D createDataset() {
         return dataset;
     }
 
+    /**
+     * Creates and returns a node for the demo chart.
+     * 
+     * @return A node for the demo chart.
+     */
     public static Node createDemoNode() {
         CategoryDataset3D dataset = createDataset();
         Chart3D chart = createChart(dataset);

diff --git a/src/main/java/org/jfree/chart3d/fx/demo/BarChart3DFXDemo1.java b/src/main/java/org/jfree/chart3d/fx/demo/BarChart3DFXDemo1.java
@@ -2,7 +2,7 @@
  * Orson Charts - Demo
  * ===================
  * 
- * Copyright (c) 2013-2020, Object Refinery Limited.
+ * Copyright (c) 2013-2021, Object Refinery Limited.
  * All rights reserved.
  *
  * https://github.com/jfree/jfree-fxdemos
@@ -73,6 +73,11 @@ private static Chart3D createChart(CategoryDataset3D dataset) {
         return chart;
     }
 
+    /**
+     * Creates and returns a node for the demo chart.
+     * 
+     * @return A node for the demo chart.
+     */
     public static Node createDemoNode() {
         CategoryDataset3D dataset = SampleData.createCompanyRevenueDataset();
         Chart3D chart = createChart(dataset);

diff --git a/src/main/java/org/jfree/chart3d/fx/demo/BarChart3DFXDemo2.java b/src/main/java/org/jfree/chart3d/fx/demo/BarChart3DFXDemo2.java
@@ -2,7 +2,7 @@
  * Orson Charts - Demo
  * ===================
  * 
- * Copyright (c) 2013-2020, Object Refinery Limited.
+ * Copyright (c) 2013-2021, Object Refinery Limited.
  * All rights reserved.
  *
  * https://github.com/jfree/jfree-fxdemos
@@ -189,6 +189,11 @@ private static CategoryDataset3D createDataset() {
         return dataset;
     }
 
+    /**
+     * Creates and returns a node for the demo chart.
+     * 
+     * @return A node for the demo chart.
+     */
     public static Node createDemoNode() {
         CategoryDataset3D dataset = createDataset();
         Chart3D chart = createChart(dataset);

diff --git a/src/main/java/org/jfree/chart3d/fx/demo/CategoryMarkerFXDemo1.java b/src/main/java/org/jfree/chart3d/fx/demo/CategoryMarkerFXDemo1.java
@@ -2,7 +2,7 @@
  * Orson Charts - Demo
  * ===================
  * 
- * Copyright (c) 2013-2020, Object Refinery Limited.
+ * Copyright (c) 2013-2021, Object Refinery Limited.
  * All rights reserved.
  *
  * https://github.com/jfree/jfree-fxdemos
@@ -256,6 +256,11 @@ private static Chart3D createChart(CategoryDataset3D dataset) {
         return chart;
     }
 
+    /**
+     * Creates and returns a node for the demo chart.
+     * 
+     * @return A node for the demo chart.
+     */
     public static Node createDemoNode() {
         CategoryDataset3D dataset = SampleData.createCompanyRevenueDataset();
         Chart3D chart = createChart(dataset);

diff --git a/src/main/java/org/jfree/chart3d/fx/demo/DemoDescription.java b/src/main/java/org/jfree/chart3d/fx/demo/DemoDescription.java
@@ -2,7 +2,7 @@
  * Orson Charts - Demo
  * ===================
  * 
- * Copyright (c) 2013-2020, Object Refinery Limited.
+ * Copyright (c) 2013-2021, Object Refinery Limited.
  * All rights reserved.
  *
  * https://github.com/jfree/jfree-fxdemos

diff --git a/src/main/java/org/jfree/chart3d/fx/demo/HighlightCategoryColorSource.java b/src/main/java/org/jfree/chart3d/fx/demo/HighlightCategoryColorSource.java
@@ -2,7 +2,7 @@
  * Orson Charts - Demo
  * ===================
  * 
- * Copyright (c) 2013-2020, Object Refinery Limited.
+ * Copyright (c) 2013-2021, Object Refinery Limited.
  * All rights reserved.
  *
  * https://github.com/jfree/jfree-fxdemos

diff --git a/src/main/java/org/jfree/chart3d/fx/demo/HighlightXYZColorSource.java b/src/main/java/org/jfree/chart3d/fx/demo/HighlightXYZColorSource.java
@@ -2,7 +2,7 @@
  * Orson Charts - Demo
  * ===================
  * 
- * Copyright (c) 2013-2020, Object Refinery Limited.
+ * Copyright (c) 2013-2021, Object Refinery Limited.
  * All rights reserved.
  *
  * https://github.com/jfree/jfree-fxdemos
@@ -47,7 +47,8 @@
  */
 @SuppressWarnings("serial")
 public class HighlightXYZColorSource extends StandardXYZColorSource {
-
+
+    /** The dataset. */
     private final XYZDataset dataset;
 
     /** The range of x-values for the highlight region. */

diff --git a/src/main/java/org/jfree/chart3d/fx/demo/LineChart3DFXDemo1.java b/src/main/java/org/jfree/chart3d/fx/demo/LineChart3DFXDemo1.java
@@ -2,7 +2,7 @@
  * Orson Charts - Demo
  * ===================
  * 
- * Copyright (c) 2013-2020, Object Refinery Limited.
+ * Copyright (c) 2013-2021, Object Refinery Limited.
  * All rights reserved.
  *
  * https://github.com/jfree/jfree-fxdemos
@@ -63,6 +63,11 @@
  */
 public class LineChart3DFXDemo1 extends Application {
 
+    /**
+     * Creates and returns a node for the demo chart.
+     * 
+     * @return A node for the demo chart.
+     */
     public static Node createDemoNode() {
         CategoryDataset3D dataset = createDataset();
         Chart3D chart = createChart(dataset);

diff --git a/src/main/java/org/jfree/chart3d/fx/demo/LineChart3DFXDemo2.java b/src/main/java/org/jfree/chart3d/fx/demo/LineChart3DFXDemo2.java
@@ -2,7 +2,7 @@
  * Orson Charts - Demo
  * ===================
  * 
- * Copyright (c) 2013-2020, Object Refinery Limited.
+ * Copyright (c) 2013-2021, Object Refinery Limited.
  * All rights reserved.
  *
  * https://github.com/jfree/jfree-fxdemos
@@ -56,6 +56,11 @@
  */
 public class LineChart3DFXDemo2 extends Application {
 
+    /**
+     * Creates and returns a node for the demo chart.
+     * 
+     * @return A node for the demo chart.
+     */
     public static Node createDemoNode() {
         CategoryDataset3D dataset = createDataset();
         Chart3D chart = createChart(dataset);

diff --git a/src/main/java/org/jfree/chart3d/fx/demo/OrsonChartsFXDemo.java b/src/main/java/org/jfree/chart3d/fx/demo/OrsonChartsFXDemo.java
@@ -2,7 +2,7 @@
  * Orson Charts - Demo
  * ===================
  * 
- * Copyright (c) 2013-2020, Object Refinery Limited.
+ * Copyright (c) 2013-2021, Object Refinery Limited.
  * All rights reserved.
  *
  * https://github.com/jfree/jfree-fxdemos
@@ -298,7 +298,13 @@ private Method getMethod(String name, Class c) {
     }
 
     private final double margin = 0.25;
-
+
+    /**
+     * Adjusts the zoom to fit the chart within the specified dimensions.
+     * 
+     * @param drawable  the drawable ({@code null} not permitted).
+     * @param size  the new dimensions ({@code null} not permitted).
+     */
     public void zoomToFit(Drawable3D drawable, Dimension size) {
         int w = (int) (size.getWidth() * (1.0 - this.margin));
         int h = (int) (size.getHeight() * (1.0 - this.margin));

diff --git a/src/main/java/org/jfree/chart3d/fx/demo/PieChart3DFXDemo1.java b/src/main/java/org/jfree/chart3d/fx/demo/PieChart3DFXDemo1.java
@@ -2,7 +2,7 @@
  * Orson Charts - Demo
  * ===================
  * 
- * Copyright (c) 2013-2020, Object Refinery Limited.
+ * Copyright (c) 2013-2021, Object Refinery Limited.
  * All rights reserved.
  *
  * https://github.com/jfree/jfree-fxdemos
@@ -56,6 +56,11 @@
  */
 public class PieChart3DFXDemo1 extends Application {
 
+    /**
+     * Creates and returns a node for the demo chart.
+     * 
+     * @return A node for the demo chart.
+     */
     public static Node createDemoNode() {
         PieDataset3D<String> dataset = createDataset();
         Chart3D chart = createChart(dataset);

diff --git a/src/main/java/org/jfree/chart3d/fx/demo/PieChart3DFXDemo2.java b/src/main/java/org/jfree/chart3d/fx/demo/PieChart3DFXDemo2.java
@@ -2,7 +2,7 @@
  * Orson Charts - Demo
  * ===================
  * 
- * Copyright (c) 2013-2020, Object Refinery Limited.
+ * Copyright (c) 2013-2021, Object Refinery Limited.
  * All rights reserved.
  *
  * https://github.com/jfree/jfree-fxdemos
@@ -58,6 +58,11 @@
  */
 public class PieChart3DFXDemo2 extends Application {
 
+    /**
+     * Creates and returns a node for the demo chart.
+     * 
+     * @return A node for the demo chart.
+     */
     public static Node createDemoNode() {
         PieDataset3D<String> dataset = createDataset();
         Chart3D chart = createChart(dataset);

diff --git a/src/main/java/org/jfree/chart3d/fx/demo/RangeMarkerFXDemo1.java b/src/main/java/org/jfree/chart3d/fx/demo/RangeMarkerFXDemo1.java
@@ -2,7 +2,7 @@
  * Orson Charts - Demo
  * ===================
  * 
- * Copyright (c) 2013-2020, Object Refinery Limited.
+ * Copyright (c) 2013-2021, Object Refinery Limited.
  * All rights reserved.
  *
  * https://github.com/jfree/jfree-fxdemos
@@ -67,6 +67,11 @@
  */
 public class RangeMarkerFXDemo1 extends Application {
 
+    /**
+     * Creates and returns a node for the demo chart.
+     * 
+     * @return A node for the demo chart.
+     */
     public static Node createDemoNode() {
         XYZDataset dataset = createDataset();
         Chart3D chart = createChart(dataset);