Correct note on single-line shader documentation comments #11552
+5
−2
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
Calinou
reviewed
Jan 8, 2026
Member
Calinou
left a comment
Calinou
left a comment
There was a problem hiding this comment.
The previous comment is still technically correct: only the multiline syntax is supported, even if you use it on a single line.
What's not supported specifically is the Doxygen-style triple slash syntax (///).
Calinou
added
enhancement
area:manual
Contributor
Author
|
Ah, my mistake. That makes sense. In that case, should the comment be clarified somehow? |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Corrects the shading language documentation where it incorrectly states that single-line documentation comments aren't supported. From my testing, single-line comments have been supported since 4.3 when shader documentation comments were introduced.