From b04396f2b180b9b0b9ecc364ec34b6194a0784e9 Mon Sep 17 00:00:00 2001 From: Junwang Zhao Date: Fri, 3 Jul 2026 23:06:57 +0800 Subject: [PATCH] fix: generate public API docs correctly --- Makefile | 1 + mkdocs/Doxyfile | 7 +-- mkdocs/build-docs.sh | 1 + mkdocs/namespace_docs.dox | 54 +++++++++++++++++++ src/iceberg/arrow/arrow_io_util.h | 3 ++ src/iceberg/arrow/s3/s3_properties.h | 3 ++ src/iceberg/avro/avro_constants.h | 3 ++ src/iceberg/avro/avro_metrics.h | 3 ++ src/iceberg/avro/avro_reader.h | 3 ++ src/iceberg/avro/avro_writer.h | 3 ++ src/iceberg/catalog.h | 3 ++ .../catalog/hive/iceberg_hive_export.h | 3 ++ .../catalog/memory/in_memory_catalog.h | 3 ++ src/iceberg/catalog/rest/http_request.h | 3 ++ .../catalog/rest/iceberg_rest_export.h | 3 ++ src/iceberg/catalog/rest/rest_file_io.h | 3 ++ src/iceberg/catalog/rest/rest_util.h | 3 ++ src/iceberg/catalog/session_catalog.h | 3 ++ src/iceberg/catalog/session_context.h | 3 ++ .../catalog/sql/iceberg_sql_catalog_export.h | 3 ++ .../deletes/position_delete_range_consumer.h | 3 ++ src/iceberg/expression/literal.h | 3 ++ src/iceberg/file_io.h | 3 ++ src/iceberg/file_io_registry.h | 3 ++ src/iceberg/iceberg_bundle_export.h | 3 ++ src/iceberg/iceberg_data_export.h | 3 ++ src/iceberg/iceberg_export.h | 3 ++ src/iceberg/inspect/history_table.h | 3 ++ src/iceberg/inspect/metadata_table.h | 3 ++ src/iceberg/inspect/snapshots_table.h | 3 ++ src/iceberg/location_provider.h | 3 ++ src/iceberg/metrics/commit_report.h | 3 ++ src/iceberg/metrics/counter.h | 3 ++ src/iceberg/metrics/metrics_reporter.h | 3 ++ src/iceberg/metrics/scan_report.h | 3 ++ src/iceberg/metrics/timer.h | 3 ++ src/iceberg/name_mapping.h | 3 ++ src/iceberg/parquet/parquet_reader.h | 3 ++ src/iceberg/parquet/parquet_writer.h | 3 ++ src/iceberg/result.h | 3 ++ src/iceberg/row/manifest_wrapper.h | 2 +- src/iceberg/schema_util.h | 3 ++ src/iceberg/snapshot.h | 3 ++ src/iceberg/sort_order.h | 3 ++ src/iceberg/storage_credential.h | 3 ++ src/iceberg/table.h | 3 ++ src/iceberg/table_properties.h | 3 ++ src/iceberg/table_scan.h | 3 ++ src/iceberg/transaction.h | 3 ++ src/iceberg/update/snapshot_update.h | 3 ++ src/iceberg/util/bucket_util.h | 3 ++ src/iceberg/util/config.h | 3 ++ src/iceberg/util/executor.h | 3 ++ src/iceberg/util/functional.h | 3 ++ src/iceberg/util/location_util.h | 3 ++ src/iceberg/util/macros.h | 3 ++ src/iceberg/util/partition_value_util.h | 2 +- src/iceberg/util/property_util.h | 3 ++ src/iceberg/util/retry_util.h | 3 ++ src/iceberg/util/string_util.h | 3 ++ src/iceberg/util/task_group.h | 3 ++ src/iceberg/util/temporal_util.h | 3 ++ src/iceberg/util/timepoint.h | 3 ++ src/iceberg/util/transform_util.h | 3 ++ src/iceberg/util/truncate_util.h | 3 ++ src/iceberg/util/visitor_generate.h | 3 ++ 66 files changed, 242 insertions(+), 5 deletions(-) create mode 100644 mkdocs/namespace_docs.dox diff --git a/Makefile b/Makefile index 100069545..99ca5bbaa 100644 --- a/Makefile +++ b/Makefile @@ -33,6 +33,7 @@ install-deps: build-api-docs: cd mkdocs && \ + rm -rf docs/api && \ mkdir -p docs/api && \ doxygen Doxyfile && \ echo "Doxygen output created in docs/api/" diff --git a/mkdocs/Doxyfile b/mkdocs/Doxyfile index 75e5ee232..ea3df1833 100644 --- a/mkdocs/Doxyfile +++ b/mkdocs/Doxyfile @@ -966,7 +966,7 @@ WARN_LOGFILE = # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING # Note: If this tag is empty the current directory is searched. -INPUT = ../src ../README.md +INPUT = ../src ../README.md namespace_docs.dox # This tag can be used to specify the character encoding of the source files # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses @@ -1071,7 +1071,8 @@ RECURSIVE = YES # Note that relative paths are relative to the directory from which doxygen is # run. -EXCLUDE = +EXCLUDE = ../src/iceberg/test \ + ../src/iceberg/catalog/hive/gen-cpp # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or # directories that are symbolic links (a Unix file system feature) are excluded @@ -1087,7 +1088,7 @@ EXCLUDE_SYMLINKS = NO # Note that the wildcards are matched against the file with absolute path, so to # exclude all test directories for example use the pattern */test/* -EXCLUDE_PATTERNS = +EXCLUDE_PATTERNS = *_internal.h # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names # (namespaces, classes, functions, etc.) that should be excluded from the diff --git a/mkdocs/build-docs.sh b/mkdocs/build-docs.sh index 6917d339e..70f4bf8f7 100755 --- a/mkdocs/build-docs.sh +++ b/mkdocs/build-docs.sh @@ -41,6 +41,7 @@ if ! command -v doxygen &> /dev/null; then else echo "Building API documentation with Doxygen..." cd mkdocs + rm -rf docs/api mkdir -p docs/api doxygen Doxyfile cd .. diff --git a/mkdocs/namespace_docs.dox b/mkdocs/namespace_docs.dox new file mode 100644 index 000000000..9faa714d6 --- /dev/null +++ b/mkdocs/namespace_docs.dox @@ -0,0 +1,54 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ + +/// \namespace iceberg +/// \brief Core Apache Iceberg C++ APIs. + +/// \namespace iceberg::arrow +/// \brief Arrow-backed IO and data conversion APIs. + +/// \namespace iceberg::avro +/// \brief Avro reader, writer, and metadata APIs. + +/// \namespace iceberg::hive +/// \brief Hive catalog APIs. + +/// \namespace iceberg::parquet +/// \brief Parquet reader, writer, and registration APIs. + +/// \namespace iceberg::puffin +/// \brief Puffin file metadata, reader, and writer APIs. + +/// \namespace iceberg::rest +/// \brief REST catalog APIs. + +/// \namespace iceberg::rest::auth +/// \brief REST catalog authentication APIs. + +/// \namespace iceberg::retry +/// \brief Retry policy APIs. + +/// \namespace iceberg::sql +/// \brief SQL catalog APIs. + +/// \namespace iceberg::table +/// \brief Table update requirement APIs. + +/// \namespace iceberg::util +/// \brief Utility APIs. diff --git a/src/iceberg/arrow/arrow_io_util.h b/src/iceberg/arrow/arrow_io_util.h index e33826dc6..925ee12a2 100644 --- a/src/iceberg/arrow/arrow_io_util.h +++ b/src/iceberg/arrow/arrow_io_util.h @@ -19,6 +19,9 @@ #pragma once +/// \file iceberg/arrow/arrow_io_util.h +/// \brief Provide helpers to create Arrow-backed FileIO implementations. + #include #include #include diff --git a/src/iceberg/arrow/s3/s3_properties.h b/src/iceberg/arrow/s3/s3_properties.h index 7b76968a6..03d1492ad 100644 --- a/src/iceberg/arrow/s3/s3_properties.h +++ b/src/iceberg/arrow/s3/s3_properties.h @@ -19,6 +19,9 @@ #pragma once +/// \file iceberg/arrow/s3/s3_properties.h +/// \brief Define S3 configuration property keys. + #include namespace iceberg::arrow { diff --git a/src/iceberg/avro/avro_constants.h b/src/iceberg/avro/avro_constants.h index 6fdfdc5ed..f3f175c1e 100644 --- a/src/iceberg/avro/avro_constants.h +++ b/src/iceberg/avro/avro_constants.h @@ -19,6 +19,9 @@ #pragma once +/// \file iceberg/avro/avro_constants.h +/// \brief Define Avro metadata constants used by Iceberg. + #include namespace iceberg::avro { diff --git a/src/iceberg/avro/avro_metrics.h b/src/iceberg/avro/avro_metrics.h index 799c00ee3..3f055c23b 100644 --- a/src/iceberg/avro/avro_metrics.h +++ b/src/iceberg/avro/avro_metrics.h @@ -19,6 +19,9 @@ #pragma once +/// \file iceberg/avro/avro_metrics.h +/// \brief Compute Iceberg metrics for Avro data files. + #include "iceberg/iceberg_bundle_export.h" #include "iceberg/metrics.h" diff --git a/src/iceberg/avro/avro_reader.h b/src/iceberg/avro/avro_reader.h index 24f95f5d4..c193d00c2 100644 --- a/src/iceberg/avro/avro_reader.h +++ b/src/iceberg/avro/avro_reader.h @@ -19,6 +19,9 @@ #pragma once +/// \file iceberg/avro/avro_reader.h +/// \brief Provide the Avro file reader interface. + #include "iceberg/file_reader.h" #include "iceberg/iceberg_bundle_export.h" diff --git a/src/iceberg/avro/avro_writer.h b/src/iceberg/avro/avro_writer.h index 3bd8110d9..af68fac44 100644 --- a/src/iceberg/avro/avro_writer.h +++ b/src/iceberg/avro/avro_writer.h @@ -19,6 +19,9 @@ #pragma once +/// \file iceberg/avro/avro_writer.h +/// \brief Provide the Avro file writer interface. + #include "iceberg/file_writer.h" #include "iceberg/iceberg_bundle_export.h" diff --git a/src/iceberg/catalog.h b/src/iceberg/catalog.h index 81c9ddd11..79c901fd0 100644 --- a/src/iceberg/catalog.h +++ b/src/iceberg/catalog.h @@ -19,6 +19,9 @@ #pragma once +/// \file iceberg/catalog.h +/// \brief Define the catalog API for table and namespace operations. + #include #include #include diff --git a/src/iceberg/catalog/hive/iceberg_hive_export.h b/src/iceberg/catalog/hive/iceberg_hive_export.h index 229304553..386329753 100644 --- a/src/iceberg/catalog/hive/iceberg_hive_export.h +++ b/src/iceberg/catalog/hive/iceberg_hive_export.h @@ -19,6 +19,9 @@ #pragma once +/// \file iceberg/catalog/hive/iceberg_hive_export.h +/// \brief Define symbol visibility macros for the Hive catalog library. + #if defined(_WIN32) || defined(__CYGWIN__) # ifdef ICEBERG_HIVE_STATIC # define ICEBERG_HIVE_EXPORT diff --git a/src/iceberg/catalog/memory/in_memory_catalog.h b/src/iceberg/catalog/memory/in_memory_catalog.h index 22a596c10..548fd7afc 100644 --- a/src/iceberg/catalog/memory/in_memory_catalog.h +++ b/src/iceberg/catalog/memory/in_memory_catalog.h @@ -19,6 +19,9 @@ #pragma once +/// \file iceberg/catalog/memory/in_memory_catalog.h +/// \brief Provide an in-memory catalog implementation. + #include #include "iceberg/catalog.h" diff --git a/src/iceberg/catalog/rest/http_request.h b/src/iceberg/catalog/rest/http_request.h index 47419c361..4016df66f 100644 --- a/src/iceberg/catalog/rest/http_request.h +++ b/src/iceberg/catalog/rest/http_request.h @@ -19,6 +19,9 @@ #pragma once +/// \file iceberg/catalog/rest/http_request.h +/// \brief Define REST HTTP request types. + #include #include #include diff --git a/src/iceberg/catalog/rest/iceberg_rest_export.h b/src/iceberg/catalog/rest/iceberg_rest_export.h index 7e8836f8f..f8b322660 100644 --- a/src/iceberg/catalog/rest/iceberg_rest_export.h +++ b/src/iceberg/catalog/rest/iceberg_rest_export.h @@ -19,6 +19,9 @@ #pragma once +/// \file iceberg/catalog/rest/iceberg_rest_export.h +/// \brief Define symbol visibility macros for the REST catalog library. + #if defined(_WIN32) || defined(__CYGWIN__) # ifdef ICEBERG_REST_STATIC # define ICEBERG_REST_EXPORT diff --git a/src/iceberg/catalog/rest/rest_file_io.h b/src/iceberg/catalog/rest/rest_file_io.h index 9e5f7a0a9..9bd0a826e 100644 --- a/src/iceberg/catalog/rest/rest_file_io.h +++ b/src/iceberg/catalog/rest/rest_file_io.h @@ -19,6 +19,9 @@ #pragma once +/// \file iceberg/catalog/rest/rest_file_io.h +/// \brief Provide helpers to create FileIO instances for REST catalog responses. + #include #include #include diff --git a/src/iceberg/catalog/rest/rest_util.h b/src/iceberg/catalog/rest/rest_util.h index 51a708994..556b2557a 100644 --- a/src/iceberg/catalog/rest/rest_util.h +++ b/src/iceberg/catalog/rest/rest_util.h @@ -19,6 +19,9 @@ #pragma once +/// \file iceberg/catalog/rest/rest_util.h +/// \brief Provide utilities for REST catalog path and config handling. + #include #include #include diff --git a/src/iceberg/catalog/session_catalog.h b/src/iceberg/catalog/session_catalog.h index 2d7aeae25..08ac048a5 100644 --- a/src/iceberg/catalog/session_catalog.h +++ b/src/iceberg/catalog/session_catalog.h @@ -19,6 +19,9 @@ #pragma once +/// \file iceberg/catalog/session_catalog.h +/// \brief Define session catalog routing APIs. + #include #include diff --git a/src/iceberg/catalog/session_context.h b/src/iceberg/catalog/session_context.h index 7dee828e1..19eb8fc5f 100644 --- a/src/iceberg/catalog/session_context.h +++ b/src/iceberg/catalog/session_context.h @@ -19,6 +19,9 @@ #pragma once +/// \file iceberg/catalog/session_context.h +/// \brief Define session context metadata. + #include #include diff --git a/src/iceberg/catalog/sql/iceberg_sql_catalog_export.h b/src/iceberg/catalog/sql/iceberg_sql_catalog_export.h index 88921779b..d609e5675 100644 --- a/src/iceberg/catalog/sql/iceberg_sql_catalog_export.h +++ b/src/iceberg/catalog/sql/iceberg_sql_catalog_export.h @@ -19,6 +19,9 @@ #pragma once +/// \file iceberg/catalog/sql/iceberg_sql_catalog_export.h +/// \brief Define symbol visibility macros for the SQL catalog library. + #if defined(_WIN32) || defined(__CYGWIN__) # ifdef ICEBERG_SQL_CATALOG_STATIC # define ICEBERG_SQL_CATALOG_EXPORT diff --git a/src/iceberg/deletes/position_delete_range_consumer.h b/src/iceberg/deletes/position_delete_range_consumer.h index 69d1c33d7..37f6caeac 100644 --- a/src/iceberg/deletes/position_delete_range_consumer.h +++ b/src/iceberg/deletes/position_delete_range_consumer.h @@ -19,6 +19,9 @@ #pragma once +/// \file iceberg/deletes/position_delete_range_consumer.h +/// \brief Provide bulk application of position deletes. + #include #include #include diff --git a/src/iceberg/expression/literal.h b/src/iceberg/expression/literal.h index dbcabb521..d88ea9248 100644 --- a/src/iceberg/expression/literal.h +++ b/src/iceberg/expression/literal.h @@ -19,6 +19,9 @@ #pragma once +/// \file iceberg/expression/literal.h +/// \brief Define typed literal values used by expressions. + #include #include #include diff --git a/src/iceberg/file_io.h b/src/iceberg/file_io.h index 7d7b31113..3ea4afa49 100644 --- a/src/iceberg/file_io.h +++ b/src/iceberg/file_io.h @@ -19,6 +19,9 @@ #pragma once +/// \file iceberg/file_io.h +/// \brief Define the FileIO abstraction and file stream interfaces. + #include #include #include diff --git a/src/iceberg/file_io_registry.h b/src/iceberg/file_io_registry.h index a0be1b563..1643bf457 100644 --- a/src/iceberg/file_io_registry.h +++ b/src/iceberg/file_io_registry.h @@ -19,6 +19,9 @@ #pragma once +/// \file iceberg/file_io_registry.h +/// \brief Define the FileIO registry. + #include #include #include diff --git a/src/iceberg/iceberg_bundle_export.h b/src/iceberg/iceberg_bundle_export.h index c63f8811d..49407a34a 100644 --- a/src/iceberg/iceberg_bundle_export.h +++ b/src/iceberg/iceberg_bundle_export.h @@ -19,6 +19,9 @@ #pragma once +/// \file iceberg/iceberg_bundle_export.h +/// \brief Define symbol visibility macros for bundled format integrations. + #if defined(_WIN32) || defined(__CYGWIN__) # ifdef ICEBERG_BUNDLE_STATIC # define ICEBERG_BUNDLE_EXPORT diff --git a/src/iceberg/iceberg_data_export.h b/src/iceberg/iceberg_data_export.h index 652de97b6..5b710e9cc 100644 --- a/src/iceberg/iceberg_data_export.h +++ b/src/iceberg/iceberg_data_export.h @@ -19,6 +19,9 @@ #pragma once +/// \file iceberg/iceberg_data_export.h +/// \brief Define symbol visibility macros for data APIs. + #if defined(_WIN32) || defined(__CYGWIN__) # ifdef ICEBERG_DATA_STATIC # define ICEBERG_DATA_EXPORT diff --git a/src/iceberg/iceberg_export.h b/src/iceberg/iceberg_export.h index 2463fbeaf..5dcfa2f66 100644 --- a/src/iceberg/iceberg_export.h +++ b/src/iceberg/iceberg_export.h @@ -19,6 +19,9 @@ #pragma once +/// \file iceberg/iceberg_export.h +/// \brief Define symbol visibility macros for core Iceberg APIs. + #if defined(_WIN32) || defined(__CYGWIN__) # ifdef ICEBERG_STATIC # define ICEBERG_EXPORT diff --git a/src/iceberg/inspect/history_table.h b/src/iceberg/inspect/history_table.h index 94a26368f..21f1f8002 100644 --- a/src/iceberg/inspect/history_table.h +++ b/src/iceberg/inspect/history_table.h @@ -19,6 +19,9 @@ #pragma once +/// \file iceberg/inspect/history_table.h +/// \brief Define the history metadata table. + #include #include "iceberg/iceberg_export.h" diff --git a/src/iceberg/inspect/metadata_table.h b/src/iceberg/inspect/metadata_table.h index 7d0ac22da..51c5f7920 100644 --- a/src/iceberg/inspect/metadata_table.h +++ b/src/iceberg/inspect/metadata_table.h @@ -19,6 +19,9 @@ #pragma once +/// \file iceberg/inspect/metadata_table.h +/// \brief Define base APIs for metadata tables. + #include #include "iceberg/iceberg_export.h" diff --git a/src/iceberg/inspect/snapshots_table.h b/src/iceberg/inspect/snapshots_table.h index 50017796f..9af1bcacb 100644 --- a/src/iceberg/inspect/snapshots_table.h +++ b/src/iceberg/inspect/snapshots_table.h @@ -19,6 +19,9 @@ #pragma once +/// \file iceberg/inspect/snapshots_table.h +/// \brief Define the snapshots metadata table. + #include #include "iceberg/iceberg_export.h" diff --git a/src/iceberg/location_provider.h b/src/iceberg/location_provider.h index 6b6fa4475..8541b7c11 100644 --- a/src/iceberg/location_provider.h +++ b/src/iceberg/location_provider.h @@ -19,6 +19,9 @@ #pragma once +/// \file iceberg/location_provider.h +/// \brief Define table data location providers. + #include #include #include diff --git a/src/iceberg/metrics/commit_report.h b/src/iceberg/metrics/commit_report.h index 63867c8e0..a644d0b07 100644 --- a/src/iceberg/metrics/commit_report.h +++ b/src/iceberg/metrics/commit_report.h @@ -19,6 +19,9 @@ #pragma once +/// \file iceberg/metrics/commit_report.h +/// \brief Define commit metrics and reports. + #include #include #include diff --git a/src/iceberg/metrics/counter.h b/src/iceberg/metrics/counter.h index 4542b90f0..b44cf844b 100644 --- a/src/iceberg/metrics/counter.h +++ b/src/iceberg/metrics/counter.h @@ -19,6 +19,9 @@ #pragma once +/// \file iceberg/metrics/counter.h +/// \brief Define metrics counters. + #include #include #include diff --git a/src/iceberg/metrics/metrics_reporter.h b/src/iceberg/metrics/metrics_reporter.h index b255a95e8..a45754dc0 100644 --- a/src/iceberg/metrics/metrics_reporter.h +++ b/src/iceberg/metrics/metrics_reporter.h @@ -19,6 +19,9 @@ #pragma once +/// \file iceberg/metrics/metrics_reporter.h +/// \brief Define metrics report dispatch APIs. + #include #include #include diff --git a/src/iceberg/metrics/scan_report.h b/src/iceberg/metrics/scan_report.h index 2d81e7e8f..1ac74c05f 100644 --- a/src/iceberg/metrics/scan_report.h +++ b/src/iceberg/metrics/scan_report.h @@ -19,6 +19,9 @@ #pragma once +/// \file iceberg/metrics/scan_report.h +/// \brief Define scan metrics and reports. + #include #include #include diff --git a/src/iceberg/metrics/timer.h b/src/iceberg/metrics/timer.h index 08bbf8e34..e15c623f3 100644 --- a/src/iceberg/metrics/timer.h +++ b/src/iceberg/metrics/timer.h @@ -19,6 +19,9 @@ #pragma once +/// \file iceberg/metrics/timer.h +/// \brief Define metrics timers. + #include #include #include diff --git a/src/iceberg/name_mapping.h b/src/iceberg/name_mapping.h index 392b573e3..7fd140c0d 100644 --- a/src/iceberg/name_mapping.h +++ b/src/iceberg/name_mapping.h @@ -19,6 +19,9 @@ #pragma once +/// \file iceberg/name_mapping.h +/// \brief Define schema name mapping APIs. + #include #include #include diff --git a/src/iceberg/parquet/parquet_reader.h b/src/iceberg/parquet/parquet_reader.h index 0604230c8..3a8e57cf3 100644 --- a/src/iceberg/parquet/parquet_reader.h +++ b/src/iceberg/parquet/parquet_reader.h @@ -19,6 +19,9 @@ #pragma once +/// \file iceberg/parquet/parquet_reader.h +/// \brief Provide the Parquet file reader interface. + #include "iceberg/file_reader.h" #include "iceberg/iceberg_bundle_export.h" diff --git a/src/iceberg/parquet/parquet_writer.h b/src/iceberg/parquet/parquet_writer.h index 5abe45db9..562ffb801 100644 --- a/src/iceberg/parquet/parquet_writer.h +++ b/src/iceberg/parquet/parquet_writer.h @@ -19,6 +19,9 @@ #pragma once +/// \file iceberg/parquet/parquet_writer.h +/// \brief Provide the Parquet file writer interface. + #include "iceberg/file_writer.h" #include "iceberg/iceberg_bundle_export.h" diff --git a/src/iceberg/result.h b/src/iceberg/result.h index 4b4d0e7fb..88b13c51e 100644 --- a/src/iceberg/result.h +++ b/src/iceberg/result.h @@ -19,6 +19,9 @@ #pragma once +/// \file iceberg/result.h +/// \brief Define Result, Status, and error helpers. + #include #include #include diff --git a/src/iceberg/row/manifest_wrapper.h b/src/iceberg/row/manifest_wrapper.h index 20c2165b2..bd4fc4df6 100644 --- a/src/iceberg/row/manifest_wrapper.h +++ b/src/iceberg/row/manifest_wrapper.h @@ -19,7 +19,7 @@ #pragma once -/// \file iceberg/manifest_wrapper.h +/// \file iceberg/row/manifest_wrapper.h /// Wrapper classes for manifest-related data structures that implement /// StructLike, ArrayLike, and MapLike interfaces for unified data access. diff --git a/src/iceberg/schema_util.h b/src/iceberg/schema_util.h index 9df402336..421d00e0a 100644 --- a/src/iceberg/schema_util.h +++ b/src/iceberg/schema_util.h @@ -19,6 +19,9 @@ #pragma once +/// \file iceberg/schema_util.h +/// \brief Provide schema projection utilities. + #include #include #include diff --git a/src/iceberg/snapshot.h b/src/iceberg/snapshot.h index c2fd9b8a2..e32f3a715 100644 --- a/src/iceberg/snapshot.h +++ b/src/iceberg/snapshot.h @@ -19,6 +19,9 @@ #pragma once +/// \file iceberg/snapshot.h +/// \brief Define snapshot metadata types. + #include #include #include diff --git a/src/iceberg/sort_order.h b/src/iceberg/sort_order.h index 7c9b799fb..75cabeca7 100644 --- a/src/iceberg/sort_order.h +++ b/src/iceberg/sort_order.h @@ -19,6 +19,9 @@ #pragma once +/// \file iceberg/sort_order.h +/// \brief Define table sort order metadata. + #include #include #include diff --git a/src/iceberg/storage_credential.h b/src/iceberg/storage_credential.h index 604e8ddce..746bad086 100644 --- a/src/iceberg/storage_credential.h +++ b/src/iceberg/storage_credential.h @@ -19,6 +19,9 @@ #pragma once +/// \file iceberg/storage_credential.h +/// \brief Define storage credential metadata. + #include #include diff --git a/src/iceberg/table.h b/src/iceberg/table.h index b52b5d29d..f9b72302a 100644 --- a/src/iceberg/table.h +++ b/src/iceberg/table.h @@ -19,6 +19,9 @@ #pragma once +/// \file iceberg/table.h +/// \brief Define table abstractions and update entry points. + #include #include #include diff --git a/src/iceberg/table_properties.h b/src/iceberg/table_properties.h index 6b92ea1ff..f334272e6 100644 --- a/src/iceberg/table_properties.h +++ b/src/iceberg/table_properties.h @@ -19,6 +19,9 @@ #pragma once +/// \file iceberg/table_properties.h +/// \brief Define table property helpers. + #include #include #include diff --git a/src/iceberg/table_scan.h b/src/iceberg/table_scan.h index e55330f30..f3e2f244d 100644 --- a/src/iceberg/table_scan.h +++ b/src/iceberg/table_scan.h @@ -19,6 +19,9 @@ #pragma once +/// \file iceberg/table_scan.h +/// \brief Define table scan APIs and scan task types. + #include #include #include diff --git a/src/iceberg/transaction.h b/src/iceberg/transaction.h index 47714ba70..284222351 100644 --- a/src/iceberg/transaction.h +++ b/src/iceberg/transaction.h @@ -20,6 +20,9 @@ #pragma once +/// \file iceberg/transaction.h +/// \brief Define transaction APIs. + #include #include #include diff --git a/src/iceberg/update/snapshot_update.h b/src/iceberg/update/snapshot_update.h index 10bb16fbc..e29d96d57 100644 --- a/src/iceberg/update/snapshot_update.h +++ b/src/iceberg/update/snapshot_update.h @@ -19,6 +19,9 @@ #pragma once +/// \file iceberg/update/snapshot_update.h +/// \brief Define base APIs for snapshot updates. + #include #include #include diff --git a/src/iceberg/util/bucket_util.h b/src/iceberg/util/bucket_util.h index 31a574b48..459f487bb 100644 --- a/src/iceberg/util/bucket_util.h +++ b/src/iceberg/util/bucket_util.h @@ -19,6 +19,9 @@ #pragma once +/// \file iceberg/util/bucket_util.h +/// \brief Provide bucket transform utilities. + #include #include diff --git a/src/iceberg/util/config.h b/src/iceberg/util/config.h index 089c78f5d..ed847eb63 100644 --- a/src/iceberg/util/config.h +++ b/src/iceberg/util/config.h @@ -18,6 +18,9 @@ */ #pragma once +/// \file iceberg/util/config.h +/// \brief Provide typed configuration helpers. + #include #include #include diff --git a/src/iceberg/util/executor.h b/src/iceberg/util/executor.h index 01aa83d7a..749502b17 100644 --- a/src/iceberg/util/executor.h +++ b/src/iceberg/util/executor.h @@ -19,6 +19,9 @@ #pragma once +/// \file iceberg/util/executor.h +/// \brief Define task executor interfaces. + #include #include diff --git a/src/iceberg/util/functional.h b/src/iceberg/util/functional.h index c5ab2164b..dbb35a376 100644 --- a/src/iceberg/util/functional.h +++ b/src/iceberg/util/functional.h @@ -22,6 +22,9 @@ #pragma once +/// \file iceberg/util/functional.h +/// \brief Provide move-only function wrappers. + #include #include #include diff --git a/src/iceberg/util/location_util.h b/src/iceberg/util/location_util.h index eb78dece3..c213a3bf7 100644 --- a/src/iceberg/util/location_util.h +++ b/src/iceberg/util/location_util.h @@ -19,6 +19,9 @@ #pragma once +/// \file iceberg/util/location_util.h +/// \brief Provide location path utilities. + #include #include "iceberg/iceberg_export.h" diff --git a/src/iceberg/util/macros.h b/src/iceberg/util/macros.h index e391d2bfd..400573d8b 100644 --- a/src/iceberg/util/macros.h +++ b/src/iceberg/util/macros.h @@ -19,6 +19,9 @@ #pragma once +/// \file iceberg/util/macros.h +/// \brief Define common Iceberg utility macros. + #include #include "iceberg/exception.h" diff --git a/src/iceberg/util/partition_value_util.h b/src/iceberg/util/partition_value_util.h index 0113623ba..abfc1ca87 100644 --- a/src/iceberg/util/partition_value_util.h +++ b/src/iceberg/util/partition_value_util.h @@ -19,7 +19,7 @@ #pragma once -/// \file iceberg/row/partition_values.h +/// \file iceberg/util/partition_value_util.h /// Wrapper classes for partition value related data structures. #include diff --git a/src/iceberg/util/property_util.h b/src/iceberg/util/property_util.h index 4e3e9b125..c46d3a6ab 100644 --- a/src/iceberg/util/property_util.h +++ b/src/iceberg/util/property_util.h @@ -19,6 +19,9 @@ #pragma once +/// \file iceberg/util/property_util.h +/// \brief Provide property conversion helpers. + #include #include diff --git a/src/iceberg/util/retry_util.h b/src/iceberg/util/retry_util.h index 08e3fb81d..8d2ed2a18 100644 --- a/src/iceberg/util/retry_util.h +++ b/src/iceberg/util/retry_util.h @@ -19,6 +19,9 @@ #pragma once +/// \file iceberg/util/retry_util.h +/// \brief Provide retry policy and runner utilities. + #include #include #include diff --git a/src/iceberg/util/string_util.h b/src/iceberg/util/string_util.h index 01b6087b8..84b69fef4 100644 --- a/src/iceberg/util/string_util.h +++ b/src/iceberg/util/string_util.h @@ -19,6 +19,9 @@ #pragma once +/// \file iceberg/util/string_util.h +/// \brief Provide string utility helpers. + #include #include #include diff --git a/src/iceberg/util/task_group.h b/src/iceberg/util/task_group.h index 5263816e3..3d345c240 100644 --- a/src/iceberg/util/task_group.h +++ b/src/iceberg/util/task_group.h @@ -19,6 +19,9 @@ #pragma once +/// \file iceberg/util/task_group.h +/// \brief Provide grouped task execution utilities. + #include #include #include diff --git a/src/iceberg/util/temporal_util.h b/src/iceberg/util/temporal_util.h index acb1f0e73..4a0642daa 100644 --- a/src/iceberg/util/temporal_util.h +++ b/src/iceberg/util/temporal_util.h @@ -19,6 +19,9 @@ #pragma once +/// \file iceberg/util/temporal_util.h +/// \brief Provide date and timestamp conversion utilities. + #include #include #include diff --git a/src/iceberg/util/timepoint.h b/src/iceberg/util/timepoint.h index 34ffedfc7..3a12ccd22 100644 --- a/src/iceberg/util/timepoint.h +++ b/src/iceberg/util/timepoint.h @@ -19,6 +19,9 @@ #pragma once +/// \file iceberg/util/timepoint.h +/// \brief Provide time point conversion helpers. + #include #include "iceberg/iceberg_export.h" diff --git a/src/iceberg/util/transform_util.h b/src/iceberg/util/transform_util.h index e0918dcf3..77197d6ab 100644 --- a/src/iceberg/util/transform_util.h +++ b/src/iceberg/util/transform_util.h @@ -19,6 +19,9 @@ #pragma once +/// \file iceberg/util/transform_util.h +/// \brief Provide partition transform utility helpers. + #include #include diff --git a/src/iceberg/util/truncate_util.h b/src/iceberg/util/truncate_util.h index 7fee86eba..0ed686546 100644 --- a/src/iceberg/util/truncate_util.h +++ b/src/iceberg/util/truncate_util.h @@ -19,6 +19,9 @@ #pragma once +/// \file iceberg/util/truncate_util.h +/// \brief Provide truncate transform utility helpers. + #include #include #include diff --git a/src/iceberg/util/visitor_generate.h b/src/iceberg/util/visitor_generate.h index ad6f5eb2d..37a9bb6c1 100644 --- a/src/iceberg/util/visitor_generate.h +++ b/src/iceberg/util/visitor_generate.h @@ -19,6 +19,9 @@ #pragma once +/// \file iceberg/util/visitor_generate.h +/// \brief Define macros for generating type visitors. + namespace iceberg { #define ICEBERG_GENERATE_FOR_ALL_TYPES(ACTION) \