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

FR: List unresolved FQNs in warnings #2455

Open
jrfnl opened this issue Jun 17, 2020 · 2 comments
Open

FR: List unresolved FQNs in warnings #2455

jrfnl opened this issue Jun 17, 2020 · 2 comments

Comments

@jrfnl
Copy link
Contributor

jrfnl commented Jun 17, 2020

Feature request

For @see tags which refer to an FQN not found in the project, it would be useful to see them listed in the "Warnings" report.

This would then warn for @see tags referring to classes external to the project, but would also be helpful to find mistakes made in @see tags and/or typos.

Please let me know if this report is clear enough or whether I need to expand on it.

@mvriel
Copy link
Member

mvriel commented Jun 17, 2020

The issue is clear to me. It will have an impact since people also link to PHP own materials and that would give warnings too. We have a story to use PHPStorm's stubs to provide links / documentation to php's internal classes and functions; but I think that we should postpone thinking / working on this issue until v3 is launched.

@mvriel mvriel added this to the 3.1 milestone Jun 17, 2020
@jrfnl
Copy link
Contributor Author

jrfnl commented Jun 17, 2020

Ah, yes, i can see that. I personally use the @link tag for that as those are pointers to resources outside of the project, but if/when phpDocumentor would use the stubs to allow auto-linking via the @see tag, I can easily see myself switching ;-)

jrfnl added a commit to jrfnl/phpDocumentor-issue-demo that referenced this issue Jun 17, 2020
@jaapio jaapio added this to Backlog in v3.2 via automation Nov 6, 2020
@jaapio jaapio modified the milestones: 3.1, 3.2 Jul 4, 2021
@jaapio jaapio added this to To do in v3.4 Dec 28, 2021
@jaapio jaapio modified the milestones: 3.2, 3.4.4 Jan 26, 2024
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
v3.2
Backlog
v3.4
Backlog
Development

No branches or pull requests

3 participants