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

Make resolution of comment references homogeneous #36974

Closed
a14n opened this issue May 15, 2019 · 5 comments
Closed

Make resolution of comment references homogeneous #36974

a14n opened this issue May 15, 2019 · 5 comments
Labels
area-analyzer Use area-analyzer for Dart analyzer issues, including the analysis server and code completion. P2 A bug or feature request we're likely to work on type-enhancement A request for a change that isn't a bug

Comments

@a14n
Copy link
Contributor

a14n commented May 15, 2019

Comment references are currently handled in different ways in:

  • code navigation
  • lint comment_references
  • dartdoc

This should be fixed at the analyzer level to have consistency accross tools (linter, dartdoc, code navigation...). After that tools should be updated to use an analyzer API to resolve comment references.

Related issues:

@a14n
Copy link
Contributor Author

a14n commented May 17, 2019

/cc @bwilkerson @jcollins-g @pq

@a-siva a-siva added area-analyzer Use area-analyzer for Dart analyzer issues, including the analysis server and code completion. type-enhancement A request for a change that isn't a bug labels May 24, 2019
@srawlins srawlins added the P2 A bug or feature request we're likely to work on label Apr 12, 2021
@srawlins
Copy link
Member

Hi @a14n can you note if you have any specific needs that are affected by this shortcoming? Just because some inconsistencies are going to be much harder to implement than others:

  • @tool from flutter, @macro from flutter
  • references to non-imported elements

@a14n
Copy link
Contributor Author

a14n commented Apr 28, 2021

TBH I don't exactly remember everything. But the issue was raised after inconsistencies where the lint comment_references was triggered though dartdoc was ok and code navigation was working (or not - I don't remember).

@srawlins
Copy link
Member

+1; that lint can generate a lot of false positives and I have a plan to fix it :)

@srawlins
Copy link
Member

These are more aligned than they used to be. I've made some fixes to the comment reference parsing, and there is a remaining problem, documented in a separate ticket. The remaining work is all in the dartdoc side. You can track with dart-lang/dartdoc#3798.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area-analyzer Use area-analyzer for Dart analyzer issues, including the analysis server and code completion. P2 A bug or feature request we're likely to work on type-enhancement A request for a change that isn't a bug
Projects
None yet
Development

No branches or pull requests

3 participants