Skip to content

#1148 Add Javadocs for previously undocumented methods #1149

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
GuusLieben merged 19 commits into from
Dec 19, 2025
Merged

#1148 Add Javadocs for previously undocumented methods #1149

GuusLieben merged 19 commits into from
Dec 19, 2025

Conversation

@GuusLieben
Copy link
Member

@GuusLieben GuusLieben commented Nov 13, 2025 •
edited
Loading

Type of Change

  • Documentation (documentation changes)

Description

Enables the MissingJavadocMethod Checkstyle rule, and resolves violations caused by missing Javadoc documentation on methods.

Additionally, enables the LineLength rule, and resolves violations for that as well.

Checklist

  • I have performed a self-review of my own code
  • New and existing unit tests pass locally with my changes
  • Related issue number is linked in pull request title
  • I have added documentation that describes my changes
  • Any dependent changes have been merged and published in downstream modules
  • I have rebased my branch on top of the latest develop branch

Related Issue

Closes #1148

@GuusLieben GuusLieben added this to the 0.7.0 milestone Nov 13, 2025
@GuusLieben GuusLieben self-assigned this Nov 13, 2025
@GuusLieben GuusLieben force-pushed the documentation/#1148-method-javadocs branch from f1c4a54 to f65179a Compare December 8, 2025 20:01
@GuusLieben GuusLieben changed the title #1148 Add Javadocs for previously undocumented method #1148 Add Javadocs for previously undocumented methods Dec 8, 2025
@GuusLieben
#1148 Enable MissingJavadocMethod checkstyle rule
fbbd9ef
@GuusLieben
#1148 Add missing method Javadocs for introspection modules
4c26f6b
@GuusLieben
#1148 Add missing method Javadocs for shared module
7868d59
@GuusLieben
#1148 Add missing method Javadocs for SPI module
f7aaffb
@GuusLieben
#1148 Minor cleanup of unused resources
0824740
@GuusLieben
#1148 Add missing method Javadocs for inject module
31960e4 
Does not yet include all hartshorn-inject checkstyle violations for
MissingJavadocMethod, but does resolve a large chunk of them.
@GuusLieben
#1148 Add missing method Javadocs for various modules
6e7e1eb
@GuusLieben
#1148 Fix incorrect ObjectDescriber#toString call, fix ambiguous type…
0a60d3f 
… parameter
@GuusLieben
#1148 Limit line length to 100. Initial violation fixes
b4fdd3e
@GuusLieben
#1148 Bulk resolve codestyle violations
2a01388
@GuusLieben
#1148 Format and update YAML, XML, Markdown files
9d46799
@GuusLieben
#1148 Fix Javadoc and line length violations
95bc409
@GuusLieben
#1148 Fix Javadoc headers after HSL update
9b0050a
@GuusLieben
#1148 Update license headers
e8b8b8d
@GuusLieben
#1148 Restore startup logger initializer in builder configurer
7177f68
@GuusLieben
#1148 Restore incorrectly formatted log pattern
9d71d6d
@GuusLieben GuusLieben force-pushed the documentation/#1148-method-javadocs branch from f65179a to 9d71d6d Compare December 17, 2025 19:42
@GuusLieben GuusLieben marked this pull request as ready for review December 19, 2025 16:01
@GuusLieben GuusLieben merged commit 5405874 into develop/0.7.0 Dec 19, 2025
9 checks passed
@GuusLieben GuusLieben deleted the documentation/#1148-method-javadocs branch December 19, 2025 16:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

@GuusLieben GuusLieben

Labels

None yet

Milestone

0.7.0

Development

Successfully merging this pull request may close these issues.

Catch up method documentation (Javadocs)

2 participants

@GuusLieben