GH-46818: [Docs][C++] Add missing method description in type.h #46819
+24
−3
Conversation
This file contains hidden or 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
|
|
|
@github-actions crossbow submit preview-docs |
|
Revision: f0e9bf8 Submitted crossbow builds: ursacomputing/crossbow @ actions-94ac5ab264
|
|
I wrote method description as a draft. Please feel free comments(modify) if you feel this PR useful.
|
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.
Rationale for this change
This is the sub issue #46808
Since EXTRACT_ALL is set YES in Doxygen, I expect that methods without comments will also be included in the API Doc, but some methods are not documented.
For example
FixedSizeListType::list_sizeWhat changes are included in this PR?
Add missing method description in the
type.hfileAre these changes tested?
Yes.
Are there any user-facing changes?
No.
type.h#46818