Skip to content

Fix PHPDoc tags @see#87

Merged
vjik merged 4 commits intoyiisoft:masterfrom
mspirkov:fix-see-tags
Jan 7, 2026
Merged

Fix PHPDoc tags @see#87
vjik merged 4 commits intoyiisoft:masterfrom
mspirkov:fix-see-tags

Conversation

@mspirkov
Copy link
Copy Markdown
Contributor

@mspirkov mspirkov commented Jan 7, 2026

Q A
Is bugfix? ✔️
New feature?
Breaks BC?
Fixed issues

@codecov
Copy link
Copy Markdown

codecov bot commented Jan 7, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 88.23%. Comparing base (1b69c7b) to head (4b16837).
⚠️ Report is 1 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff            @@
##             master      #87   +/-   ##
=========================================
  Coverage     88.23%   88.23%           
  Complexity       36       36           
=========================================
  Files             4        4           
  Lines            85       85           
=========================================
  Hits             75       75           
  Misses           10       10           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

* - a path alias (e.g. `@vendor/yiisoft`). It will be resolved on {@see Aliases::get()} call.
*
* @see get()
* @see Aliases::get()
Copy link
Copy Markdown
Member

@vjik vjik Jan 7, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

PhpStorm supports methods in current class. ChatGPT told me that phpDocumentor does too. Should we also support it?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In turn, yii2-apidoc uses phpDocumentor/Reflection, which cannot resolve this situation correctly.

Copy link
Copy Markdown
Member

@vjik vjik Jan 7, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you improve section PHPDoc in documentation and add this requirement?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes 👍

Co-authored-by: Sergei Predvoditelev <sergey.predvoditelev@gmail.com>
@vjik vjik merged commit 06353dc into yiisoft:master Jan 7, 2026
24 of 25 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants