Skip to content

No doc for re-exported APIs #12759

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
kwalrath opened this issue Aug 26, 2013 · 11 comments
Closed

No doc for re-exported APIs #12759

kwalrath opened this issue Aug 26, 2013 · 11 comments
Assignees
Labels
P1 A high priority bug; for example, a single project is unusable or has many test failures type-enhancement A request for a change that isn't a bug

Comments

@kwalrath
Copy link
Contributor

If you generate docs for the sequence_zip package, you see no classes. Instead, you should probably get docs for all the APIs in the libraries that sequence_zip exports. Or at least you should automatically get links to those libraries.

Details: sequence_zip exports iterable_zip and stream_zip. When I generate docs for the sequence_zip directory, I get docs for all 3 packages, but there's nothing at all in the sequence_zip docs.

I'll work around this by adding a class description that links to those two libraries.

This problem is also in the old dartdoc. In fact, it's worse, since for some reason it doesn't generate docs for the iterable_zip or stream_zip libraries either. (Bug 10585 might be the same.)

@alan-knight
Copy link
Contributor

Seems reasonable, but not urgent.


Added this to the Later milestone.
Removed Type-Defect, Priority-Unassigned labels.
Added Type-Enhancement, Priority-Medium, Library-Docgen labels.

@alan-knight
Copy link
Contributor

See also 5460

@alan-knight
Copy link
Contributor

Removed this from the Later milestone.
Added this to the M8 milestone.
Removed Priority-Medium label.
Added Priority-High, C1 labels.

@alan-knight
Copy link
Contributor

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

@alan-knight
Copy link
Contributor

Removed this from the M9 milestone.
Added this to the Later milestone.
Marked this as being blocked by #14669.

@efortuna
Copy link
Contributor

Set owner to @efortuna.

@nex3
Copy link
Member

nex3 commented Nov 12, 2013

Marked this as blocking #9557.

@alan-knight
Copy link
Contributor

Issue #15158 has been merged into this issue.

@nex3
Copy link
Member

nex3 commented Nov 27, 2013

Is this fixed? It looks like e.g. the http library docs contain re-exported members: http://test.dartdoc-next.appspot.com/#http/http

@efortuna
Copy link
Contributor

The bulk of it is fixed, but there are a few details that I'm still working out like the parameter links on the methods can sometimes be a little wacky. But yes, it's probably enough for you to proceed on your end.

@alan-knight
Copy link
Contributor

Added Fixed label.

@kwalrath kwalrath added Type-Enhancement P1 A high priority bug; for example, a single project is unusable or has many test failures labels Jan 17, 2014
@kwalrath kwalrath added this to the Later milestone Jan 17, 2014
@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
Labels
P1 A high priority bug; for example, a single project is unusable or has many test failures type-enhancement A request for a change that isn't a bug
Projects
None yet
Development

No branches or pull requests

5 participants