comment,doc: added javadoc comments #35
Merged
Conversation
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
There was a problem hiding this comment.
Pull Request Overview
Adds comprehensive Javadoc to the Sabi framework’s public API and corrects a typo in an exception record.
- Introduces Javadoc for classes, interfaces, records, and methods across multiple packages.
- Renames the exception record from
RuntimeExceptionOccuredtoRuntimeExceptionOccurredand updates its usages.
Reviewed Changes
Copilot reviewed 8 out of 8 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| src/main/java/com/github/sttk/sabi/internal/DataHubInner.java | Fix spelling of RuntimeExceptionOccurred in exception mapping |
| src/main/java/com/github/sttk/sabi/Sabi.java | Add Javadoc for Sabi class and its static methods |
| src/main/java/com/github/sttk/sabi/Logic.java | Add Javadoc for Logic interface and its run method |
| src/main/java/com/github/sttk/sabi/DataSrc.java | Add Javadoc for DataSrc interface methods |
| src/main/java/com/github/sttk/sabi/DataHub.java | Add Javadoc for DataHub, its error-records, methods, and fix typo |
| src/main/java/com/github/sttk/sabi/DataConn.java | Add Javadoc for DataConn interface methods |
| src/main/java/com/github/sttk/sabi/DataAcc.java | Add Javadoc for DataAcc interface and its getDataConn method |
| src/main/java/com/github/sttk/sabi/AsyncGroup.java | Add Javadoc for AsyncGroup interface, its records, and add |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
T/O.