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

Hide internal functions from Dart docs, add documentation to top-level types #681

Merged
merged 13 commits into from
Aug 8, 2022

Conversation

osa1
Copy link
Member

@osa1 osa1 commented Jun 16, 2022

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.

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.
@osa1 osa1 requested a review from sigurdm June 16, 2022 14:15
@@ -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;
Copy link
Collaborator

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.

Copy link
Member Author

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.

Copy link
Collaborator

Choose a reason for hiding this comment

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

That's fine!

@osa1 osa1 changed the title Hide internal functions from Dart docs Hide internal functions from Dart docs, add documentation to top-level types Aug 2, 2022
@osa1 osa1 marked this pull request as ready for review August 2, 2022 11:52
@osa1 osa1 requested a review from sigurdm August 2, 2022 11:52
Copy link
Collaborator

@sigurdm sigurdm left a comment

Choose a reason for hiding this comment

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

LGTM

@osa1 osa1 merged commit 6f5360b into google:master Aug 8, 2022
@osa1 osa1 deleted the internals_in_docs branch August 8, 2022 13:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants