Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

@Link support in phpdoc v3 #2464

Open
jaapio opened this issue Jun 20, 2020 · 1 comment
Open

@Link support in phpdoc v3 #2464

jaapio opened this issue Jun 20, 2020 · 1 comment

Comments

@jaapio
Copy link
Member

jaapio commented Jun 20, 2020

Ref: https://github.com/php-fig/fig-standards/blob/master/proposed/phpdoc-tags.md#56-link

Open question:

I wonder if the note about support in phpDocumentor (now moved to "Effects in phpDocumentor") is still correct.

* Based on the specs the `@link` tag should only have support for URIs, not FQSEN, so why mention that as missing support ?

* IIRC, both stand-alone as well as inline `@link` tags seem to be supported in phpDocumentor 3, though some tweaking may still be needed, so is this note still relevant at all ?

* And if it is, it may be more helpful to be more specific about what is and isn't supported, so what can you tell me as input to update this ?

cc @jrfnl

@jaapio jaapio added this to Needs triage in phpDoc issue triage board Jun 20, 2020
@jaapio
Copy link
Member Author

jaapio commented Jun 20, 2020

I think you are correct about the @link FQSEN support. That note should be removed IMO.

I didn't check the link support in phpdoc v3 to be honest. I think it would be usefull to have some test cases that we can add to the demo https://github.com/phpDocumentor/phpDocumentor/tree/master/data/examples/MariosPizzeria/src so we can add test for these cases :-)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
phpDoc issue triage board
  
Needs triage
Development

No branches or pull requests

1 participant