Skip to content

No doc for re-exported APIs #12759

Closed
Closed
@kwalrath

Description

@kwalrath

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.)

Activity

alan-knight

alan-knight commented on Oct 11, 2013

@alan-knight
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

alan-knight commented on Oct 11, 2013

@alan-knight
Contributor

See also 5460

alan-knight

alan-knight commented on Oct 11, 2013

@alan-knight
Contributor

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

alan-knight

alan-knight commented on Oct 30, 2013

@alan-knight
Contributor

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

alan-knight

alan-knight commented on Oct 31, 2013

@alan-knight
Contributor

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

efortuna

efortuna commented on Nov 12, 2013

@efortuna
Contributor

Set owner to @efortuna.

nex3

nex3 commented on Nov 12, 2013

@nex3
Member

Marked this as blocking #9557.

alan-knight

alan-knight commented on Nov 20, 2013

@alan-knight
Contributor

Issue #15158 has been merged into this issue.

nex3

nex3 commented on Nov 27, 2013

@nex3
Member

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

efortuna commented on Nov 27, 2013

@efortuna
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

alan-knight commented on Jan 17, 2014

@alan-knight
Contributor

Added Fixed label.

added this to the Later milestone on Jan 17, 2014
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

P1A high priority bug; for example, a single project is unusable or has many test failurestype-enhancementA request for a change that isn't a bug

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

    Development

    No branches or pull requests

      Participants

      @nex3@kevmoo@efortuna@kwalrath@alan-knight

      Issue actions

        No doc for re-exported APIs · Issue #12759 · dart-lang/sdk