[I] [Docs][C++] The DataTypesAPI documentation is missing documentation for some classes and methods [arrow]

["hiroyuki-sato (via GitHub)" <gi...@apache.org>]

hiroyuki-sato opened a new issue, #46808:
URL: https://github.com/apache/arrow/issues/46808

   ### Describe the enhancement requested
   
   https://arrow.apache.org/docs/cpp/api/datatype.html
   
   IIUC, Unchecked classes do not have API Docs.
   
   I wanted know how to get list_size in `FixedSizeListType` class and traversed to parent class. 
   Finally, I couldn't find it. Additionally, I found some class don't have API documentation.
   @kou told me the method defined in the `FixedSizeListType` class.
   https://github.com/apache/arrow/pull/46774#discussion_r2143996915
   The method doesn't have API documentation.
   
   I think it's useful to add comments to methods that don't have API documentation.
   
   Should these classes be listed in the API Doc?
   
   I picked up these classes from `type.h`
   
   - [ ] BaseBinaryType
   - [x] BaseListType
   - [x] BinaryType
   - [x] BinaryViewType
   - [x] BooleanType
   - [x] DataType
   - [x] Date32Type
   - [x] Date64Type
   - [x] DateType
   - [x] DayTimeIntervalType
   - [x] DecimalType
   - [x] Decimal32Type
   - [x] Decimal64Type
   - [x] Decimal128Type
   - [x] Decimal256Type
   - [x] DenseUnionType
   - [x] DictionaryType
   - [x] DoubleType
   - [x] DurationType
   - [x] Field
   - [x] FieldPath
   - [x] FieldRef
   - [ ] Fingerprintable (No DataType class)
   - [x] FixedSizeBinaryType
   - [x] FixedSizeListType
   - [ ] FixedWidthType
   - [ ] FloatingPointType
   - [x] FloatType
   - [x] HalfFloatType
   - [x] Int8Type
   - [x] Int16Type
   - [x] Int32Type
   - [x] Int64Type
   - [ ] IntegerType
   - [x] IntervalType
   - [x] LargeBinaryType
   - [x] LargeListType
   - [x] LargeListViewType
   - [x] LargeStringType
   - [x] ListType
   - [x] ListViewType
   - [x] MapType
   - [x] MonthDayNanoIntervalType
   - [x] MonthIntervalType
   - [ ] NestedType
   - [x] NullType
   - [ ] NumberType
   - [ ] PrimitiveCType
   - [x] RunEndEncodedType
   - [x] SparseUnionType
   - [x] StringType
   - [x] StringViewType
   - [x] StructType
   - [x] TemporalType
   - [x] Time32Type
   - [x] Time64Type
   - [x] TimestampType
   - [x] TimeType
   - [x] UInt8Type
   - [x] UInt16Type
   - [x] UInt32Type
   - [x] UInt64Type
   - [x] UnionType
   
   
   ### Component(s)
   
   Documentation


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: issues-unsubscribe@arrow.apache.org.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

Re: [I] [Docs][C++] The DataTypesAPI documentation is missing documentation for some classes and methods [arrow]

["github-actions[bot] (via GitHub)" <gi...@apache.org>]

github-actions[bot] closed issue #46808: [Docs][C++] The DataTypesAPI documentation is missing documentation for some classes and methods
URL: https://github.com/apache/arrow/issues/46808


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: issues-unsubscribe@arrow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

Re: [I] [Docs][C++] The DataTypesAPI documentation is missing documentation for some classes and methods [arrow]

["github-actions[bot] (via GitHub)" <gi...@apache.org>]

github-actions[bot] commented on issue #46808:
URL: https://github.com/apache/arrow/issues/46808#issuecomment-4789082869

   This issue has been marked as stale because it has had no activity in the past 365 days. Please remove the stale label or comment below, or this issue will be closed in 14 days. If this improvement is still desired but has no current owner, please add the 'Status: needs champion' label.


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org