Skip to content

Add doxygen doc generation. - #131356

Merged
gspencergoog merged 2 commits into
flutter:masterfrom
gspencergoog:add_doxygen_docs
Aug 29, 2023
Merged

Add doxygen doc generation.#131356
gspencergoog merged 2 commits into
flutter:masterfrom
gspencergoog:add_doxygen_docs

Conversation

@gspencergoog

@gspencergooggspencergoog commented Jul 26, 2023•
edited
Loading

Copy link
Copy Markdown
Contributor

Description

This integrates the doxygen docs generated by the engine in PR flutter-team-archive/engine#43915 into the API docs site using dummy Dart packages, and adds extraction of the various sections from the engine-uploaded documentation artifacts.

Related Issues

@goderbauergoderbauer added the framework flutter/packages/flutter repository. See also f: labels. label Aug 8, 2023
@github-actionsgithub-actionsBot added a: tests "flutter test", flutter_test, or one of our tests a: text input Entering text in a text field or keyboard related problems platform-ios iOS applications specifically tool Affects the "flutter" command-line tool. See also t: labels. engine flutter/engine related. See also e: labels. a: animation Animation APIs p: material_ui material_ui package in flutter/packages a: accessibility Accessibility, e.g. VoiceOver or TalkBack. (aka a11y) a: internationalization Supporting other languages or locales. (aka i18n) f: scrolling Viewports, list views, slivers, etc. p: cupertino_ui cupertino_ui package in flutter/packages d: api docs Issues with https://api.flutter.dev/ d: examples Sample code and demos f: routes Navigator, Router, and related APIs. f: gestures flutter/packages/flutter/gestures repository. a: desktop Running on desktop f: integration_test The flutter/packages/integration_test plugin c: tech-debt Technical debt, code quality, testing, etc. labels Aug 15, 2023
@gspencergoog
gspencergoogforce-pushed the add_doxygen_docs branch 2 times, most recently from 7b91b7e to 4da5146CompareAugust 15, 2023 23:56
@justinmc

justinmc commented Aug 17, 2023

Copy link
Copy Markdown
Contributor

Cool idea!

@gspencergoog

gspencergoog commented Aug 17, 2023

Copy link
Copy Markdown
ContributorAuthor

Thanks, but not my idea. I'm just adding the missing platform docs to it: we already have this for iOS and Android.

@gspencergooggspencergoog removed a: tests "flutter test", flutter_test, or one of our tests a: text input Entering text in a text field or keyboard related problems platform-ios iOS applications specifically tool Affects the "flutter" command-line tool. See also t: labels. engine flutter/engine related. See also e: labels. a: animation Animation APIs labels Aug 17, 2023
@gspencergooggspencergoog mentioned this pull request Aug 18, 2023
Closed
@gspencergoog
gspencergoogforce-pushed the add_doxygen_docs branch 2 times, most recently from 992de4a to 375631eCompareAugust 18, 2023 23:12
@gspencergoog
gspencergoog marked this pull request as ready for review August 18, 2023 23:13
@gspencergooggspencergoog mentioned this pull request Aug 24, 2023
Closed
8 tasks
@flutterflutter deleted a comment from flutter-dashboardBotAug 25, 2023
@gspencergoog
gspencergoogforce-pushed the add_doxygen_docs branch 4 times, most recently from f9823ca to 4129082CompareAugust 29, 2023 16:29
@gspencergoog
gspencergoog requested review from christopherfujino and removed request for zandersoAugust 29, 2023 17:12
christopherfujino
christopherfujino reviewed Aug 29, 2023
View reviewed changes
Comment threaddev/docs/README.md
christopherfujino
christopherfujino reviewed Aug 29, 2023
View reviewed changes
Comment threaddev/tools/create_api_docs.dart
christopherfujino
christopherfujino approved these changes Aug 29, 2023
View reviewed changes

