From 075ca36b0ea6270654045033f7cc2bb8c39cf0b7 Mon Sep 17 00:00:00 2001 From: KiterLuc <67824247+KiterLuc@users.noreply.github.com> Date: Mon, 12 Feb 2024 16:55:13 +0100 Subject: [PATCH] Small doxygen fixes. --- tiledb/sm/query/query.h | 2 ++ tiledb/sm/query/strategy_base.h | 2 ++ tiledb/sm/stats/stats.h | 5 +++++ tiledb/sm/subarray/subarray.h | 2 ++ tiledb/sm/subarray/subarray_partitioner.h | 2 ++ 5 files changed, 13 insertions(+) diff --git a/tiledb/sm/query/query.h b/tiledb/sm/query/query.h index df8f21e15a0..e54c0342f90 100644 --- a/tiledb/sm/query/query.h +++ b/tiledb/sm/query/query.h @@ -658,6 +658,8 @@ class Query { /** * Populate the owned stats instance with data. * To be removed when the class will get a C41 constructor. + * + * @param data Data to populate the stats with. */ void set_stats(const stats::StatsData& data); diff --git a/tiledb/sm/query/strategy_base.h b/tiledb/sm/query/strategy_base.h index 9f8a325b861..b5d1abb983a 100644 --- a/tiledb/sm/query/strategy_base.h +++ b/tiledb/sm/query/strategy_base.h @@ -211,6 +211,8 @@ class StrategyBase { /** * Populate the owned stats instance with data. * To be removed when the class will get a C41 constructor. + * + * @param data Data to populate the stats with. */ void set_stats(const stats::StatsData& data); diff --git a/tiledb/sm/stats/stats.h b/tiledb/sm/stats/stats.h index 84d70a61b72..47691c8d294 100644 --- a/tiledb/sm/stats/stats.h +++ b/tiledb/sm/stats/stats.h @@ -179,6 +179,9 @@ class Stats { /** * Creates a child instance, managed by this instance, the instance is * constructed with initial data. + * + * @param prefix The stat name prefix. + * @param data Initial data to populate the Stats object with. */ Stats* create_child(const std::string& prefix, const StatsData& data); @@ -192,6 +195,8 @@ class Stats { * Populate the counters and timers internal maps from a StatsData object * Please be aware that the data is not being added up, it will override the * existing data on the Stats object. + * + * @param data Data to populate the stats with. */ void populate_with_data(const StatsData& data); diff --git a/tiledb/sm/subarray/subarray.h b/tiledb/sm/subarray/subarray.h index ea9977540fc..84c986f61e3 100644 --- a/tiledb/sm/subarray/subarray.h +++ b/tiledb/sm/subarray/subarray.h @@ -1281,6 +1281,8 @@ class Subarray { /** * Populate the owned stats instance with data. * To be removed when the class will get a C41 constructor. + * + * @param data Data to populate the stats with. */ void set_stats(const stats::StatsData& data); diff --git a/tiledb/sm/subarray/subarray_partitioner.h b/tiledb/sm/subarray/subarray_partitioner.h index 0cb9e6439cc..2915fd7aefe 100644 --- a/tiledb/sm/subarray/subarray_partitioner.h +++ b/tiledb/sm/subarray/subarray_partitioner.h @@ -337,6 +337,8 @@ class SubarrayPartitioner { /** Populate the owned stats instance with data. * To be removed when the class will get a C41 constructor. + * + * @param data Data to populate the stats with. */ void set_stats(const stats::StatsData& data);