CLIENT-2743 Upgrade to doxygen 1.10.0.

- Modify config file to conform to new doxygen version. - Fix links on main html page. - Fix group classification errors identified by doxygen. - Use new section format doc standard in affected header files. - Update doxygen footer copyright year.
aerospike · Jan 9, 2024 · f4cb3b0 · f4cb3b0
1 parent 662f8d1
commit f4cb3b0
Show file tree

Hide file tree

Showing 14 changed files with 1,135 additions and 660 deletions.
diff --git a/modules/common b/modules/common
diff --git a/project/doxyfile b/project/doxyfile
diff --git a/src/apidocs/footer.html b/src/apidocs/footer.html
@@ -1,6 +1,6 @@
 <!-- start footer part -->
 <div class="footer">
-  <div class="copy">&copy 2008-2023 Aerospike Inc. All rights reserved.</div>
+  <div class="copy">&copy 2008-2024 Aerospike Inc. All rights reserved.</div>
   <div class="legal">
     <a href="http://www.aerospike.com/privacy-policy/">Privacy Policy</a>
     <span>|</span>

diff --git a/src/include/aerospike/aerospike.h b/src/include/aerospike/aerospike.h
@@ -1,5 +1,5 @@
 /*
- * Copyright 2008-2020 Aerospike, Inc.
+ * Copyright 2008-2024 Aerospike, Inc.
  *
  * Portions may be licensed to Aerospike, Inc. under one or more contributor
  * license agreements.
@@ -42,10 +42,10 @@
  * - Shared memory cluster tend state for multi-process applications
  * - TLS secure sockets
  *
- * See <a href="modules.html">Modules</a> for an API overview.
- *
- * See <a href="http://www.aerospike.com/docs/client/c">Developer Guide</a> for installation
- * instructions and example code.
+ * See <a href="files.html">Files</a> for aerospike header files.<br/>
+ * See <a href="classes.html">Types</a> for aerospike  types.<br/>
+ * See <a href="https://aerospike.com/developer/client/install?client=c">Developer Guide</a> for installation
+ * instructions and example code.<br/>
  */
 
 /**
@@ -71,9 +71,9 @@
 extern "C" {
 #endif
 
-/******************************************************************************
- * TYPES
- *****************************************************************************/
+//---------------------------------
+// Types
+//---------------------------------
 
 /**
  * @private
@@ -184,9 +184,9 @@ typedef struct aerospike_s {
 
 } aerospike;
 
-/******************************************************************************
- * FUNCTIONS
- *****************************************************************************/
+//---------------------------------
+// Functions
+//---------------------------------
 
 /**
  * Initialize a stack allocated aerospike instance. 

diff --git a/src/include/aerospike/as_batch.h b/src/include/aerospike/as_batch.h
@@ -1,5 +1,5 @@
 /*
- * Copyright 2008-2022 Aerospike, Inc.
+ * Copyright 2008-2024 Aerospike, Inc.
  *
  * Portions may be licensed to Aerospike, Inc. under one or more contributor
  * license agreements.
@@ -25,9 +25,9 @@
 extern "C" {
 #endif
 
-/*****************************************************************************
- * STRUCTURES
- *****************************************************************************/
+//---------------------------------
+// Types
+//---------------------------------
 
 /**
  * A collection of keys to be batch processed.
@@ -99,10 +99,9 @@ typedef struct as_batch_result_s {
  */
 typedef as_batch_result as_batch_read;
 
-/*********************************************************************************
- * INSTANCE MACROS
- *********************************************************************************/
-
+//---------------------------------
+// Macros
+//---------------------------------
 
 /** 
  * Initializes `as_batch` with specified capacity using alloca().
@@ -123,7 +122,7 @@ typedef as_batch_result as_batch_read;
  * @param __size		The number of keys to allocate.
  *
  * @relates as_batch
- * @ingroup batch_object
+ * @ingroup batch_operations
  */
 #define as_batch_inita(__batch, __size) \
 	do {\
@@ -135,9 +134,9 @@ typedef as_batch_result as_batch_read;
 		(__batch)->_free = false;\
 	} while(0)
 
-/*********************************************************************************
- * INSTANCE FUNCTIONS
- *********************************************************************************/
+//---------------------------------
+// Functions
+//---------------------------------
 
 /**
  * Create and initialize a heap allocated as_batch capable of storing
@@ -155,7 +154,7 @@ typedef as_batch_result as_batch_read;
  * @param size			The number of keys to allocate.
  *
  * @relates as_batch
- * @ingroup batch_object
+ * @ingroup batch_operations
  */
 AS_EXTERN as_batch*
 as_batch_new(uint32_t size);
@@ -177,7 +176,7 @@ as_batch_new(uint32_t size);
  * @param size			The number of keys to allocate.
  * 
  * @relates as_batch
- * @ingroup batch_object
+ * @ingroup batch_operations
  */
 AS_EXTERN as_batch*
 as_batch_init(as_batch* batch, uint32_t size);
@@ -192,7 +191,7 @@ as_batch_init(as_batch* batch, uint32_t size);
  * @param batch 	The batch to release.
  *
  * @relates as_batch
- * @ingroup batch_object
+ * @ingroup batch_operations
  */
 AS_EXTERN void
 as_batch_destroy(as_batch* batch);
@@ -201,13 +200,13 @@ as_batch_destroy(as_batch* batch);
  * Get the key at given position of the batch. If the position is not
  * within the allocated capacity for the batchm then NULL is returned.
  *
- * @param batch 	The batch to get the key from.
+ * @param batch 		The batch to get the key from.
  * @param i			The position of the key.
  *
  * @return On success, the key at specified position. If position is invalid, then NULL.
  *
  * @relates as_batch
- * @ingroup batch_object
+ * @ingroup batch_operations
  */
 static inline as_key*
 as_batch_keyat(const as_batch* batch, uint32_t i)

diff --git a/src/include/aerospike/as_cdt_ctx.h b/src/include/aerospike/as_cdt_ctx.h
@@ -1,5 +1,5 @@
 /*
- * Copyright 2008-2022 Aerospike, Inc.
+ * Copyright 2008-2024 Aerospike, Inc.
  *
  * Portions may be licensed to Aerospike, Inc. under one or more contributor
  * license agreements.
@@ -24,15 +24,15 @@
 extern "C" {
 #endif
 
-/******************************************************************************
- * TYPES
- *****************************************************************************/
+//---------------------------------
+// Types
+//---------------------------------
 
 /**
  * Nested CDT context type.
  *
  * @relates as_operations
- * @ingroup as_operations_object
+ * @ingroup base_operations
  */
 typedef enum {
 	AS_CDT_CTX_LIST_INDEX = 0x10,
@@ -50,7 +50,7 @@ typedef enum {
  * Nested CDT context level.
  *
  * @relates as_operations
- * @ingroup as_operations_object
+ * @ingroup base_operations
  */
 typedef struct as_cdt_ctx_item {
 	uint32_t type;
@@ -65,15 +65,15 @@ typedef struct as_cdt_ctx_item {
  * List of CDT context level(s).
  *
  * @relates as_operations
- * @ingroup as_operations_object
+ * @ingroup base_operations
  */
 typedef struct as_cdt_ctx {
 	as_vector list;
 } as_cdt_ctx;
 
-/******************************************************************************
- * MACROS
- *****************************************************************************/
+//---------------------------------
+// Macros
+//---------------------------------
 
 /**
  * Initialize a stack allocated nested CDT context list.
@@ -92,20 +92,20 @@ typedef struct as_cdt_ctx {
  * @param __cap		The max number of context levels allowed.
  *
  * @relates as_operations
- * @ingroup as_operations_object
+ * @ingroup base_operations
  */
 #define as_cdt_ctx_inita(__ctx, __cap) as_vector_inita(&(__ctx)->list, sizeof(as_cdt_ctx_item), __cap)
 
-/******************************************************************************
- * FUNCTIONS
- *****************************************************************************/
+//---------------------------------
+// Functions
+//---------------------------------
 
 /**
  * Initialize a stack allocated nested CDT context list, with item storage on the heap.
  * Call as_cdt_ctx_destroy() when done with the context list.
  *
  * @relates as_operations
- * @ingroup as_operations_object
+ * @ingroup base_operations
  */
 static inline void
 as_cdt_ctx_init(as_cdt_ctx* ctx, uint32_t capacity)
@@ -118,7 +118,7 @@ as_cdt_ctx_init(as_cdt_ctx* ctx, uint32_t capacity)
  * Call as_cdt_ctx_destroy() when done with the context list.
  *
  * @relates as_operations
- * @ingroup as_operations_object
+ * @ingroup base_operations
  */
 static inline as_cdt_ctx*
 as_cdt_ctx_create(uint32_t capacity)
@@ -130,7 +130,7 @@ as_cdt_ctx_create(uint32_t capacity)
  * Destroy nested CDT context list and as_val based context items that were allocated on the heap.
  *
  * @relates as_operations
- * @ingroup as_operations_object
+ * @ingroup base_operations
  */
 AS_EXTERN void
 as_cdt_ctx_destroy(as_cdt_ctx* ctx);
@@ -148,7 +148,7 @@ as_cdt_ctx_destroy(as_cdt_ctx* ctx);
  * </ul>
  *
  * @relates as_operations
- * @ingroup as_operations_object
+ * @ingroup base_operations
  */
 static inline void
 as_cdt_ctx_add_list_index(as_cdt_ctx* ctx, int index)
@@ -163,7 +163,7 @@ as_cdt_ctx_add_list_index(as_cdt_ctx* ctx, int index)
  * Create list with given type at index offset.
  *
  * @relates as_operations
- * @ingroup as_operations_object
+ * @ingroup base_operations
  */
 static inline void
 as_cdt_ctx_add_list_index_create(as_cdt_ctx* ctx, int index, as_list_order order, bool pad)
@@ -183,7 +183,7 @@ as_cdt_ctx_add_list_index_create(as_cdt_ctx* ctx, int index, as_list_order order
  * </ul>
  *
  * @relates as_operations
- * @ingroup as_operations_object
+ * @ingroup base_operations
  */
 static inline void
 as_cdt_ctx_add_list_rank(as_cdt_ctx* ctx, int rank)
@@ -198,7 +198,7 @@ as_cdt_ctx_add_list_rank(as_cdt_ctx* ctx, int rank)
  * Lookup list by value.  The ctx list takes ownership of val.
  *
  * @relates as_operations
- * @ingroup as_operations_object
+ * @ingroup base_operations
  */
 static inline void
 as_cdt_ctx_add_list_value(as_cdt_ctx* ctx, as_val* val)
@@ -222,7 +222,7 @@ as_cdt_ctx_add_list_value(as_cdt_ctx* ctx, as_val* val)
  * </ul>
  *
  * @relates as_operations
- * @ingroup as_operations_object
+ * @ingroup base_operations
  */
 static inline void
 as_cdt_ctx_add_map_index(as_cdt_ctx* ctx, int index)
@@ -242,7 +242,7 @@ as_cdt_ctx_add_map_index(as_cdt_ctx* ctx, int index)
  * </ul>
  *
  * @relates as_operations
- * @ingroup as_operations_object
+ * @ingroup base_operations
  */
 static inline void
 as_cdt_ctx_add_map_rank(as_cdt_ctx* ctx, int rank)
@@ -257,7 +257,7 @@ as_cdt_ctx_add_map_rank(as_cdt_ctx* ctx, int rank)
  * Lookup map by key.  The ctx list takes ownership of key.
  *
  * @relates as_operations
- * @ingroup as_operations_object
+ * @ingroup base_operations
  */
 static inline void
 as_cdt_ctx_add_map_key(as_cdt_ctx* ctx, as_val* key)
@@ -273,7 +273,7 @@ as_cdt_ctx_add_map_key(as_cdt_ctx* ctx, as_val* key)
  * The ctx list takes ownership of key.
  *
  * @relates as_operations
- * @ingroup as_operations_object
+ * @ingroup base_operations
  */
 static inline void
 as_cdt_ctx_add_map_key_create(as_cdt_ctx* ctx, as_val* key, as_map_order order)
@@ -288,7 +288,7 @@ as_cdt_ctx_add_map_key_create(as_cdt_ctx* ctx, as_val* key, as_map_order order)
  * Lookup map by value.  The ctx list takes ownership of val.
  *
  * @relates as_operations
- * @ingroup as_operations_object
+ * @ingroup base_operations
  */
 static inline void
 as_cdt_ctx_add_map_value(as_cdt_ctx* ctx, as_val* val)
+87 −91		src/include/aerospike/as_log.h
+1 −3		src/include/aerospike/as_stream.h