chore(doc):SP-4117 add missing Javadoc documentation

Author: agustingroh

CHANGELOG.md

@@ -12,6 +12,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Added `file_snippet` scan configuration support in `scanoss.json` for engine tuning parameters (`min_snippet_hits`, `min_snippet_lines`, `honour_file_exts`, `ranking_enabled`, `ranking_threshold`, `skip_headers`, `skip_headers_limit`)
 - Added CLI scan configuration options with resolution priority (file_snippet > CLI)
 - Added `FileSnippet` class for scan configuration management and resolution
+- Scan configuration parameters are now sent as base64-encoded JSON in the `scanoss-settings` HTTP header
+### Fixed
+- Fixed Javadoc warnings across the codebase
 
 ## [0.12.1] - 2026-01-08
 ### Changed

config/checkstyle.xml

@@ -0,0 +1,21 @@
+<?xml version="1.0"?>
+<!DOCTYPE module PUBLIC
+        "-//Checkstyle//DTD Checkstyle Configuration 1.3//EN"
+        "https://checkstyle.org/dtds/configuration_1_3.dtd">
+
+<module name="Checker">
+    <property name="severity" value="warning"/>
+    <property name="fileExtensions" value="java"/>
+
+    <module name="LineLength">
+        <property name="fileExtensions" value="java"/>
+        <property name="max" value="150"/>
+    </module>
+
+    <module name="TreeWalker">
+        <module name="AvoidStarImport"/>
+        <module name="UnusedImports">
+            <property name="processJavadoc" value="false"/>
+        </module>
+    </module>
+</module>

src/main/java/com/scanoss/ScanossConstants.java

@@ -33,6 +33,11 @@
  */
 @SuppressWarnings("SpellCheckingInspection")
 public class ScanossConstants {
+
+    /** Private constructor to prevent instantiation. */
+    private ScanossConstants() {
+    }
+
     /**
      * Default timeout for HTTP communication
      */
@@ -52,7 +57,7 @@ public class ScanossConstants {
     static final int MIN_FILE_SIZE = 256; // Minimum size for a file to be considered for snippet generation
     static final int MAX_LONG_LINE_CHARS = 1000; // Maximum length of a single source line to be considered source code
 
-    // File extensions to ignore snippets for
+    /** File extensions to ignore snippets for. */
     public static final List<String> SKIP_SNIPPET_EXT = Arrays.asList(
             ".exe", ".zip", ".tar", ".tgz", ".gz", ".7z", ".rar", ".jar", ".war", ".ear", ".class", ".pyc",
             ".o", ".a", ".so", ".obj", ".dll", ".lib", ".out", ".app", ".bin",
@@ -61,17 +66,17 @@ public class ScanossConstants {
             ".pdf", ".min.js", ".mf", ".sum", ".woff", ".woff2", ".xsd", ".pom", ".whl"
     );
 
-    // Folders to skip
+    /** Folders to skip during scanning. */
     public static final List<String> FILTERED_DIRS = Arrays.asList(
             "nbproject", "nbbuild", "nbdist", "__pycache__", "venv", "_yardoc", "eggs", "wheels", "htmlcov",
             "__pypackages__", "target"
     );
 
-    // Folder endings to skip
+    /** Folder suffixes to skip during scanning. */
     public static final List<String> FILTERED_DIR_EXT = List.of(".egg-info");
 
 
-    // File extensions to skip
+    /** File extensions to skip during scanning. */
     public static final List<String> FILTERED_EXTENSIONS = Arrays.asList(
             ".1", ".2", ".3", ".4", ".5", ".6", ".7", ".8", ".9", ".ac", ".adoc", ".am",
             ".asciidoc", ".bmp", ".build", ".cfg", ".chm", ".class", ".cmake", ".cnf",
@@ -94,7 +99,7 @@ public class ScanossConstants {
             "readme", "swiftdoc", "texidoc", "todo", "version", "ignore", "manifest", "sqlite", "sqlite3"
     );
 
-    // Files to skip
+    /** Files to skip during scanning. */
     public static final List<String> FILTERED_FILES = Arrays.asList(
             "gradlew", "gradlew.bat", "mvnw", "mvnw.cmd", "gradle-wrapper.jar", "maven-wrapper.jar",
             "thumbs.db", "babel.config.js", "license.txt", "license.md", "copying.lib", "makefile"

src/main/java/com/scanoss/filters/BaseFilter.java

@@ -32,9 +32,13 @@
  */
 @Slf4j
 public abstract class BaseFilter {
+    /** The filter configuration. */
     protected final FilterConfig config;
+    /** The Git ignore pattern filter. */
     protected final GitIgnoreFilter gitIgnoreFilter;
+    /** The Ant pattern filter. */
     protected final AntFilter antFilter;
+    /** The combined base skip filter predicate. */
     protected final Predicate<Path> baseSkipFilter;
 
     /**

src/main/java/com/scanoss/filters/FileFilter.java

@@ -39,7 +39,11 @@ public class FileFilter extends BaseFilter {
     @Builder.Default  // Tells Lombok this field has a default initialization
     private final FilterConfig filterConfig = FilterConfig.builder().build();
 
-    // Use @Builder constructor annotation to tell Lombok to use this constructor
+    /**
+     * Constructs a FileFilter with the specified configuration.
+     *
+     * @param filterConfig the filter configuration
+     */
     protected FileFilter(FilterConfig filterConfig) {
         super(filterConfig);
         this.filterConfig = filterConfig;

src/main/java/com/scanoss/filters/FolderFilter.java

@@ -36,6 +36,11 @@
  */
 public class FolderFilter extends BaseFilter {
 
+    /**
+     * Constructs a FolderFilter with the specified configuration.
+     *
+     * @param filterConfig the filter configuration
+     */
     public FolderFilter(FilterConfig filterConfig) {
         super(filterConfig);
     }

src/main/java/com/scanoss/filters/GitIgnoreFilter.java

@@ -44,6 +44,11 @@ public class GitIgnoreFilter {
     @Setter(AccessLevel.PRIVATE)
     private List<FastIgnoreRule> rules;
 
+    /**
+     * Constructs a GitIgnoreFilter with the specified patterns.
+     *
+     * @param patterns the list of Git ignore patterns
+     */
     @Builder
     public GitIgnoreFilter(@NonNull List<String> patterns) {
         this.rules = new ArrayList<>();

src/main/java/com/scanoss/filters/factories/FileFilterFactory.java

@@ -31,6 +31,9 @@
 A factory class that provides a static method for creating file filtering predicates.
 */
  public class FileFilterFactory {
+    /** Private constructor to prevent instantiation. */
+    private FileFilterFactory() {
+    }
     /**
      * Creates a file filtering predicate based on the provided configuration.
      *

src/main/java/com/scanoss/filters/factories/FolderFilterFactory.java

@@ -31,6 +31,9 @@
  A factory class that provides a static method for creating folder filtering predicates.
  */
 public class FolderFilterFactory {
+    /** Private constructor to prevent instantiation. */
+    private FolderFilterFactory() {
+    }
     /**
      * Creates a folder filtering predicate based on the provided configuration.
      *

src/main/java/com/scanoss/settings/Bom.java

@@ -36,9 +36,18 @@
 @Data
 @Builder
 @AllArgsConstructor
-@NoArgsConstructor
 public class Bom {
 
+    /** Default constructor. */
+    public Bom() {
+        this.include = new ArrayList<>();
+        this.ignore = new ArrayList<>();
+        this.remove = new ArrayList<>();
+        this.replace = new ArrayList<>();
+        this.sortedReplace = new ArrayList<>();
+    }
+
+
     /**
      * List of include rules for adding context when scanning.
      * These rules are sent to the SCANOSS API and have a higher chance of being