search

flutter / flutter

Flutter makes it easy and fast to build beautiful apps for mobile and beyond
https://flutter.dev
BSD 3-Clause "New" or "Revised" License
166.31k stars 27.52k forks source link

☂️ Document `dart:ui` where `public_member_api_docs` was not firing #151917

Open matanlurey opened 4 months ago

matanlurey commented 4 months ago

In https://github.com/flutter/engine/pull/53539, I discovered that, perhaps due to a lack of a root pubspec, some Dart files were not being (fully?) linted:

Dart SDK version: 3.6.0-51.0.dev (dev) (Wed Jul 17 05:07:11 2024 -0700) on "linux_x64"

Analyzing ci...
No issues found!
Analyzing flutter_frontend_server...
No issues found!
Analyzing dart...
No issues found!
Analyzing gpu...
No issues found!
Analyzing ui...

   info - channel_buffers.dart:403:8 - Missing documentation for a public member. Try adding documentation for the member. - public_member_api_docs
   info - channel_buffers.dart:403:8 - Missing documentation for a public member. Try adding documentation for the member. - public_member_api_docs
   info - compositing.dart:249:11 - Missing documentation for a public member. Try adding documentation for the member. - public_member_api_docs
   info - compositing.dart:249:11 - Missing documentation for a public member. Try adding documentation for the member. - public_member_api_docs
   info - experiments/scene.dart:53:25 - Missing documentation for a public member. Try adding documentation for the member. - public_member_api_docs
   info - experiments/scene.dart:59:8 - Missing documentation for a public member. Try adding documentation for the member. - public_member_api_docs
   info - experiments/scene.dart:63:8 - Missing documentation for a public member. Try adding documentation for the member. - public_member_api_docs
   info - experiments/scene.dart:67:8 - Missing documentation for a public member. Try adding documentation for the member. - public_member_api_docs
   info - experiments/scene.dart:71:8 - Missing documentation for a public member. Try adding documentation for the member. - public_member_api_docs
   info - experiments/scene.dart:131:7 - Missing documentation for a public member. Try adding documentation for the member. - public_member_api_docs
   info - experiments/scene.dart:136:25 - Missing documentation for a public member. Try adding documentation for the member. - public_member_api_docs
   info - experiments/scene.dart:140:25 - Missing documentation for a public member. Try adding documentation for the member. - public_member_api_docs
   info - experiments/scene.dart:147:12 - Missing documentation for a public member. Try adding documentation for the member. - public_member_api_docs
   info - experiments/scene.dart:151:26 - Missing documentation for a public member. Try adding documentation for the member. - public_member_api_docs
   info - experiments/scene.dart:155:18 - Missing documentation for a public member. Try adding documentation for the member. - public_member_api_docs
   info - experiments/scene.dart:189:8 - Missing documentation for a public member. Try adding documentation for the member. - public_member_api_docs
   info - key.dart:19:14 - Missing documentation for a public member. Try adding documentation for the member. - public_member_api_docs
   info - key.dart:19:14 - Missing documentation for a public member. Try adding documentation for the member. - public_member_api_docs
   info - key.dart:49:14 - Missing documentation for a public member. Try adding documentation for the member. - public_member_api_docs
   info - key.dart:49:14 - Missing documentation for a public member. Try adding documentation for the member. - public_member_api_docs
   info - painting.dart:2601:11 - Missing documentation for a public member. Try adding documentation for the member. - public_member_api_docs
   info - painting.dart:2601:11 - Missing documentation for a public member. Try adding documentation for the member. - public_member_api_docs
   info - platform_dispatcher.dart:2198:9 - Missing documentation for a public member. Try adding documentation for the member. - public_member_api_docs
   info - platform_dispatcher.dart:2198:9 - Missing documentation for a public member. Try adding documentation for the member. - public_member_api_docs
   info - semantics.dart:287:36 - Missing documentation for a public member. Try adding documentation for the member. - public_member_api_docs
   info - semantics.dart:287:36 - Missing documentation for a public member. Try adding documentation for the member. - public_member_api_docs
   info - semantics.dart:289:27 - Missing documentation for a public member. Try adding documentation for the member. - public_member_api_docs
   info - semantics.dart:289:27 - Missing documentation for a public member. Try adding documentation for the member. - public_member_api_docs
   info - semantics.dart:641:34 - Missing documentation for a public member. Try adding documentation for the member. - public_member_api_docs
   info - semantics.dart:641:34 - Missing documentation for a public member. Try adding documentation for the member. - public_member_api_docs
   info - semantics.dart:643:25 - Missing documentation for a public member. Try adding documentation for the member. - public_member_api_docs
   info - semantics.dart:643:25 - Missing documentation for a public member. Try adding documentation for the member. - public_member_api_docs

These obviously can't be fixed automatically, and it would be good to stem the bleeding, so I'll add // ignore: ...'s and link here.

zanderso commented 4 months ago

Maybe related: https://github.com/flutter/flutter/issues/144713