More docimports for animation library #151011
Conversation
github-actions
bot
added
framework
| /// | ||
| /// The Flutter animation system. | ||
| /// | ||
| /// To use, import `package:flutter/animation.dart`. |
There was a problem hiding this comment.
@srawlins does it make sense to put these at the top of the already present doc comment on the library statement?
There was a problem hiding this comment.
Hm, I guess this doesn't quite work yet as dartdoc puts that string into the output (see screenshot below). Does this need a fix in dartdoc?
There was a problem hiding this comment.
It also shows up in the libraries overview:
There was a problem hiding this comment.
I fixed this yesterday and it will be released with dartdoc 8.0.10: https://github.com/dart-lang/dartdoc/pull/3806/files
There was a problem hiding this comment.
Oh and to answer your question about top or bottom, I think that's your choice; it should work equally either way. I would probably lean towards putting them at the bottom, as it would be tedious to read the library doc comments in source if they started with a handful of doc-imports.
There was a problem hiding this comment.
Awesome. I verified locally that it works with this change. #151107 bumps the dartdoc version.
There was a problem hiding this comment.
I would probably lean towards putting them at the bottom, as it would be tedious to read the library doc comments in source if they started with a handful of doc-imports.
That's a good point, I'll move these to the bottom. I low-key want a lint for this :P
| /// | ||
| /// The Flutter animation system. | ||
| /// | ||
| /// To use, import `package:flutter/animation.dart`. |
There was a problem hiding this comment.
Oh and to answer your question about top or bottom, I think that's your choice; it should work equally either way. I would probably lean towards putting them at the bottom, as it would be tedious to read the library doc comments in source if they started with a handful of doc-imports.
| /// | ||
| /// The Flutter animation system. | ||
| /// | ||
| /// To use, import `package:flutter/animation.dart`. |
goderbauer
added
the
autosubmit
|
Once this is submitted, the |
docimports for references in doc comments on library statements now work! Part of flutter#150800
flutter/flutter@99bb2ff...af913a7 2024-07-02 [email protected] Use `ErrorHandlingFileSystem.deleteIfExists` when deleting .plugin_symlinks (flutter/flutter#151073) 2024-07-02 [email protected] ScrollEndNotification example: auto-scroll based on RenderSliver constraints and geometry (flutter/flutter#143538) 2024-07-02 [email protected] Roll Packages from 412ec46 to d2705fb (13 revisions) (flutter/flutter#151169) 2024-07-02 [email protected] docimports for painting (flutter/flutter#151143) 2024-07-02 [email protected] docimports for scheduler (flutter/flutter#151126) 2024-07-02 [email protected] `dismissible.dart` code cleanup (flutter/flutter#150276) 2024-07-02 [email protected] docimports for physics (flutter/flutter#151125) 2024-07-02 [email protected] docimports for services (flutter/flutter#151134) 2024-07-02 [email protected] docimports for cupertino (flutter/flutter#151149) 2024-07-02 [email protected] docimports for gestures (flutter/flutter#151123) 2024-07-02 [email protected] Docimports for foundation (flutter/flutter#151119) 2024-07-02 [email protected] docimports for semantics (flutter/flutter#151132) 2024-07-02 [email protected] [flutter_driver] add allocator mtl to memory event allowlist. (flutter/flutter#151153) 2024-07-02 [email protected] Roll Flutter Engine from 40c087b31515 to 433d360eee11 (7 revisions) (flutter/flutter#151165) 2024-07-02 [email protected] Refactor BuildInfo to always require packageConfigPath (flutter/flutter#150559) 2024-07-02 [email protected] Roll Flutter Engine from d3c5bd66a78f to 40c087b31515 (1 revision) (flutter/flutter#151156) 2024-07-02 [email protected] Roll Flutter Engine from fc5bc14e6091 to d3c5bd66a78f (1 revision) (flutter/flutter#151155) 2024-07-02 [email protected] Fix: `CupertinoActionSheet` should take up max height when actions section is short (flutter/flutter#150708) 2024-07-02 [email protected] Roll Flutter Engine from 3456fee1a6b9 to fc5bc14e6091 (8 revisions) (flutter/flutter#151150) 2024-07-02 [email protected] [tool] remove some temporary printTrace calls (flutter/flutter#151074) 2024-07-01 [email protected] Implementing a few switch statements (flutter/flutter#150946) 2024-07-01 98614782+auto-submit[bot]@users.noreply.github.com Reverts "Upgrade template Gradle, App AGP, Module AGP, and Kotlin versions, and tests (#150969)" (flutter/flutter#151147) 2024-07-01 [email protected] Upgrade template Gradle, App AGP, Module AGP, and Kotlin versions, and tests (flutter/flutter#150969) 2024-07-01 [email protected] Roll Flutter Engine from b57a044ed10f to 3456fee1a6b9 (5 revisions) (flutter/flutter#151127) 2024-07-01 [email protected] Read AndroidManifest.xml and emit manifest-aar-impeller-(enabled|disabled) analytics (flutter/flutter#150970) 2024-07-01 [email protected] More docimports for animation library (flutter/flutter#151011) 2024-07-01 [email protected] Bump dartdoc to 8.0.10 (flutter/flutter#151107) 2024-07-01 [email protected] Fix missing `[` in docs (flutter/flutter#151091) 2024-07-01 [email protected] Roll pub packages (flutter/flutter#151028) 2024-07-01 [email protected] Fix teardown of a FocusScopeNode in material/app_test (flutter/flutter#151115) If this roll has caused a breakage, revert this CL and stop the roller using the controls here: https://autoroll.skia.org/r/flutter-packages Please CC [email protected],[email protected],[email protected] on the revert to ensure that a human is aware of the problem. To file a bug in Packages: https://github.com/flutter/flutter/issues/new/choose To report a problem with the AutoRoller itself, please file a bug: https://issues.skia.org/issues/new?component=1389291&template=1850622 Documentation for the AutoRoller is here: https://skia.googlesource.com/buildbot/+doc/main/autoroll/README.md
docimports for references in doc comments on library statements now work! Part of flutter#150800
2 participants
docimports for references in doc comments on library statements now work!
Part of #150800