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

DartDoc for Dart SDK shows internal interfaces. #1173

Closed
lrhn opened this issue Jun 8, 2016 · 3 comments
Closed

DartDoc for Dart SDK shows internal interfaces. #1173

lrhn opened this issue Jun 8, 2016 · 3 comments
Labels
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

@lrhn
Copy link
Member

lrhn commented Jun 8, 2016

See dart-lang/sdk#26643

Basically it's exposing EfficientLength from dart:_internal.
Is this something that should be fixed in the DartDoc tool, or is there a way to hide the interface in the SDK source?

@jcollins-g jcollins-g added P3 A lower priority bug or feature request type-enhancement A request for a change that isn't a bug labels May 15, 2017
@jcollins-g
Copy link
Contributor

In some cases dartdoc will display interfaces intended to be "internal only". Dartdoc now warns on that issue as of #1390 but we don't actually do much about it ourselves yet. The SDK could hide EfficientLength by creating a public abstract class and otherwise modifying the inheritance so that the public classes don't extend private classes.

That shouldn't be strictly necessary, though. Presumably the end-goal here is to pretend that EfficientLength doesn't exist; that public classes that implement it actually don't implement it and declare all their methods and such themselves, etc. There will be some places where we can't do this, e.g. if a class is named as the type of a parameter to a real public function, but in most other cases there should be something dartdoc can do about this.

@jcollins-g jcollins-g added P2 A bug or feature request we're likely to work on and removed P3 A lower priority bug or feature request labels Oct 2, 2017
@jcollins-g
Copy link
Contributor

Elevating to P2 as there's been some traffic on questions related to this bug.

@jcollins-g
Copy link
Contributor

Fixed in #1524.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
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

2 participants