Skip to content

Commit

Permalink
Add documentation for function overloading.
Browse files Browse the repository at this point in the history
  • Loading branch information
bekadavis9 committed May 10, 2024
1 parent 2992ea2 commit ea8f2ee
Showing 1 changed file with 26 additions and 0 deletions.
26 changes: 26 additions & 0 deletions tiledb/sm/array/array.h
Original file line number Diff line number Diff line change
Expand Up @@ -428,6 +428,12 @@ class Array {
* @param timestamp_start The start timestamp at which to delete fragments.
* @param timestamp_end The end timestamp at which to delete fragments.
* @param array_dir An optional ArrayDirectory from which to delete fragments.
*
* @section Maturity Notes
* This is legacy code, ported from StorageManager during its removal process.
* Its existence supports the non-static `delete_fragments` API below,
* performing the actual deletion of fragments. This function is slated for
* removal and should be directly integrated into the function below.
*/
static void delete_fragments(
ContextResources& resources,
Expand All @@ -445,6 +451,13 @@ class Array {
* @param timestamp_end The end timestamp at which to delete fragments.
*
* @pre The Array must be open for exclusive writes
*
* @section Maturity Notes
* This API is an interim version of its final product, awaiting rewrite.
* As is, it handles the incoming URI and invokes the remote or local function
* call accordingly. The local, static function above is legacy code which
* exists only to support this function. A rewrite should integrate the two
* and remove the need for any static APIs.
*/
void delete_fragments(
const URI& uri, uint64_t timestamp_start, uint64_t timstamp_end);
Expand All @@ -454,6 +467,12 @@ class Array {
*
* @param resources The context resources.
* @param uri The uri of the Array whose data is to be deleted.
*
* @section Maturity Notes
* This is legacy code, ported from StorageManager during its removal process.
* Its existence supports the non-static `delete_array` API below,
* performing the actual deletion of array data. This function is slated for
* removal and should be directly integrated into the function below.
*/
static void delete_array(ContextResources& resources, const URI& uri);

Expand All @@ -463,6 +482,13 @@ class Array {
* @param uri The uri of the Array whose data is to be deleted.
*
* @pre The Array must be open for exclusive writes
*
* @section Maturity Notes
* This API is an interim version of its final product, awaiting rewrite.
* As is, it handles the incoming URI and invokes the remote or local function
* call accordingly. The local, static function above is legacy code which
* exists only to support this function. A rewrite should integrate the two
* and remove the need for any static APIs.
*/
void delete_array(const URI& uri);

Expand Down

0 comments on commit ea8f2ee

Please sign in to comment.