docs: add Javadoc to all service classes and package-info.java files#31
Merged
Conversation
Covers all 57 service classes across 30 domain modules. Each service gets class-level doc (domain responsibility, key collaborators) and public method-level doc (business purpose, invariants, side effects). Adds ~80 package-info.java files so new developers get module-level orientation before diving into individual classes.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
package-info.javafiles to give module-level orientation for new developersWhat's covered
Javadoc approach
package-info.javain every package so new developers get oriented before reading individual classes