apache
GH-46818: [Docs][C++] Add missing method description in type.h
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_size
What changes are included in this PR?
Add missing method description in the type.h file
Are these changes tested?
Yes.
Are there any user-facing changes?
No.
- GitHub Issue: #46818
:warning: GitHub issue #46818 has been automatically assigned in GitHub to PR creator.
![github-actions[bot] avatar](https://avatars.githubusercontent.com/in/15368?v=4 "Published by a pub.dev verified publisher"){kind=small}
Revision: f0e9bf8b5ca56a38e2befebbaab1a795bd729ba3
Submitted crossbow builds: ursacomputing/crossbow @ actions-94ac5ab264
| Task | Status |
|---|---|
| preview-docs |  |
I wrote method description as a draft. Please feel free comments(modify) if you feel this PR useful.
http://crossbow.voltrondata.com/pr_docs/46819/cpp/api/datatype.html#classarrow_1_1_fixed_size_list_type
@raulcd @pitrou Could you review for this? Or could you request review someone who proper maintainer. (They both had reviewed #46540 before, so I consulted with them.)
@pitrou Thanks. I'll try to write useful description. Please review later agin.
Revision: 6604ac8ea0254667ef68480c456c15e2859436fb
Submitted crossbow builds: ursacomputing/crossbow @ actions-8a892a3aeb
| Task | Status |
|---|---|
| preview-docs |  |
I added MapType documentation.
http://crossbow.voltrondata.com/pr_docs/46819/cpp/api/datatype.html#classarrow_1_1_map_type
I will continue working.
It will take a time because I don't know much the API usage. (That's why I needed the document 😄 )