Skip to content
This repository was archived by the owner on Feb 25, 2025. It is now read-only.

Add Doxygen doc generation for iOS, macOS, Linux, Windows, and Impeller #43915

Merged
merged 2 commits into from
Aug 17, 2023
Merged

Add Doxygen doc generation for iOS, macOS, Linux, Windows, and Impeller #43915

merged 2 commits into from
Aug 17, 2023

Conversation

gspencergoog
Copy link
Contributor

@gspencergoog gspencergoog commented Jul 22, 2023 •
edited
Loading

Description

This starts generating Doxygen docs for iOS, macOS, Linux, Windows, and Impeller. It doesn't remove the existing generation for iOS for now, until we can migrate the API docs to include these instead of those.

Related Issues

@gspencergoog gspencergoog force-pushed the add_macos_objcdoc branch 6 times, most recently from cbe4c15 to 7f17ccc Compare July 26, 2023 16:52
@gspencergoog gspencergoog changed the title Add ability to generate Objective C docs for macOS Add Doxygen doc generation for iOS, macOS, Linux, Windows, and Impeller Jul 26, 2023
@gspencergoog gspencergoog force-pushed the add_macos_objcdoc branch 2 times, most recently from be7e9ad to b57e9b4 Compare July 26, 2023 18:13
@gspencergoog gspencergoog mentioned this pull request Jul 26, 2023
Merged
chinmaygarde
chinmaygarde reviewed Jul 27, 2023
View reviewed changes
tools/gen_docs.sh Outdated
@@ -0,0 +1,133 @@
#!/usr/bin/env bash
Copy link
Member

Choose a reason for hiding this comment

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

If its all the same, can we use a python script instead?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Sure. I mean, I would do a Dart script, but I wasn't sure about whether dart was always available in the CI here.

Copy link
Member

Choose a reason for hiding this comment

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

Don't know about Dart. I meant Python.

Copy link
Member

Choose a reason for hiding this comment

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

Your call though. The bash stuff isn't all that portable should we want to run this or parts thereof on Windows.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Swapped it out for a python script.

docs/Doxyfile.template
@@ -0,0 +1,2708 @@
# Doxyfile 1.9.4

# This file is a template for the Doxyfile used to generate Flutter
Copy link
Member

Choose a reason for hiding this comment

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

Is this based on the doxyfile at https://github.com/flutter/engine/blob/main/Doxyfile or does it start from scratch. Notably, that file is already setup for docset generation which comes in handy.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I based it on that Doxyfile. Some things are changed (notably, I turned on the directory sharding so that there aren't thousands of files in one dir).

I was wondering what that Doxyfile was actually used for, though, since it doesn't appear to be published anywhere.

chinmaygarde
chinmaygarde approved these changes Jul 28, 2023
View reviewed changes
tools/gen_docs.sh Outdated
@@ -0,0 +1,133 @@
#!/usr/bin/env bash
Copy link
Member

Choose a reason for hiding this comment

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

Your call though. The bash stuff isn't all that portable should we want to run this or parts thereof on Windows.

@gspencergoog gspencergoog force-pushed the add_macos_objcdoc branch 5 times, most recently from f1c9d6d to 9e0e661 Compare August 4, 2023 20:20
@chinmaygarde
Copy link
Member

May I land this please?

@gspencergoog
Copy link
Contributor Author

Not yet. I need to make sure it works with the new doxygen that is being pushed to the LUCI bots. I can convert to draft until then, though if you want.

@gspencergoog gspencergoog marked this pull request as draft August 10, 2023 21:05
@gspencergoog gspencergoog force-pushed the add_macos_objcdoc branch 2 times, most recently from 06b0f89 to 89a488e Compare August 15, 2023 23:16
@gspencergoog gspencergoog marked this pull request as ready for review August 15, 2023 23:22
@gspencergoog gspencergoog added affects: docs waiting for tree to go green This PR is approved and tested, but waiting for the tree to be green to land. autosubmit Merge PR when tree becomes green via auto submit App and removed waiting for tree to go green This PR is approved and tested, but waiting for the tree to be green to land. labels Aug 15, 2023
@auto-submit
Copy link
Contributor

auto-submit bot commented Aug 16, 2023

auto label is removed for flutter/engine/43915, due to - The status or check suite Linux linux_clang_tidy has failed. Please fix the issues identified (or deflake) before re-applying this label.

