-
-
Notifications
You must be signed in to change notification settings - Fork 21
GH-1210 Add placeholder documentation automation. #1210
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.
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
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Code Review
This pull request introduces an excellent feature for automating placeholder documentation using annotations. The refactoring in AfkPlaceholderSetup to use the new @PlaceholderDocs annotation is a great improvement for maintainability and clarity. The new API for scanning and resolving these annotations is well-designed. I have a couple of suggestions to further improve the code quality by addressing a minor code clarity issue and some code duplication.
...ore-core/src/main/java/com/eternalcode/core/feature/afk/placeholder/AfkPlaceholderSetup.java
Outdated
Show resolved
Hide resolved
eternalcore-docs-generate/src/main/java/com/eternalcode/annotations/scan/GenerateDocs.java
Show resolved
Hide resolved
...ore-core/src/main/java/com/eternalcode/core/feature/afk/placeholder/AfkPlaceholderSetup.java
Show resolved
Hide resolved
CitralFlo
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Rollczi: dodatkowe review w commit wip. ogólnie spoko
eternalcore-docs-generate/src/main/java/com/eternalcode/annotations/scan/GenerateDocs.java
Outdated
Show resolved
Hide resolved
eternalcore-core/src/main/java/com/eternalcode/core/feature/home/HomePlaceholderSetup.java
Show resolved
Hide resolved
|
|
||
| @Override | ||
| public PlaceholderResult resolve(EternalScanRecord record, PlaceholderDocs annotation) { | ||
| String prefixedName = "%eternalcore_" + annotation.name() + "%"; |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| String prefixedName = "%eternalcore_" + annotation.name() + "%"; | |
| String prefix = "%eternalcore_" + annotation.name() + "%"; |
| public PlaceholderResult resolve(EternalScanRecord record, PlaceholderDocs annotation) { | ||
| String prefixedName = "%eternalcore_" + annotation.name() + "%"; | ||
| return new PlaceholderResult( | ||
| prefixedName, |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| prefixedName, | |
| prefix, |
Fixes: #1209