Skip to content

@nodoc on overridden methods only half-works #1337

@tvolkert

Description

@tvolkert

For example:

abstract class Matcher {
  /// This does the matching of the actual vs expected values.
  /// [item] is the actual value. [matchState] can be supplied
  /// and may be used to add details about the mismatch that are too
  /// costly to determine in [describeMismatch].
  bool matches(item, Map matchState);

  /// This builds a textual description of the matcher.
  Description describe(Description description);
}

abstract class NoDescriptionMatcher extends Matcher {
  /// @nodoc
  @override
  Description describe(Description description) => description;
}

class MyMatcher extends NoDescriptionMatcher {
}

If you generate dartdoc for this class structure, the HTML page for MyMatcher correctly does not show the dartdoc for the describe method. However, the HTML page for NoDescriptionMatcher does

Metadata

Metadata

Assignees

No one assigned

    Labels

    P3A lower priority bug or feature requestcustomer-flutterIssues originating from important to Fluttertype-bugIncorrect behavior (everything from a crash to more subtle misbehavior)

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions