Skip to content

further tighten warnings to eliminate false positives #1412

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
devoncarew opened this issue May 10, 2017 · 3 comments · Fixed by #1891
Closed

further tighten warnings to eliminate false positives #1412

devoncarew opened this issue May 10, 2017 · 3 comments · Fixed by #1891
Labels
P2 A bug or feature request we're likely to work on

Comments

@devoncarew
Copy link
Member

devoncarew commented May 10, 2017

I see the errors below when generating docs for a package. I'm not generating docs for the sdk, or using the --auto-include-dependencies flag. It's not clear to me why I'm getting these errors, and if they mean I have issues in my code, the sdk has issues, or there's a bug in dartdoc.

generating docs for library analysis_server_lib from analysis_server_lib.dart...
 warning: no canonical library found for dart-core.String, not linking (file:///usr/local/Cellar/dart/1.24.0-dev.3.0/libexec/lib/core/string.dart:92:16)
 warning: no canonical library found for dart-core.int, not linking (file:///usr/local/Cellar/dart/1.24.0-dev.3.0/libexec/lib/core/int.dart:20:16)
 warning: no canonical library found for dart-core.Type, not linking (file:///usr/local/Cellar/dart/1.24.0-dev.3.0/libexec/lib/core/type.dart:10:16)
 warning: no canonical library found for dart-core.Map, not linking (file:///usr/local/Cellar/dart/1.24.0-dev.3.0/libexec/lib/core/map.dart:28:16)
 warning: no canonical library found for dart-core.Invocation, not linking (file:///usr/local/Cellar/dart/1.24.0-dev.3.0/libexec/lib/core/invocation.dart:14:16)
 warning: no canonical library found for dart-core.bool, not linking (file:///usr/local/Cellar/dart/1.24.0-dev.3.0/libexec/lib/core/bool.dart:14:7)
 warning: no canonical library found for dart-core.List, not linking (file:///usr/local/Cellar/dart/1.24.0-dev.3.0/libexec/lib/core/list.dart:54:16)
 warning: unresolved doc reference [identityHashCode], from analysis_server_lib.AnalysisAnalyzedFiles.hashCode (file:///usr/local/Cellar/dart/1.24.0-dev.3.0/libexec/lib/core/object.dart)
 warning: unresolved doc reference [HashSet], from analysis_server_lib.AnalysisAnalyzedFiles.hashCode (file:///usr/local/Cellar/dart/1.24.0-dev.3.0/libexec/lib/core/object.dart)
 warning: unresolved doc reference [HashMap], from analysis_server_lib.AnalysisAnalyzedFiles.hashCode (file:///usr/local/Cellar/dart/1.24.0-dev.3.0/libexec/lib/core/object.dart)
 warning: no canonical library found for dart-core.NoSuchMethodError, not linking (file:///usr/local/Cellar/dart/1.24.0-dev.3.0/libexec/lib/core/errors.dart:431:7)
 warning: no canonical library found for dart-core.Object, not linking (file:///usr/local/Cellar/dart/1.24.0-dev.3.0/libexec/lib/core/object.dart:21:7)
 warning: no canonical library found for dart-async.Stream, not linking (file:///usr/local/Cellar/dart/1.24.0-dev.3.0/libexec/lib/async/stream.dart:76:16)
 warning: no canonical library found for dart-async.Future, not linking (file:///usr/local/Cellar/dart/1.24.0-dev.3.0/libexec/lib/async/future.dart:136:16)
 warning: unresolved doc reference [identityHashCode], from analysis_server_lib.AnalysisError.hashCode (file:///Users/devoncarew/projects/devoncarew/analysis_server_lib/lib/analysis_server_lib.dart)
 warning: unresolved doc reference [HashSet], from analysis_server_lib.AnalysisError.hashCode (file:///Users/devoncarew/projects/devoncarew/analysis_server_lib/lib/analysis_server_lib.dart)
 warning: unresolved doc reference [HashMap], from analysis_server_lib.AnalysisError.hashCode (file:///Users/devoncarew/projects/devoncarew/analysis_server_lib/lib/analysis_server_lib.dart)
 warning: no canonical library found for dart-async.Completer, not linking (file:///usr/local/Cellar/dart/1.24.0-dev.3.0/libexec/lib/async/future.dart:752:16)
 warning: no canonical library found for dart-core.Function, not linking (file:///usr/local/Cellar/dart/1.24.0-dev.3.0/libexec/lib/core/function.dart:13:16)
 warning: unresolved doc reference [identityHashCode], from analysis_server_lib.Location.hashCode (file:///Users/devoncarew/projects/devoncarew/analysis_server_lib/lib/analysis_server_lib.dart)
 warning: unresolved doc reference [HashSet], from analysis_server_lib.Location.hashCode (file:///Users/devoncarew/projects/devoncarew/analysis_server_lib/lib/analysis_server_lib.dart)
 warning: unresolved doc reference [HashMap], from analysis_server_lib.Location.hashCode (file:///Users/devoncarew/projects/devoncarew/analysis_server_lib/lib/analysis_server_lib.dart)
@jcollins-g
Copy link
Contributor

Dartdoc still has a few bugs in our warnings. We should not warn on no canonical library by default for objects outside of the package(s) we are documenting (at least, until we have external linking).

For unresolved doc references, those are mostly real and I'm working on squishing the ones that aren't.

@devoncarew
Copy link
Member Author

A goal here (and perhaps a good test?) could be that dartdoc can doc itself w/o warnings.

@jcollins-g
Copy link
Contributor

Indeed. And I'd add to that: no warnings enabled by default are the result of:

  1. things the owner of a documented package can not fix.
  2. things that are expected behavior (even at an intermediate stage of fixing up dartdoc)

@jcollins-g jcollins-g added the P2 A bug or feature request we're likely to work on label May 15, 2017
@jcollins-g jcollins-g changed the title errors from the sdk when generating package docs further tighten warnings to eliminate false positives May 15, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
P2 A bug or feature request we're likely to work on
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants