Add missing javadocs for classes

ctubbsii · Jul 23, 2024 · e78f3cc · e78f3cc
1 parent 4529986
commit e78f3cc
Show file tree

Hide file tree

Showing 8 changed files with 31 additions and 7 deletions.
diff --git a/src/main/java/net/revelc/code/apilyzer/Apilyzer.java b/src/main/java/net/revelc/code/apilyzer/Apilyzer.java
@@ -3,7 +3,7 @@
  * 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
+ *     https://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,
@@ -26,6 +26,9 @@
 import net.revelc.code.apilyzer.problems.ProblemReporter;
 import net.revelc.code.apilyzer.util.ClassUtils;
 
+/**
+ * The entry point to this library.
+ */
 public class Apilyzer {
 
   private final ProblemReporter problemReporter;

diff --git a/src/main/java/net/revelc/code/apilyzer/PatternSet.java b/src/main/java/net/revelc/code/apilyzer/PatternSet.java
@@ -19,6 +19,9 @@
 import java.util.regex.Pattern;
 import java.util.stream.Collectors;
 
+/**
+ * A set of patterns to match classes on the class path.
+ */
 class PatternSet {
   private final List<Pattern> patterns;
 

diff --git a/src/main/java/net/revelc/code/apilyzer/PublicApi.java b/src/main/java/net/revelc/code/apilyzer/PublicApi.java
@@ -3,7 +3,7 @@
  * 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
+ *     https://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,
@@ -24,6 +24,9 @@
 import java.util.stream.Stream;
 import net.revelc.code.apilyzer.util.ClassUtils;
 
+/**
+ * An object representing the public API for the analysis target.
+ */
 public class PublicApi {
 
   /**

diff --git a/src/main/java/net/revelc/code/apilyzer/problems/Problem.java b/src/main/java/net/revelc/code/apilyzer/problems/Problem.java
@@ -3,7 +3,7 @@
  * 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
+ *     https://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,
@@ -14,6 +14,9 @@
 
 package net.revelc.code.apilyzer.problems;
 
+/**
+ * An object type that represents a problem to be reported.
+ */
 public class Problem {
 
   public final String problemType;

diff --git a/src/main/java/net/revelc/code/apilyzer/problems/ProblemReporter.java b/src/main/java/net/revelc/code/apilyzer/problems/ProblemReporter.java
@@ -3,7 +3,7 @@
  * 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
+ *     https://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,
@@ -18,6 +18,9 @@
 import java.lang.reflect.Method;
 import java.util.function.Consumer;
 
+/**
+ * A utility for reporting the various problem types.
+ */
 public class ProblemReporter {
 
   private Consumer<Problem> consumer;

diff --git a/src/main/java/net/revelc/code/apilyzer/problems/ProblemType.java b/src/main/java/net/revelc/code/apilyzer/problems/ProblemType.java
@@ -3,7 +3,7 @@
  * 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
+ *     https://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,
@@ -14,6 +14,9 @@
 
 package net.revelc.code.apilyzer.problems;
 
+/**
+ * An enumeration of problem types that can be identified and reported.
+ */
 public enum ProblemType {
 
   /**

diff --git a/src/main/java/net/revelc/code/apilyzer/util/ClassUtils.java b/src/main/java/net/revelc/code/apilyzer/util/ClassUtils.java
@@ -3,7 +3,7 @@
  * 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
+ *     https://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,
@@ -28,6 +28,9 @@
 import java.util.stream.Collectors;
 import java.util.stream.Stream;
 
+/**
+ * Some basic static utilities for searching and processing the class path.
+ */
 public class ClassUtils {
 
   private ClassUtils() {

diff --git a/src/test/java/net/revelc/code/apilyzer/maven/plugin/AnalyzeMojoTest.java b/src/test/java/net/revelc/code/apilyzer/maven/plugin/AnalyzeMojoTest.java
@@ -3,7 +3,7 @@
  * 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
+ *     https://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,
@@ -14,6 +14,9 @@
 
 package net.revelc.code.apilyzer.maven.plugin;
 
+/**
+ * A basic test template.
+ */
 public class AnalyzeMojoTest {
 
 }