Optimize the custom doc for shaders. #97616
Open
+18
−14
Conversation
This file contains 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
Delsin-Yu
reviewed
Sep 29, 2024
magian1127
force-pushed
the
4.0gdshader
branch
from
61a7cff
to
59ef2e6
Compare
magian1127
force-pushed
the
4.0gdshader
branch
3 times, most recently
from
e75fc09
to
d4d6a20
Compare
anvilfolk
reviewed
Sep 29, 2024
| DocData::ClassDoc class_doc; | ||
| class_doc.name = get_path(); | ||
| class_doc.is_script_doc = true; | ||
| bool generate_doc = EditorHelp::get_doc_data() != nullptr && Engine::get_singleton()->is_editor_hint() && !get_path().is_empty(); |
There was a problem hiding this comment.
This can be simplified if #95821 is merged. You should not need to check whether get_doc_data() != nullptr, the helper methods EditorHelp::add_doc()/remove_doc() etc can make those checks :)
1. Remove `add_doc` for gdshader files without documentation. 2. Standardize the `class_doc.name` for custom documentation.
magian1127
force-pushed
the
4.0gdshader
branch
from
d4d6a20
to
d5c37b4
Compare
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.
add_docfor gdshader files without documentation.class_doc.namefor custom documentation.