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: Add a link from class page to full source code. #8860

Closed
DartBot opened this issue Feb 28, 2013 · 11 comments
Closed

DartDoc: Add a link from class page to full source code. #8860

DartBot opened this issue Feb 28, 2013 · 11 comments
Labels
area-pkg Used for miscellaneous pkg/ packages not associated with specific area- teams. type-enhancement A request for a change that isn't a bug

Comments

@DartBot
Copy link

DartBot commented Feb 28, 2013

This issue was originally filed by greg...@gmail.com

It would be nice to have a link from a class page on api.dartlang.org to the full source file where the class is defined.

Either a link to browse source on code.google.com, or embedding the source within api.dartlang.org.

Bonus points - if it is a abstract class, if you can add a link to the private class (or classes) that implement the interface.

Docs are nice, but easily accessible open source code is even better ;)
@sethladd
Copy link
Contributor

sethladd commented Mar 1, 2013

Removed Type-Defect label.
Added Type-Enhancement, Area-DartDoc, Triaged labels.

@DartBot
Copy link
Author

DartBot commented Mar 11, 2013

This comment was originally written by amouravski@google.com

To be fixed in next gen doc viewer.

Marked this as being blocked by #8857.

@anders-sandholm
Copy link
Contributor

Added old-dartdoc label.

@alan-knight
Copy link
Contributor

Issue #5793 has been merged into this issue.

@alan-knight
Copy link
Contributor

In general it would be good to have a mechanism for showing code inline as well as the possibility to link to the full sources.

@DartBot
Copy link
Author

DartBot commented Feb 12, 2014

This comment was originally written by greg...@gmail.com

The old Dart doc had this. But I didn't find it very useful due to the convention in the Dart source of splitting the public interface and private implementation. So you usually only got to see the method signature not the actual implementation.

Ideally there would be some way of easily getting to the actual implementation.

@kevmoo
Copy link
Member

kevmoo commented Mar 17, 2014

Added Pkg-DartDoc label.

@kevmoo
Copy link
Member

kevmoo commented Mar 17, 2014

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

@kevmoo
Copy link
Member

kevmoo commented Apr 7, 2014

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

@srawlins
Copy link
Member

I think this can be closed. The current docs at dartdocs.org and at api.dartlang.org have breadcrumbs back to the library where a class was defined. See:

http://www.dartdocs.org/documentation/args/0.12.0+2/index.html#args/args.ArgParser
https://api.dartlang.org/apidocs/channels/stable/dartdoc-viewer/dart-convert.JsonCodec

@sethladd
Copy link
Contributor

Moved over to dart-lang/dartdoc#73

Added MovedToGithub label.

@DartBot DartBot added Type-Enhancement area-pkg Used for miscellaneous pkg/ packages not associated with specific area- teams. labels Jan 10, 2015
@kevmoo kevmoo added type-enhancement A request for a change that isn't a bug and removed type-enhancement labels Mar 1, 2016
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. type-enhancement A request for a change that isn't a bug
Projects
None yet
Milestone
No milestone
Development

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