Skip to content

[Docs][C++] The DataTypesAPI documentation is missing documentation for some classes and methods #46808

Closed as not planned
1 of 1 issue completed

Description

@hiroyuki-sato

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.
#46774 (comment)
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
  • BaseListType
  • BinaryType
  • BinaryViewType
  • BooleanType
  • DataType
  • Date32Type
  • Date64Type
  • DateType
  • DayTimeIntervalType
  • DecimalType
  • Decimal32Type
  • Decimal64Type
  • Decimal128Type
  • Decimal256Type
  • DenseUnionType
  • DictionaryType
  • DoubleType
  • DurationType
  • Field
  • FieldPath
  • FieldRef
  • Fingerprintable (No DataType class)
  • FixedSizeBinaryType
  • FixedSizeListType
  • FixedWidthType
  • FloatingPointType
  • FloatType
  • HalfFloatType
  • Int8Type
  • Int16Type
  • Int32Type
  • Int64Type
  • IntegerType
  • IntervalType
  • LargeBinaryType
  • LargeListType
  • LargeListViewType
  • LargeStringType
  • ListType
  • ListViewType
  • MapType
  • MonthDayNanoIntervalType
  • MonthIntervalType
  • NestedType
  • NullType
  • NumberType
  • PrimitiveCType
  • RunEndEncodedType
  • SparseUnionType
  • StringType
  • StringViewType
  • StructType
  • TemporalType
  • Time32Type
  • Time64Type
  • TimestampType
  • TimeType
  • UInt8Type
  • UInt16Type
  • UInt32Type
  • UInt64Type
  • UnionType

Component(s)

Documentation

Activity

  1. github-actions commented on Jun 24, 2026

    @github-actions

    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.

  2. added
    Status: stale-warningIssues and PRs flagged as stale which are due to be closed if no indication otherwise
    on Jun 24, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions