[Docs][C++] Add missing method description in `type.h`

[hiroyuki-sato]

Describe the enhancement requested

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.

arrow/cpp/apidoc/Doxyfile

Line 554 in 196cde3

EXTRACT_ALL = YES

EXTRACT_ALL

If the EXTRACT_ALL tag is set to YES, Doxygen will assume all entities in documentation are documented, even if no documentation was available. Private class members and static file members will be hidden unless the EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES.

For example FixedSizeListType::list_size

arrow/cpp/src/arrow/type.h

Lines 1363 to 1390 in 196cde3

	class ARROW_EXPORT FixedSizeListType : public BaseListType {
	public:
	static constexpr Type::type type_id = Type::FIXED_SIZE_LIST;
	// While the individual item size is 32-bit, the overall data size
	// (item size * list length) may not fit in a 32-bit int.
	using offset_type = int64_t;
	static constexpr const char* type_name() { return "fixed_size_list"; }
	// List can contain any other logical value type
	FixedSizeListType(std::shared_ptr<DataType> value_type, int32_t list_size)
	: FixedSizeListType(std::make_shared<Field>("item", std::move(value_type)),
	list_size) {}
	FixedSizeListType(std::shared_ptr<Field> value_field, int32_t list_size)
	: BaseListType(type_id), list_size_(list_size) {
	children_ = {std::move(value_field)};
	}
	DataTypeLayout layout() const override {
	return DataTypeLayout({DataTypeLayout::Bitmap()});
	}
	std::string ToString(bool show_metadata = false) const override;
	std::string name() const override { return "fixed_size_list"; }
	int32_t list_size() const { return list_size_; }

https://arrow.apache.org/docs/cpp/api/datatype.html#classarrow_1_1_fixed_size_list_type

Component(s)

Documentation