Skip to content

Commit

Permalink
Small doxygen fixes.
Browse files Browse the repository at this point in the history
  • Loading branch information
KiterLuc authored Feb 12, 2024
1 parent c1e5b58 commit 075ca36
Show file tree
Hide file tree
Showing 5 changed files with 13 additions and 0 deletions.
2 changes: 2 additions & 0 deletions tiledb/sm/query/query.h
Original file line number Diff line number Diff line change
Expand Up @@ -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);

Expand Down
2 changes: 2 additions & 0 deletions tiledb/sm/query/strategy_base.h
Original file line number Diff line number Diff line change
Expand Up @@ -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);

Expand Down
5 changes: 5 additions & 0 deletions tiledb/sm/stats/stats.h
Original file line number Diff line number Diff line change
Expand Up @@ -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);

Expand All @@ -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);

Expand Down
2 changes: 2 additions & 0 deletions tiledb/sm/subarray/subarray.h
Original file line number Diff line number Diff line change
Expand Up @@ -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);

Expand Down
2 changes: 2 additions & 0 deletions tiledb/sm/subarray/subarray_partitioner.h
Original file line number Diff line number Diff line change
Expand Up @@ -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);

Expand Down

0 comments on commit 075ca36

Please sign in to comment.