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

Invalid @see links to other structural element generated #2490

Open
Stefanius67 opened this issue Jul 27, 2020 · 0 comments
Open

Invalid @see links to other structural element generated #2490

Stefanius67 opened this issue Jul 27, 2020 · 0 comments

Comments

@Stefanius67
Copy link

Invalid @see links to other structure elements are generated if the structure element is not found in the current documentation for several reasons:

  • the link refers to any source that is not included in the project
  • a simple spelling mistake or 'letter spreader'
  • The target is hidden by the --visibility parameter

Expected behavior

  • Do not generate an invalid link (in this case it may be useful to only output the name of the target element.)
  • Generate an entry in the error list (if possible including the information if the link is valid but is hidden by the visibility)

Actual behavior

  • an invalid link is generated
  • no information in the error list

Steps to reproduce the problem

  • Insert any @see Tag with invalid method
  • Insert @see to an protected element and set --visibility=public

Your environment

  • Version used: 2e1ed05
  • Install method: PHAR from gitHub
  • PHP version: 7.4
  • Operating system and version: Ubuntu 20.04
@jaapio jaapio added this to Needs triage in phpDoc issue triage board Jul 27, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
phpDoc issue triage board
  
Needs triage
Development

No branches or pull requests

1 participant