-
Notifications
You must be signed in to change notification settings - Fork 184
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
Hide internal functions from Dart docs, add documentation to top-level types #681
Conversation
Not complete -- draft This hides items that are supposed to be used by the plugin-generated code and mixin classes in documentation. Some items that are internal are made internal.
@@ -310,6 +310,8 @@ abstract class GeneratedMessage { | |||
/// The tagNumber should be a valid tag or extension. | |||
void clearField(int tagNumber) => _fieldSet._clearField(tagNumber); | |||
|
|||
/// For generated code only. | |||
/// @nodoc | |||
int $_whichOneof(int oneofIndex) => _fieldSet._oneofCases![oneofIndex] ?? 0; |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Consider also marking these as @Protected. They will give a warning if used in the wrong context, and if dart-lang/sdk#49273 was fixed they would also be removed from tab-completion.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I need to make a pass to find out which ones need @Protected
, I'd like to do that in a separate PR if that's OK.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
That's fine!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
This hides items that are supposed to be used by the plugin-generated code and
mixin classes.
Items that can be made private are made private.
One sentence documentation added to top-level types that didn't have documentation.
This PR is best reviewed by looking at the documentation generated by
dart doc
.