Hide internal functions from Dart docs, add documentation to top-level types #681
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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.
sigurdm
reviewed
Jun 16, 2022
| @@ -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.
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.
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.
osa1
changed the title
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.