Skip to content

dartdoc: top-levels should be after interfaces, classes, and exceptions #3171

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

Closed
DartBot opened this issue May 22, 2012 · 8 comments
Closed

Comments

@DartBot
Copy link

DartBot commented May 22, 2012

This issue was originally filed by @seaneagan


Top-level methods, getters, setters, and variables are currently at the beginning of the output. They may contain extensive comments. This pushes the links to interfaces, classes, and exceptions "after the fold" and thus makes them much more difficult to find. Some good examples are:

http://api.dartlang.org/uri.html
http://api.dartlang.org/dart_isolate.html

Moving the top-levels to the end would fix this.

@iposva-google
Copy link
Contributor

Added Area-DartDoc, Accepted labels.

@munificent
Copy link
Member

Most libraries have more classes than top-level functions, so I'd hate to always push them under that potentially long list. Maybe we could do:

  1. List of top-level definitions without docs. Each has an anchor link to 3.
  2. List of types, which link to type pages.
  3. Top-level definitions with their docs.
    Added this to the Later milestone.

@dgrove
Copy link
Contributor

dgrove commented Oct 18, 2012

to fix in the next generation dartdoc viewer.


cc @jmesserly.
cc @sigmundch.
Set owner to @jacob314.

@DartBot
Copy link
Author

DartBot commented Mar 11, 2013

This comment was originally written by [email protected]


Marked this as being blocked by #8857.

@jacob314
Copy link
Member

Set owner to @efortuna.

@efortuna
Copy link
Contributor

efortuna commented Oct 4, 2013

cc @alan-knight.
Removed the owner.

@alan-knight
Copy link
Contributor

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

@alan-knight
Copy link
Contributor

Libraries vary in what's most important to expose. I think the reasonable answer to this is to have good navigation. So, in the current Dartdoc-next http://dartdoc-next.dartlang-api.appspot.com/apidocs/ we still have functions first in a library, but there's a navigation bar on the right in which you can easily scroll down to see the classes. And you can collapse the list of functions, or classes, if they're not interesting. So calling this fixed.


Added Fixed label.

@DartBot DartBot added this to the Later milestone Nov 13, 2013
This issue was closed.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

7 participants