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

[camera] Add missing Dartdocs#3229

Merged
amirh merged 5 commits intoflutter:masterfrom
amirh:camera_lint
Oct 30, 2020
Merged

[camera] Add missing Dartdocs#3229
amirh merged 5 commits intoflutter:masterfrom
amirh:camera_lint

Conversation

@amirh
Copy link
Contributor

@amirh amirh commented Oct 29, 2020 •
edited
Loading

Added missing Dartdocs for the camera plugin in order to remove the custom analysis options file (which excludes the lint rule requiring documentation for all public APIs).

@bparrishMines - I couldn't figure out the public APIs in camera_channel.dart and camera_mixins.dart can you help me how to document these? here are currently the remaining lint warnings:

  info • Document all public members at lib/new/src/common/camera_channel.dart:7:1 • (public_member_api_docs)
  info • Document all public members at lib/new/src/common/camera_channel.dart:10:7 • (public_member_api_docs)
  info • Document all public members at lib/new/src/common/camera_channel.dart:11:34 • (public_member_api_docs)
  info • Document all public members at lib/new/src/common/camera_channel.dart:13:30 • (public_member_api_docs)
  info • Document all public members at lib/new/src/common/camera_channel.dart:24:14 • (public_member_api_docs)
  info • Document all public members at lib/new/src/common/camera_channel.dart:26:15 • (public_member_api_docs)
  info • Document all public members at lib/new/src/common/camera_channel.dart:34:15 • (public_member_api_docs)
  info • Document all public members at lib/new/src/common/camera_mixins.dart:7:1 • (public_member_api_docs)
  info • Document all public members at lib/new/src/common/camera_mixins.dart:14:1 • (public_member_api_docs)

This is done to enable flutter/flutter#69309

@amirh amirh requested a review from bparrishMines October 29, 2020 13:54
@google-cla google-cla bot added the cla: yes label Oct 29, 2020
@amirh amirh mentioned this pull request Oct 29, 2020
Closed
9 tasks
bparrishMines
bparrishMines approved these changes Oct 29, 2020
View reviewed changes
Copy link
Contributor

@bparrishMines bparrishMines left a comment •
edited
Loading

Choose a reason for hiding this comment

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

LGTM

Everything in the lib/new folder can be removed now. It doesn't do anything yet and I don't have any plans on continuing the work inside it.

@amirh
Copy link
Contributor Author

amirh commented Oct 29, 2020

LGTM

Everything in the lib/new folder can be removed now. It doesn't do anything yet and I don't have any plans on continuing the work inside it.

Deleting it is technically a breaking change, are you confident no one is using anything from there?

@bparrishMines
Copy link
Contributor

bparrishMines commented Oct 30, 2020

LGTM
Everything in the lib/new folder can be removed now. It doesn't do anything yet and I don't have any plans on continuing the work inside it.

Deleting it is technically a breaking change, are you confident no one is using anything from there?

There's nothing in Java or Objective-C that would respond to the MethodCalls. I'm not sure what someone could use it for if most methods lead to a MissingPluginException.

@bparrishMines bparrishMines mentioned this pull request Oct 30, 2020
Merged
13 tasks
@amirh amirh merged commit 8413efe into flutter:master Oct 30, 2020
@amirh amirh deleted the camera_lint branch October 30, 2020 19:16
FlutterSu pushed a commit to FlutterSu/flutter-plugins that referenced this pull request Nov 20, 2020
@amirh
[camera] Add missing Dartdocs (flutter#3229)
5ae0c53 
Added missing Dartdocs for the camera plugin in order to remove the custom analysis options file (which excludes the lint rule requiring documentation for all public APIs).
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Reviewers

1 more reviewer

@bparrishMines bparrishMines bparrishMines approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

cla: yes

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@amirh @bparrishMines