Skip to content

[Brutal Review] 362 public APIs missing JavaDoc #176

@sfloess

Description

@sfloess

Severity: HIGH

Found 362 public classes/methods without JavaDoc documentation.

Impact: API consumers don't know how to use the code.

Sample findings:

=== Public API without JavaDoc ===
src/main/java/org/flossware/classloader/cache/ClassCache.java:9:public interface ClassCache {
src/main/java/org/flossware/classloader/cache/FileSystemCache.java:23:public class FileSystemCache implements ClassCache {
src/main/java/org/flossware/classloader/cache/FileSystemCache.java:38:    public FileSystemCache(Path cacheDirectory) throws IOException {
src/main/java/org/flossware/classloader/cache/FileSystemCache.java:50:    public FileSystemCache(String cacheDirectory) throws IOException {
src/main/java/org/flossware/classloader/cache/FileSystemCache.java:55:    public byte[] get(String className) {
src/main/java/org/flossware/classloader/cache/FileSystemCache.java:78:    public void put(String className, byte[] classData) throws IOException {
src/main/java/org/flossware/classloader/cache/FileSystemCache.java:106:    public boolean contains(String className) {
src/main/java/org/flossware/classloader/cache/FileSystemCache.java:116:    public void clear() throws IOException {
src/main/java/org/flossware/classloader/cache/FileSystemCache.java:152:    public void remove(String className) throws IOException {
src/main/java/org/flossware/classloader/cache/FileSystemCache.java:201:    public Path getCacheDirectory() {
src/main/java/org/flossware/classloader/protocol/ProtocolHandler.java:9:public interface ProtocolHandler {
src/main/java/org/flossware/classloader/protocol/ProtocolHandlerRegistry.java:13:public class ProtocolHandlerRegistry {
src/main/java/org/flossware/classloader/protocol/ProtocolHandlerRegistry.java:25:    public static ProtocolHandlerRegistry getInstance() {
src/main/java/org/flossware/classloader/protocol/ProtocolHandlerRegistry.java:36:    public void register(String protocol, Class<? extends ProtocolHandler> handlerClass) {
src/main/java/org/flossware/classloader/protocol/ProtocolHandlerRegistry.java:48:    public void unregister(String protocol) {
src/main/java/org/flossware/classloader/protocol/ProtocolHandlerRegistry.java:59:    public Class<? extends ProtocolHandler> getHandler(String protocol) {
src/main/java/org/flossware/classloader/protocol/ProtocolHandlerRegistry.java:70:    public boolean isRegistered(String protocol) {
src/main/java/org/flossware/classloader/protocol/ProtocolHandlerRegistry.java:80:    public Map<String, Class<? extends ProtocolHandler>> getAllHandlers() {
src/main/java/org/flossware/classloader/filesystem/HdfsClassSource.java:22:public class HdfsClassSource implements ClassSource, AutoCloseable {

Action Required: Add comprehensive JavaDoc to all public APIs.


Generated by brutal code review on 2026-05-29 19:54:47

Metadata

Metadata

Assignees

No one assigned

    Labels

    code-qualityCode quality and maintainability issues

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions