docs: Add class-level Javadoc to API, platform and mixin classes; Add zh-CN docs - #1451
Open
FireOrchid2000 wants to merge 2 commits into
Open
docs: Add class-level Javadoc to API, platform and mixin classes; Add zh-CN docs#1451FireOrchid2000 wants to merge 2 commits into
FireOrchid2000 wants to merge 2 commits into
Conversation
Add concise class-level documentation to all public API classes, platform interfaces, core entry points, and mixin classes across the common, fabric and neoforge modules. Comments are English-only and describe the mixin target and intent without touching code.
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
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.
What changed
Added concise class-level Javadoc comments (English) to 320 Java files across
common,fabricandneoforge:common/.../sable/api/common/.../sable/platform/and core entry points (Sable,SableClient, config classes)mixinpackages — each comment states the mixin target class and its intentWhat did NOT change
git diffshows 0 lines removed from non-comment code{@link}references and existing formattingVerification performed
git diff: 320 files changed, +1104 insertions, 0 code deletionsNotes for the maintainer
@Mixinannotation, package path, and injected method names. These are the most likely to be inaccurate — please verify.