[TASK] Add SchemaGenerator evaluation for "@see"#1047
Merged
lolli42 merged 1 commit intoTYPO3:mainfrom Apr 9, 2025
Merged
Conversation
The phpDoc annotation "@see" contains valuable information for the XSD schema generation for future reading. Even though some IDEs like PHPStorm will not expose these links as being clickable, they can be copied+pasted from a tooltip in the IDE, and opened in the browser (instead of needing to find and open a PHP classfile to get to that link). Some IDEs (eclipse?) seem to be able to parse a HTML subset for annotations, so maybe this will find future adoption (or markdown rendering might get available). Since also neither ReST nor Markdown is parsed in the XSD element `xsd:documentation` by PHPStorm either.... plaintext it is!
lolli42
approved these changes
Apr 9, 2025
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
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.
The phpDoc annotation "@see" contains valuable information for the XSD schema generation for future reading.
Even though some IDEs like PHPStorm will not expose these links as being clickable, they can be copied+pasted from a tooltip in the IDE, and opened in the browser (instead of needing to find and open a PHP classfile to get to that link).
Some IDEs (eclipse?) seem to be able to parse a HTML subset for annotations, so maybe this will find future adoption (or markdown rendering might get available). Since also neither ReST nor Markdown is parsed in the XSD element
xsd:documentationby PHPStorm either.... plaintext it is!