Skip to content

[5.0] links in docblocks #41174

Merged
HLeithner merged 2 commits intojoomla:5.0-devfrom
brianteeman:doclinks
Jul 17, 2023
Merged

[5.0] links in docblocks #41174
HLeithner merged 2 commits intojoomla:5.0-devfrom
brianteeman:doclinks

Conversation

@brianteeman
Copy link
Contributor

When adding a link to a docblock it should use @link according to the specifications and not @see which is for internal use.

Reference
https://manual.phpdoc.org/HTMLSmartyConverter/PHP/phpDocumentor/tutorial_tags.link.pkg.html
https://manual.phpdoc.org/HTMLSmartyConverter/PHP/phpDocumentor/tutorial_tags.see.pkg.html

codereview only

When adding a link to a docblock it should use `@link` according to the specifications and not `@see` which is for internal use.

Reference
https://manual.phpdoc.org/HTMLSmartyConverter/PHP/phpDocumentor/tutorial_tags.link.pkg.html
https://manual.phpdoc.org/HTMLSmartyConverter/PHP/phpDocumentor/tutorial_tags.see.pkg.html
This reverts commit f9ea43c32423143f787dcff418f391b575b6bcae.
@HLeithner
Copy link
Member

thanks

@brianteeman
Copy link
Contributor Author

thanks @HLeithner can you comment on #41173 please

@brianteeman brianteeman deleted the doclinks branch July 17, 2023 07:58
@HLeithner
Copy link
Member

thanks @HLeithner can you comment on #41173 please

I already had the text in the text box but didn't submitted^^

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants