Skip to content

fix(docs): add missing Javadoc comments to eliminate warnings#24

Merged
jimisola merged 1 commit intomainfrom
fix/javadoc-comments
Feb 25, 2026
Merged

fix(docs): add missing Javadoc comments to eliminate warnings#24
jimisola merged 1 commit intomainfrom
fix/javadoc-comments

Conversation

@jimisola
Copy link
Member

Summary

Eliminates all 14 Javadoc warnings from the build by adding comprehensive documentation to classes and constants that were missing Javadoc comments.

Changes

  • RequirementsToolPlugin: Added Javadoc for default constructor
  • RequirementsToolExtension: Added Javadoc for constructor explaining initialization of defaults
  • RequirementsToolTask:
    • Added Javadoc for default constructor
    • Added inline Javadoc comments for all static constant fields documenting their purpose

Build Results

The build now completes with zero Javadoc warnings:

> Task :javadoc
> Task :javadocJar
BUILD SUCCESSFUL in 5s

Previously had 14 warnings:

  • 1x RequirementsToolExtension constructor
  • 1x RequirementsToolPlugin class
  • 1x RequirementsToolTask class
  • 11x RequirementsToolTask constants

Add comprehensive Javadoc comments for:
- RequirementsToolPlugin: default constructor
- RequirementsToolExtension: constructor
- RequirementsToolTask: class default constructor and all constant fields

This eliminates all 14 Javadoc warnings during the build process.

Signed-off-by: Jimisola Laursen <jimisola@jimisola.com>
@jimisola jimisola self-assigned this Feb 25, 2026
@jimisola jimisola merged commit 06e98b8 into main Feb 25, 2026
7 checks passed
@jimisola jimisola deleted the fix/javadoc-comments branch February 25, 2026 12:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant