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

Jump to bottom

dartdoc: documentation for public class extending private class #6998

Closed
kevmoo opened this issue Nov 28, 2012 · 17 comments
Closed

dartdoc: documentation for public class extending private class #6998

kevmoo opened this issue Nov 28, 2012 · 17 comments
Labels
area-pkg Used for miscellaneous pkg/ packages not associated with specific area- teams.

Comments

@kevmoo
Copy link
Member

kevmoo commented Nov 28, 2012

What steps will reproduce the problem?

  1. create a public class that extends a private class. See diff:
    kevmoo/bot.dart@3de76d8
  2. Generate docs. See diff:
    kevmoo/bot.dart@248d564

What is the expected output? What do you see instead?

Ideally: the private class would be invisible. Members inherited from the private class would appear as defined locally.

Instead I see a link to a documentation file that doesn't exist for the class.

What version of the product are you using? On what operating system?

r15355, Mac
@anders-sandholm
Copy link
Contributor

Added Area-DartDoc, Triaged labels.

@DartBot
Copy link

DartBot commented Dec 20, 2012

This comment was originally written by amouravski@google.com

Set owner to amouravski@google.com.
Added Accepted label.

@DartBot
Copy link

DartBot commented Oct 8, 2013

This comment was originally written by amouravski@google.com

Added Triaged label.

@DartBot
Copy link

DartBot commented Oct 8, 2013

This comment was originally written by amouravski@google.com

Removed the owner.

@alan-knight
Copy link
Contributor

I believe this works in the new Dartdoc, but we should verify before closing.

Added this to the M8 milestone.
Removed Area-DartDoc label.
Added Area-DartDocNext, Accepted labels.

@alan-knight
Copy link
Contributor

This is partially working. e.g. KeyEvent shows as inheriting from Object, but it shows inherited methods from _WrappedEvent, e.g. bubbles. It's showing from the dart2js implementation, there's a different bug to switch it.

Removed this from the M8 milestone.
Added this to the M9 milestone.

@alan-knight
Copy link
Contributor

Added Library-Docgen label.

@clayberg
Copy link

Removed this from the M9 milestone.
Added this to the 1.1 milestone.

@alan-knight
Copy link
Contributor

Show methods inherited from _WrappedEvent is as designed in this case. If the method can be shown as inherited from a public class we show it, but if something is inherited from a private class and there's no other source we can show it from (e.g. we can't claim it's inherited from Object) then we show the name, but not as a link. So calling this closed.

Added Fixed label.

@kevmoo
Copy link
Member Author

kevmoo commented Jan 29, 2014

Re-opening per conversation at lunch.

If X inherits from private class _Y, the fact that its members come from _Y is an implementation detail.

I'd argue we should not show any inheritance info for these members -- make them appear as if they were defined in X.

cc @efortuna.
Added Triaged label.

@anders-sandholm
Copy link
Contributor

Removed Area-DartDocNext label.
Added Area-DartDoc label.

@anders-sandholm
Copy link
Contributor

Removed Library-Docgen label.

@alan-knight
Copy link
Contributor

Removed this from the 1.1 milestone.

@kevmoo
Copy link
Member Author

kevmoo commented Mar 17, 2014

Added Pkg-DartDoc label.

@kevmoo
Copy link
Member Author

kevmoo commented Mar 17, 2014

Removed Area-DartDoc label.
Added Area-Pkg label.

@kevmoo
Copy link
Member Author

kevmoo commented Apr 7, 2014

Removed Pkg-DartDoc label.
Added Pkg-DocGen label.

@sethladd
Copy link
Contributor

Moved to dart-lang/dartdoc#80

Added MovedToGithub label.

@kevmoo kevmoo added Type-Defect area-pkg Used for miscellaneous pkg/ packages not associated with specific area- teams. labels Jan 12, 2015
This issue was closed.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
area-pkg Used for miscellaneous pkg/ packages not associated with specific area- teams.
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
6 participants
@sethladd @kevmoo @anders-sandholm @alan-knight @clayberg @DartBot