@christopherfujinochristopherfujino left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@gspencergoog
gspencergoog merged commit ff829fd into flutter:masterAug 29, 2023
@engine-flutter-autorollengine-flutter-autoroll mentioned this pull request Aug 30, 2023
Merged
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Aug 30, 2023
@engine-flutter-autoroll
ff829fdAdd doxygen doc generation. (flutter/flutter#131356)
48fe5f3
auto-submitBot pushed a commit to flutter/packages that referenced this pull request Aug 30, 2023
@engine-flutter-autoroll
Roll Flutter from6c95737to1fe2495(24 revisions) (#4817)
5ad43c8
flutter/flutter@6c95737...1fe2495
2023-08-30 leroux_bruno@yahoo.fr Update SelectableRegion test for M3 (flutter/flutter#129627)
2023-08-30 godofredoc@google.com Remove cirrus tests from the flutter framework. (flutter/flutter#133575)
2023-08-30 engine-flutter-autoroll@skia.org Roll Flutter Engine from 749e67a947bc to 69f04bdfe952 (2 revisions) (flutter/flutter#133621)
2023-08-30 xilaizhang@google.com [flutter roll] Revert "Fix `Chip.shape`'s side is not used when provided in Material 3" (flutter/flutter#133615)
2023-08-30 engine-flutter-autoroll@skia.org Roll Flutter Engine from 9f2cf5c99b0f to 749e67a947bc (2 revisions) (flutter/flutter#133618)
2023-08-30 engine-flutter-autoroll@skia.org Roll Flutter Engine from c5854a6b3658 to 9f2cf5c99b0f (4 revisions) (flutter/flutter#133616)
2023-08-30 parlough@gmail.com No longer include `.packages` in created `.gitignore` files (flutter/flutter#133484)
2023-08-30 engine-flutter-autoroll@skia.org Roll Flutter Engine from db3ecf8b2739 to c5854a6b3658 (1 revision) (flutter/flutter#133610)
2023-08-29 engine-flutter-autoroll@skia.org Roll Flutter Engine from 1feb9302050c to db3ecf8b2739 (4 revisions) (flutter/flutter#133609)
2023-08-29 polinach@google.com Fix one notDisposed leak and mark another. (flutter/flutter#133595)
2023-08-29 engine-flutter-autoroll@skia.org Roll Flutter Engine from 01a1579808b5 to 1feb9302050c (1 revision) (flutter/flutter#133604)
2023-08-29 polinach@google.com Upgrade packages. (flutter/flutter#133593)
2023-08-29 polinach@google.com Cover more tests with leak tracking. (flutter/flutter#133596)
2023-08-29 engine-flutter-autoroll@skia.org Roll Flutter Engine from 73cc3fb451fd to 01a1579808b5 (3 revisions) (flutter/flutter#133591)
2023-08-29 hans.muller@gmail.com Added DropdownMenuEntry.labelWidget (flutter/flutter#133491)
2023-08-29 ian@hixie.ch Use a fake stopwatch to remove flakiness. (flutter/flutter#133229)
2023-08-29 engine-flutter-autoroll@skia.org Roll Flutter Engine from d1e6eb080f08 to 73cc3fb451fd (3 revisions) (flutter/flutter#133580)
2023-08-29 mdebbar@google.com [web] Migrate remaining web-only API usages to `dart:ui_web` (flutter/flutter#132248)
2023-08-29 gspencergoog@users.noreply.github.com Add doxygen doc generation. (flutter/flutter#131356)
2023-08-29 engine-flutter-autoroll@skia.org Roll Flutter Engine from 50bd80773287 to d1e6eb080f08 (2 revisions) (flutter/flutter#133570)
2023-08-29 polinach@google.com ShortcutManager should dispatch creation in constructor. (flutter/flutter#133487)
2023-08-29 tessertaha@gmail.com Add FAB Additional Color Mappings example (flutter/flutter#133453)
2023-08-29 engine-flutter-autoroll@skia.org Roll Flutter Engine from 65438c7bb46a to 50bd80773287 (1 revision) (flutter/flutter#133565)
2023-08-29 engine-flutter-autoroll@skia.org Roll Packages from 383bffa to d7d3150 (13 revisions) (flutter/flutter#133564)
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 rmistry@google.com,stuartmorgan@google.com 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://bugs.chromium.org/p/skia/issues/entry?template=Autoroller+Bug
Documentation for the AutoRoller is here:
https://skia.googlesource.com/buildbot/+doc/main/autoroll/README.md
@HansMullerHansMuller mentioned this pull request Sep 1, 2023
Closed
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Nov 15, 2023
@engine-flutter-autoroll
ff829fdAdd doxygen doc generation. (flutter/flutter#131356)
2ffc9c7
creatorpiyush pushed a commit to creatorpiyush/packages that referenced this pull request Jun 10, 2026
@engine-flutter-autoroll
Roll Flutter from6c95737to1fe2495(24 revisions) (flutter#4817)
c22364b
flutter/flutter@6c95737...1fe2495
2023-08-30 leroux_bruno@yahoo.fr Update SelectableRegion test for M3 (flutter/flutter#129627)
2023-08-30 godofredoc@google.com Remove cirrus tests from the flutter framework. (flutter/flutter#133575)
2023-08-30 engine-flutter-autoroll@skia.org Roll Flutter Engine from 749e67a947bc to 69f04bdfe952 (2 revisions) (flutter/flutter#133621)
2023-08-30 xilaizhang@google.com [flutter roll] Revert "Fix `Chip.shape`'s side is not used when provided in Material 3" (flutter/flutter#133615)
2023-08-30 engine-flutter-autoroll@skia.org Roll Flutter Engine from 9f2cf5c99b0f to 749e67a947bc (2 revisions) (flutter/flutter#133618)
2023-08-30 engine-flutter-autoroll@skia.org Roll Flutter Engine from c5854a6b3658 to 9f2cf5c99b0f (4 revisions) (flutter/flutter#133616)
2023-08-30 parlough@gmail.com No longer include `.packages` in created `.gitignore` files (flutter/flutter#133484)
2023-08-30 engine-flutter-autoroll@skia.org Roll Flutter Engine from db3ecf8b2739 to c5854a6b3658 (1 revision) (flutter/flutter#133610)
2023-08-29 engine-flutter-autoroll@skia.org Roll Flutter Engine from 1feb9302050c to db3ecf8b2739 (4 revisions) (flutter/flutter#133609)
2023-08-29 polinach@google.com Fix one notDisposed leak and mark another. (flutter/flutter#133595)
2023-08-29 engine-flutter-autoroll@skia.org Roll Flutter Engine from 01a1579808b5 to 1feb9302050c (1 revision) (flutter/flutter#133604)
2023-08-29 polinach@google.com Upgrade packages. (flutter/flutter#133593)
2023-08-29 polinach@google.com Cover more tests with leak tracking. (flutter/flutter#133596)
2023-08-29 engine-flutter-autoroll@skia.org Roll Flutter Engine from 73cc3fb451fd to 01a1579808b5 (3 revisions) (flutter/flutter#133591)
2023-08-29 hans.muller@gmail.com Added DropdownMenuEntry.labelWidget (flutter/flutter#133491)
2023-08-29 ian@hixie.ch Use a fake stopwatch to remove flakiness. (flutter/flutter#133229)
2023-08-29 engine-flutter-autoroll@skia.org Roll Flutter Engine from d1e6eb080f08 to 73cc3fb451fd (3 revisions) (flutter/flutter#133580)
2023-08-29 mdebbar@google.com [web] Migrate remaining web-only API usages to `dart:ui_web` (flutter/flutter#132248)
2023-08-29 gspencergoog@users.noreply.github.com Add doxygen doc generation. (flutter/flutter#131356)
2023-08-29 engine-flutter-autoroll@skia.org Roll Flutter Engine from 50bd80773287 to d1e6eb080f08 (2 revisions) (flutter/flutter#133570)
2023-08-29 polinach@google.com ShortcutManager should dispatch creation in constructor. (flutter/flutter#133487)
2023-08-29 tessertaha@gmail.com Add FAB Additional Color Mappings example (flutter/flutter#133453)
2023-08-29 engine-flutter-autoroll@skia.org Roll Flutter Engine from 65438c7bb46a to 50bd80773287 (1 revision) (flutter/flutter#133565)
2023-08-29 engine-flutter-autoroll@skia.org Roll Packages from 383bffa to d7d3150 (13 revisions) (flutter/flutter#133564)
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 rmistry@google.com,stuartmorgan@google.com 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://bugs.chromium.org/p/skia/issues/entry?template=Autoroller+Bug
Documentation for the AutoRoller is here:
https://skia.googlesource.com/buildbot/+doc/main/autoroll/README.md
bisor0627 pushed a commit to bisor0627/packages that referenced this pull request Jun 19, 2026
@engine-flutter-autoroll
Roll Flutter from6c95737to1fe2495(24 revisions) (flutter#4817)
afecad4
flutter/flutter@6c95737...1fe2495
2023-08-30 leroux_bruno@yahoo.fr Update SelectableRegion test for M3 (flutter/flutter#129627)
2023-08-30 godofredoc@google.com Remove cirrus tests from the flutter framework. (flutter/flutter#133575)
2023-08-30 engine-flutter-autoroll@skia.org Roll Flutter Engine from 749e67a947bc to 69f04bdfe952 (2 revisions) (flutter/flutter#133621)
2023-08-30 xilaizhang@google.com [flutter roll] Revert "Fix `Chip.shape`'s side is not used when provided in Material 3" (flutter/flutter#133615)
2023-08-30 engine-flutter-autoroll@skia.org Roll Flutter Engine from 9f2cf5c99b0f to 749e67a947bc (2 revisions) (flutter/flutter#133618)
2023-08-30 engine-flutter-autoroll@skia.org Roll Flutter Engine from c5854a6b3658 to 9f2cf5c99b0f (4 revisions) (flutter/flutter#133616)
2023-08-30 parlough@gmail.com No longer include `.packages` in created `.gitignore` files (flutter/flutter#133484)
2023-08-30 engine-flutter-autoroll@skia.org Roll Flutter Engine from db3ecf8b2739 to c5854a6b3658 (1 revision) (flutter/flutter#133610)
2023-08-29 engine-flutter-autoroll@skia.org Roll Flutter Engine from 1feb9302050c to db3ecf8b2739 (4 revisions) (flutter/flutter#133609)
2023-08-29 polinach@google.com Fix one notDisposed leak and mark another. (flutter/flutter#133595)
2023-08-29 engine-flutter-autoroll@skia.org Roll Flutter Engine from 01a1579808b5 to 1feb9302050c (1 revision) (flutter/flutter#133604)
2023-08-29 polinach@google.com Upgrade packages. (flutter/flutter#133593)
2023-08-29 polinach@google.com Cover more tests with leak tracking. (flutter/flutter#133596)
2023-08-29 engine-flutter-autoroll@skia.org Roll Flutter Engine from 73cc3fb451fd to 01a1579808b5 (3 revisions) (flutter/flutter#133591)
2023-08-29 hans.muller@gmail.com Added DropdownMenuEntry.labelWidget (flutter/flutter#133491)
2023-08-29 ian@hixie.ch Use a fake stopwatch to remove flakiness. (flutter/flutter#133229)
2023-08-29 engine-flutter-autoroll@skia.org Roll Flutter Engine from d1e6eb080f08 to 73cc3fb451fd (3 revisions) (flutter/flutter#133580)
2023-08-29 mdebbar@google.com [web] Migrate remaining web-only API usages to `dart:ui_web` (flutter/flutter#132248)
2023-08-29 gspencergoog@users.noreply.github.com Add doxygen doc generation. (flutter/flutter#131356)
2023-08-29 engine-flutter-autoroll@skia.org Roll Flutter Engine from 50bd80773287 to d1e6eb080f08 (2 revisions) (flutter/flutter#133570)
2023-08-29 polinach@google.com ShortcutManager should dispatch creation in constructor. (flutter/flutter#133487)
2023-08-29 tessertaha@gmail.com Add FAB Additional Color Mappings example (flutter/flutter#133453)
2023-08-29 engine-flutter-autoroll@skia.org Roll Flutter Engine from 65438c7bb46a to 50bd80773287 (1 revision) (flutter/flutter#133565)
2023-08-29 engine-flutter-autoroll@skia.org Roll Packages from abdcaab to e39dd4b (13 revisions) (flutter/flutter#133564)
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 rmistry@google.com,stuartmorgan@google.com 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://bugs.chromium.org/p/skia/issues/entry?template=Autoroller+Bug
Documentation for the AutoRoller is here:
https://skia.googlesource.com/buildbot/+doc/main/autoroll/README.md
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

1 more reviewer
@christopherfujinochristopherfujinochristopherfujino approved these changes
Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

d: api docsIssues with https://api.flutter.dev/frameworkflutter/packages/flutter repository. See also f: labels.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@gspencergoog@justinmc@christopherfujino@goderbauer