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

[various] Standardize Obj-C doc comment style #6232

Merged

Conversation

stuartmorgan
Copy link
Contributor

Standardizes Objective-C code on /// for documentation comments, instead of a mix of that and /** ... */.

This does not add enforcement, since my expectation is that if we start from a homogeneous style we will be much less likely to diverge again (and if some do creep in, it's harmless).

This only changes comments, so is a no-op for package clients.

Fixes flutter/flutter#143868

Standardizes on `///` for documentation comments, instead of a mix of
that and `/** ... */`.

Fixes flutter/flutter#143868
@stuartmorgan stuartmorgan added the autosubmit Merge PR when tree becomes green via auto submit App label Feb 29, 2024
@auto-submit auto-submit bot merged commit 268f7d5 into flutter:main Feb 29, 2024
78 checks passed
engine-flutter-autoroll added a commit to engine-flutter-autoroll/flutter that referenced this pull request Mar 1, 2024
auto-submit bot pushed a commit to flutter/flutter that referenced this pull request Mar 1, 2024
flutter/packages@6d02f03...a9c68b8

2024-03-01 49699333+dependabot[bot]@users.noreply.github.com Bump github/codeql-action from 3.24.5 to 3.24.6 (flutter/packages#6234)
2024-02-29 [email protected] [various] Standardize Obj-C doc comment style (flutter/packages#6232)
2024-02-29 [email protected] [google_maps_flutter] Add support for marker clustering - platform interface (flutter/packages#6158)
2024-02-29 [email protected] Roll Flutter (stable) from abb292a to 7482962 (1 revision) (flutter/packages#6230)
2024-02-29 [email protected] Roll Flutter from d00bfe8 to e92bca3 (15 revisions) (flutter/packages#6227)

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-flutter-autoroll
Please CC [email protected],[email protected] 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://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
LouiseHsu pushed a commit to LouiseHsu/packages that referenced this pull request Mar 7, 2024
Standardizes Objective-C code on `///` for documentation comments, instead of a mix of that and `/** ... */`.

This does not add enforcement, since my expectation is that if we start from a homogeneous style we will be much less likely to diverge again (and if some do creep in, it's harmless).

This only changes comments, so is a no-op for package clients.

Fixes flutter/flutter#143868
arc-yong pushed a commit to Arctuition/packages-arc that referenced this pull request Jun 14, 2024
Standardizes Objective-C code on `///` for documentation comments, instead of a mix of that and `/** ... */`.

This does not add enforcement, since my expectation is that if we start from a homogeneous style we will be much less likely to diverge again (and if some do creep in, it's harmless).

This only changes comments, so is a no-op for package clients.

Fixes flutter/flutter#143868
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[packages] Pick an Obj-C comment style
2 participants