Skip to content

Reference libraries with @docImports #56528

@goderbauer

Description

@goderbauer

Imagine we have a library as follows:

/// Long and extensive documentation about this library
library foo;

// Good stuff in this library.

I would now like to refer to that library comment from another file/package:

/// Bla bla bla.
///
/// The details are explained in the [foo] library.
void bar() {
  // ...
}

I would like to have [foo] link to the doc on the library foo;. Currently, this doesn't seem possible with docImports in a way that makes the comment_references lint happy.

Metadata

Metadata

Assignees

No one assigned

    Labels

    P2A bug or feature request we're likely to work onarea-devexpFor issues related to the analysis server, IDE support, linter, `dart fix`, and diagnostic messages.devexp-serverIssues related to some aspect of the analysis servertype-enhancementA request for a change that isn't a bug

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions