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

@nodoc on overridden methods only half-works #1337

Closed
tvolkert opened this issue Feb 1, 2017 · 2 comments
Closed

@nodoc on overridden methods only half-works #1337

tvolkert opened this issue Feb 1, 2017 · 2 comments
Labels
customer-flutter Issues originating from important to Flutter P3 A lower priority bug or feature request type-bug Incorrect behavior (everything from a crash to more subtle misbehavior)

Comments

@tvolkert
Copy link

tvolkert commented Feb 1, 2017

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

@devoncarew devoncarew added type-bug Incorrect behavior (everything from a crash to more subtle misbehavior) customer-flutter Issues originating from important to Flutter labels Feb 1, 2017
@jcollins-g jcollins-g added the P3 A lower priority bug or feature request label Jul 10, 2017
@jcollins-g
Copy link
Contributor

@nodoc's current implementation is too simple, and it doesn't take either inheritance nor dartdoc's ability to import docs from parent classes into account.

@jcollins-g
Copy link
Contributor

I believe this has been fixed since v0.14.1, but didn't get closed for some reason.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
customer-flutter Issues originating from important to Flutter P3 A lower priority bug or feature request type-bug Incorrect behavior (everything from a crash to more subtle misbehavior)
Projects
None yet
Development

No branches or pull requests

3 participants