Skip to content

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

Merged
auto-submit[bot] merged 2 commits into
flutter:mainfrom
stuartmorgan-g:objc-doc-comment-standardization
Feb 29, 2024
Merged

[various] Standardize Obj-C doc comment style#6232
auto-submit[bot] merged 2 commits into
flutter:mainfrom
stuartmorgan-g:objc-doc-comment-standardization

Conversation

@stuartmorgan-g

Copy link
Copy Markdown
Collaborator

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.

Fixesflutter/flutter#143868

Standardizes on `///` for documentation comments, instead of a mix of
that and `/** ... */`.
Fixesflutter/flutter#143868
@stuartmorgan-gstuartmorgan-g added the autosubmit Merge PR when tree becomes green via auto submit App label Feb 29, 2024
@auto-submit
auto-submitBot merged commit 268f7d5 into flutter:mainFeb 29, 2024
engine-flutter-autoroll added a commit to engine-flutter-autoroll/flutter that referenced this pull request Mar 1, 2024
auto-submitBot 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 stuartmorgan@google.com [various] Standardize Obj-C doc comment style (flutter/packages#6232)
2024-02-29 joonas.kerttula@codemate.com [google_maps_flutter] Add support for marker clustering - platform interface (flutter/packages#6158)
2024-02-29 engine-flutter-autoroll@skia.org Roll Flutter (stable) from abb292a to 7482962 (1 revision) (flutter/packages#6230)
2024-02-29 engine-flutter-autoroll@skia.org 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 flutter-ecosystem@google.com,rmistry@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://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.
Fixesflutter/flutter#143868
creatorpiyush pushed a commit to creatorpiyush/packages that referenced this pull request Jun 10, 2026
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.
Fixesflutter/flutter#143868
bisor0627 pushed a commit to bisor0627/packages that referenced this pull request Jun 19, 2026
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.
Fixesflutter/flutter#143868
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

autosubmitMerge PR when tree becomes green via auto submit Appoverride: no changelog neededOverride the check requiring CHANGELOG updates for most changesoverride: no versioning neededOverride the check requiring version bumps for most changesp: camerap: file_selectorp: google_maps_flutterp: google_sign_inp: image_pickerp: local_authp: pigeonp: video_playerp: webview_flutterplatform-iosplatform-macos

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[packages] Pick an Obj-C comment style

2 participants

@stuartmorgan-g@jmagman