Skip to content

dartdoc does not understand sdk_ext #763

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
eseidelGoogle opened this issue Aug 4, 2015 · 6 comments
Closed

dartdoc does not understand sdk_ext #763

eseidelGoogle opened this issue Aug 4, 2015 · 6 comments
Assignees
Labels
P1 A high priority bug; for example, a single project is unusable or has many test failures type-bug Incorrect behavior (everything from a crash to more subtle misbehavior)
Milestone

Comments

@eseidelGoogle
Copy link
Contributor

sky uses the new sdk_ext feature of the analysis server to define dart:sky. Unfortunately dartdoc doesn't seem to understand this?

  • create a pubspec.yaml:
name: docdemo
dependencies:
  sky: any
  • create a lib/main.dart:
import 'dart:sky';

class Test {
    Color color;
}
  • pub get
  • dartdoc

Generating documentation for 'docdemo' into /src/docdemo/doc/api/

parsing lib/main.dart...
Parsed 1 file in 3.2 seconds.

[error] Target of URI does not exist: 'dart:sky' at lib/main.dart, line 1.
Generation failed: encountered 1 analysis error.

@abarth

@keertip
Copy link
Collaborator

keertip commented Aug 4, 2015

@eseidelGoogle, try running dartdoc with --url-mapping option

@eseidelGoogle
Copy link
Contributor Author

Thats how we handle it today:
https://github.com/domokit/sky_engine/blob/master/sky/tools/skydoc.py

But that should no longer be necessary with the recent analyzer changes is my understanding?

@keertip
Copy link
Collaborator

keertip commented Aug 4, 2015

Looked at the sdk_ext support in analyzer, have to add code to dartdoc to use that.

eseidelGoogle added a commit to eseidelGoogle/engine that referenced this issue Aug 5, 2015
I can't really make further progress until at least:
dart-lang/dartdoc#766
is resolved, ideally also:
dart-lang/dartdoc#763

@abarth
@sethladd sethladd added the type-bug Incorrect behavior (everything from a crash to more subtle misbehavior) label Aug 5, 2015
@sethladd sethladd added this to the Branch milestone Aug 5, 2015
@sethladd
Copy link
Contributor

sethladd commented Aug 5, 2015

Thanks for the report!

(I'm a bit surprised we don't just get this one for free, but we'll certainly add it.)

@keertip keertip self-assigned this Aug 5, 2015
@sethladd sethladd added the P1 A high priority bug; for example, a single project is unusable or has many test failures label Aug 6, 2015
@keertip
Copy link
Collaborator

keertip commented Aug 7, 2015

Looked at this a bit more, there is some logic to initialize package uris and the sdk extensions. This should be in analyzer package instead of analyzer_cli, so that dartdoc and other tools can make use of it. Will do that, and then dartdoc gets the sdk extensions for free.

@sethladd
Copy link
Contributor

Fixed with #805

Thanks for the report!

@sethladd sethladd modified the milestones: Branch, 0.5.0 Aug 11, 2015
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-bug Incorrect behavior (everything from a crash to more subtle misbehavior)
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants