#1213: Resolve @see and @link to Markdown link#1314
Merged
Conversation
In descriptions it is allowed to use the @see and @link tags; these tags provide a link to a URL or other element in the project. In this commit I have added a compiler pass that visits every description and replaces the `@see` and `@link` tag with a Markdown-formatted link to that URL or href. I have chosen for a compiler pass because the transformer is the only part that really knows the URLs for Descriptors and has a list of all elements that are documented in the current project.
Member
Author
|
@ashnazg can you review this? |
Member
There was a problem hiding this comment.
Is this var_dump() left in intentionally?
Member
Author
There was a problem hiding this comment.
There is no var_dump, that was just your imagination ;)
Removed it :S
Member
|
|
Member
Author
|
LOL! 👍 |
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.
In descriptions it is allowed to use the @see and @link tags; these tags
provide a link to a URL or other element in the project. In this commit
I have added a compiler pass that visits every description and replaces
the
@seeand@linktag with a Markdown-formatted link to that URLor href.
I have chosen for a compiler pass because the transformer is the only
part that really knows the URLs for Descriptors and has a list of all
elements that are documented in the current project.