Skip to content

Add doxygen doc generation. #131356

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 2 commits into from
Aug 29, 2023
Merged

Add doxygen doc generation. #131356

merged 2 commits into from
Aug 29, 2023

Conversation

gspencergoog
Copy link
Contributor

@gspencergoog gspencergoog commented Jul 26, 2023 •
edited
Loading

Description

This integrates the doxygen docs generated by the engine in PR flutter/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

@goderbauer goderbauer added the framework flutter/packages/flutter repository. See also f: labels. label Aug 8, 2023
@github-actions github-actions bot 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 repository. See also e: labels. a: animation Animation APIs f: material design flutter/packages/flutter/material repository. 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. f: cupertino flutter/packages/flutter/cupertino repository 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 gspencergoog force-pushed the add_doxygen_docs branch 2 times, most recently from 7b91b7e to 4da5146 Compare August 15, 2023 23:56
@justinmc
Copy link
Contributor

Cool idea!

@gspencergoog
Copy link
Contributor Author

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

@gspencergoog gspencergoog 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 repository. See also e: labels. a: animation Animation APIs labels Aug 17, 2023
@gspencergoog gspencergoog removed the c: tech-debt Technical debt, code quality, testing, etc. label Aug 17, 2023
@gspencergoog gspencergoog mentioned this pull request Aug 18, 2023
Closed
@gspencergoog gspencergoog force-pushed the add_doxygen_docs branch 2 times, most recently from 992de4a to 375631e Compare August 18, 2023 23:12
@gspencergoog gspencergoog marked this pull request as ready for review August 18, 2023 23:13
@gspencergoog gspencergoog requested a review from zanderso August 18, 2023 23:13
@gspencergoog gspencergoog mentioned this pull request Aug 24, 2023
Closed
8 tasks
@flutter flutter deleted a comment from flutter-dashboard bot Aug 25, 2023
@gspencergoog gspencergoog force-pushed the add_doxygen_docs branch 4 times, most recently from f9823ca to 4129082 Compare August 29, 2023 16:29
@gspencergoog gspencergoog requested review from christopherfujino and removed request for zanderso August 29, 2023 17:12
christopherfujino
christopherfujino reviewed Aug 29, 2023
View reviewed changes
christopherfujino
christopherfujino reviewed Aug 29, 2023
View reviewed changes
christopherfujino
christopherfujino approved these changes Aug 29, 2023
View reviewed changes
Copy link
Contributor

@christopherfujino christopherfujino left a comment

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:master Aug 29, 2023
@engine-flutter-autoroll engine-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
ff829fd Add doxygen doc generation. (flutter/flutter#131356)
48fe5f3
auto-submit bot pushed a commit to flutter/packages that referenced this pull request Aug 30, 2023
@engine-flutter-autoroll
Roll Flutter from 6c95737 to 1fe2495 (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
@HansMuller HansMuller 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
ff829fd Add doxygen doc generation. (flutter/flutter#131356)
2ffc9c7
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@christopherfujino christopherfujino christopherfujino approved these changes

Assignees
No one assigned
Labels
d: api docs Issues with https://api.flutter.dev/ framework flutter/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