@auto-submit auto-submit bot removed the autosubmit Merge PR when tree becomes green via auto submit App label Aug 16, 2023
@chinmaygarde
Copy link
Member

Triage: The clang-tidy check should only run on updated portions of TUs. But that was added recently. Rebasing to pull in that change and hopefully make the check skip.

@chinmaygarde chinmaygarde added the autosubmit Merge PR when tree becomes green via auto submit App label Aug 17, 2023
@auto-submit auto-submit bot merged commit ffa1904 into flutter:main Aug 17, 2023
@engine-flutter-autoroll engine-flutter-autoroll mentioned this pull request Aug 17, 2023
Closed
engine-flutter-autoroll added a commit to engine-flutter-autoroll/flutter that referenced this pull request Aug 17, 2023
@engine-flutter-autoroll
ffa19048b Add Doxygen doc generation for iOS, macOS, Linux, Windows, …
49a5174 
…and Impeller (flutter/engine#43915)
@engine-flutter-autoroll engine-flutter-autoroll mentioned this pull request Aug 18, 2023
Merged
engine-flutter-autoroll added a commit to engine-flutter-autoroll/flutter that referenced this pull request Aug 18, 2023
@engine-flutter-autoroll
ffa19048b Add Doxygen doc generation for iOS, macOS, Linux, Windows, …
bf8537f 
…and Impeller (flutter/engine#43915)
auto-submit bot pushed a commit to flutter/flutter that referenced this pull request Aug 18, 2023
@engine-flutter-autoroll
Roll Flutter Engine from 5019d6da655c to 866b43f656e4 (8 revisions) (#…
a1e3b3d 
…132812)

flutter/engine@5019d6d...866b43f

2023-08-17 skia-flutter-autoroll@skia.org Roll Skia from 1bec2899ace8 to 1e62a2d4c429 (1 revision) (flutter/engine#44829)
2023-08-17 skia-flutter-autoroll@skia.org Roll Dart SDK from 7e4e5796ee99 to 7101eb7569ac (2 revisions) (flutter/engine#44828)
2023-08-17 skia-flutter-autoroll@skia.org Roll Skia from e4be2cab442f to 1bec2899ace8 (1 revision) (flutter/engine#44826)
2023-08-17 skia-flutter-autoroll@skia.org Roll Skia from bfd45173e5e3 to e4be2cab442f (3 revisions) (flutter/engine#44824)
2023-08-17 gspencergoog@users.noreply.github.com Add Doxygen doc generation for iOS, macOS, Linux, Windows, and Impeller (flutter/engine#43915)
2023-08-17 skia-flutter-autoroll@skia.org Roll Fuchsia Mac SDK from VW7WAVPT3Cj5erlae... to Tnp43n_nAR2N0l_gY... (flutter/engine#44823)
2023-08-17 jason-simmons@users.noreply.github.com Fix FlutterInjectorTest assumptions about how the executor service assigns tasks to threads (flutter/engine#44775)
2023-08-17 john@johnmccutchan.com Reenable HardwareBuffer backed Android Platform Views on SDK >= 29 (flutter/engine#44790)

Also rolling transitive DEPS:
  fuchsia/sdk/core/mac-amd64 from VW7WAVPT3Cj5 to Tnp43n_nAR2N

If this roll has caused a breakage, revert this CL and stop the roller
using the controls here:
https://autoroll.skia.org/r/flutter-engine-flutter-autoroll
Please CC jsimmons@google.com,rmistry@google.com,zra@google.com on the revert to ensure that a human
is aware of the problem.

To file a bug in Flutter: 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
gaaclarke pushed a commit to gaaclarke/engine that referenced this pull request Aug 30, 2023
@gspencergoog @gaaclarke
Add Doxygen doc generation for iOS, macOS, Linux, Windows, and Impell…
e17f81f 
…er (flutter#43915)

## Description

This starts generating Doxygen docs for iOS, macOS, Linux, Windows, and Impeller. It doesn't remove the existing generation for iOS for now, until we can migrate the API docs to include these instead of those.

## Related Issues
 - flutter/flutter#130999
 - Fixes flutter/flutter#124833
@jmagman jmagman mentioned this pull request Jan 2, 2024
Closed
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@chinmaygarde chinmaygarde chinmaygarde approved these changes

Assignees
No one assigned
Labels
affects: docs autosubmit Merge PR when tree becomes green via auto submit App
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

jazzy cannot run on mac_ios_engine Mac arm bot
2 participants
@gspencergoog @chinmaygarde