Repair missing license headers.

Fix class name spellings in javadocs
apache · Aug 29, 2019 · b8f6bf0 · b8f6bf0
1 parent bfb113f
commit b8f6bf0
Show file tree

Hide file tree

Showing 9 changed files with 672 additions and 284 deletions.
diff --git a/pom.xml b/pom.xml
diff --git a/src/main/java/org/apache/datasketches/fdt/PostProcessor.java b/src/main/java/org/apache/datasketches/fdt/PostProcessor.java
@@ -41,6 +41,7 @@ public class PostProcessor {
   private final FdtSketch sketch;
   private final char sep;
   private int groupCount;
+  @SuppressWarnings("unused")
   private Group group; //uninitialized
 
   //simple hash-map

diff --git a/src/main/java/org/apache/datasketches/quantiles/Util.java b/src/main/java/org/apache/datasketches/quantiles/Util.java
@@ -66,7 +66,7 @@ private Util() {}
 
   /**
    * Computes the raw delta area between two quantile sketches for the
-   * {@link #kolmogorovSmirnovTest(DoubleSketch, DoubleSketch, double)
+   * {@link #kolmogorovSmirnovTest(DoublesSketch, DoublesSketch, double)
    * Kolmogorov-Smirnov Test}
    * method.
    * @param sketch1 Input DoubleSketch 1
@@ -123,7 +123,7 @@ public static double computeKSDelta(final DoublesSketch sketch1,
 
   /**
    * Computes the adjusted delta area threshold for the
-   * {@link #kolmogorovSmirnovTest(DoubleSketch, DoubleSketch, double) Kolmogorov-Smirnov Test}
+   * {@link #kolmogorovSmirnovTest(DoublesSketch, DoublesSketch, double) Kolmogorov-Smirnov Test}
    * method.
    * This adjusts the computed threshold by the error epsilons of the two given sketches.
    * See <a href="https://en.wikipedia.org/wiki/Kolmogorov-Smirnov_test">Kolmogorov–Smirnov Test</a>

diff --git a/src/main/java/org/apache/datasketches/theta/PairwiseSetOperations.java b/src/main/java/org/apache/datasketches/theta/PairwiseSetOperations.java
@@ -73,7 +73,7 @@ public static CompactSketch aNotB(final Sketch skA, final Sketch skB) {
     final short seedHash = ((skA == null) || (skA instanceof EmptyCompactSketch))
         ? skB.getSeedHash() : skA.getSeedHash();
     final HeapAnotB anotb = new HeapAnotB(seedHash);
-    return anotb.aNotB(skA, skB, true, null);
+    return anotb.aNotB(skA, skB, true, null); //handles null arguments just fine.
   }
 
   /**

diff --git a/src/main/javadoc/overview.html b/src/main/javadoc/overview.html
@@ -1,5 +1,23 @@
 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
    "https://www.w3.org/TR/html4/loose.dtd">
+<!--
+Licensed to the Apache Software Foundation (ASF) under one
+or more contributor license agreements.  See the NOTICE file
+distributed with this work for additional information
+regarding copyright ownership.  The ASF licenses this file
+to you under the Apache License, Version 2.0 (the
+"License"); you may not use this file except in compliance
+with the License.  You may obtain a copy of the License at
+
+  http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing,
+software distributed under the License is distributed on an
+"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, either express or implied.  See the License for the
+specific language governing permissions and limitations
+under the License.
+-->
 
 <html>
 <head>

diff --git a/src/main/javadoc/resources/dictionary.html b/src/main/javadoc/resources/dictionary.html
@@ -1,4 +1,24 @@
 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Frameset//EN" "https://www.w3.org/TR/html4/frameset.dtd">
+
+<!--
+Licensed to the Apache Software Foundation (ASF) under one
+or more contributor license agreements.  See the NOTICE file
+distributed with this work for additional information
+regarding copyright ownership.  The ASF licenses this file
+to you under the Apache License, Version 2.0 (the
+"License"); you may not use this file except in compliance
+with the License.  You may obtain a copy of the License at
+
+  http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing,
+software distributed under the License is distributed on an
+"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, either express or implied.  See the License for the
+specific language governing permissions and limitations
+under the License.
+-->
+
 <html>
 <head>
 <title>Sketch Library Dictionary</title>

diff --git a/tools/CloverConfig.txt b/tools/CloverConfig.txt
@@ -1,3 +1,20 @@
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License.  You may obtain a copy of the License at
+# 
+#   http://www.apache.org/licenses/LICENSE-2.0
+# 
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
 Clover Config for Eclipse:
 
 At Project Level Properties:

diff --git a/tools/FindBugsExcludeFilter.xml b/tools/FindBugsExcludeFilter.xml
@@ -1,5 +1,24 @@
 <FindBugsFilter> <!-- sketches-core -->
 
+<!--
+Licensed to the Apache Software Foundation (ASF) under one
+or more contributor license agreements.  See the NOTICE file
+distributed with this work for additional information
+regarding copyright ownership.  The ASF licenses this file
+to you under the Apache License, Version 2.0 (the
+"License"); you may not use this file except in compliance
+with the License.  You may obtain a copy of the License at
+
+  http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing,
+software distributed under the License is distributed on an
+"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, either express or implied.  See the License for the
+specific language governing permissions and limitations
+under the License.
+-->
+
   <!-- Too many false positives to be useful.  I could not make it happy :( -->
   <Match>
     <Bug pattern="SF_SWITCH_NO_DEFAULT" />

diff --git a/tools/SketchesCheckstyle.xml b/tools/SketchesCheckstyle.xml
@@ -3,6 +3,25 @@
     "-//Checkstyle//DTD Checkstyle Configuration 1.3//EN"
     "https://checkstyle.org/dtds/configuration_1_3.dtd">
 
+<!--
+Licensed to the Apache Software Foundation (ASF) under one
+or more contributor license agreements.  See the NOTICE file
+distributed with this work for additional information
+regarding copyright ownership.  The ASF licenses this file
+to you under the Apache License, Version 2.0 (the
+"License"); you may not use this file except in compliance
+with the License.  You may obtain a copy of the License at
+
+  http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing,
+software distributed under the License is distributed on an
+"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, either express or implied.  See the License for the
+specific language governing permissions and limitations
+under the License.
+-->
+
 <!--
   SketchesCheckstyle.xml for sketches-core