In-game skin property documentation #186
Draft
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.



This is a proposal for providing an in-game skin property documentation. As the picture shows, there's an expandable tree in game window and it shows the skin properties. If a skin property has javadoc in source code, it'll be rendered as well.
We have discussed internally about the documentation strategy. There's mainly two ideas:
This pr picked the second way to have an easy and clean implementation for a start. If we have gathered many documentations in the future. It wouldn't be hard to migrate to the first way too.