Skip to content

Invalid dartdoc references should have visual distinction #3075

Open
@gspencergoog

Description

@gspencergoog

Currently, if there is an invalid dartdoc reference (e.g. [NonExistentClass]) in IntelliJ, the only way to know that it is invalid is to try and command/ctrl-click on the reference and have it say "Cannot find declaration to go to". It would be super helpful to have those references that are invalid shown in a way that distinguishes them (and configurable in prefs). This would help in avoiding invalid links/typos in the documentation.

Activity

devoncarew

devoncarew commented on Jan 14, 2019

@devoncarew
Member

+1

One thing to keep in mind here is that dartdoc understands a broader range of references than the analyzer does. Flutter uses this feature - doc comments there will reference symbols that are not in scope of the current imports (esp., things from further up the stack).

added this to the Backlog milestone on Jan 14, 2019
gspencergoog

gspencergoog commented on Jan 14, 2019

@gspencergoog
Author

Yeah, I know: I had added some imports to make things valid links for the analyzer that I later had to remove (but they're still valid links to dartdoc). It would be nice if there were a way to specify imports to the analyzer that only apply when processing docs, but that also seems a little complicated and pedantic, so I don't know what the right answer is.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Relationships

    None yet

      Development

      No branches or pull requests

        Participants

        @pq@devoncarew@gspencergoog

        Issue actions

          Invalid dartdoc references should have visual distinction · Issue #3075 · flutter/flutter-intellij