Skip to content
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

Broken dartdoc link generated from readme #110

Closed
QuintinWillison opened this issue Apr 29, 2021 · 1 comment
Closed

Broken dartdoc link generated from readme #110

QuintinWillison opened this issue Apr 29, 2021 · 1 comment
Labels
bug Something isn't working. It's clear that this does need to be fixed. documentation Improvements or additions to public interface documentation (API reference or readme).

Comments

@QuintinWillison
Copy link
Contributor

QuintinWillison commented Apr 29, 2021

See this warning from our Build Documentation workflow step:

Documenting ably_flutter...
Initialized dartdoc with 201 libraries in 69.7 seconds
Generating docs for library ably_flutter from package:ably_flutter/ably_flutter.dart...
Validating docs...
  warning: dartdoc generated a broken link to: DeveloperNotes.md, linked to from package-ably_flutter: file:///home/runner/work/ably-flutter/ably-flutter
Found 1 warning and 0 errors.
Documented 1 public library in 8.5 seconds
Success! Docs generated into /home/runner/work/ably-flutter/ably-flutter/doc/api

┆Issue is synchronized with this Jira Bug by Unito

@QuintinWillison QuintinWillison added bug Something isn't working. It's clear that this does need to be fixed. documentation Improvements or additions to public interface documentation (API reference or readme). labels Apr 29, 2021
@ikurek
Copy link
Contributor

ikurek commented Feb 21, 2022

The issue doesn't seem to occur anymore, here's the Dartdoc output from latest builds:

Documenting ably_flutter...
Initialized dartdoc with 703 libraries
Generating docs for library ably_flutter from package:ably_flutter/ably_flutter.dart...
  warning: ably_flutter has no library level documentation comments
    from ably_flutter: (file:///home/runner/work/ably-flutter/ably-flutter/lib/ably_flutter.dart:1:9)
  warning: unresolved doc reference [ApplicationState]
    from ably_flutter.PushNotificationEvents.onNotificationTap: (file:///home/runner/work/ably-flutter/ably-flutter/lib/src/push_notifications/src/push_notification_events.dart:36:29)
Validating docs...
Found 8 warnings and 0 errors.
Documented 1 public library in 99.6 seconds
Success! Docs generated into /home/runner/work/ably-flutter/ably-flutter/doc/api

I've created a separate issue for the error that's still present in build log: #335

@ikurek ikurek closed this as completed Feb 21, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working. It's clear that this does need to be fixed. documentation Improvements or additions to public interface documentation (API reference or readme).
Development

No branches or pull requests

2 participants