Fix #223, Update Doxygen @param Values

common/src/v7_rbtree.c

@@ -317,8 +317,8 @@ BP_LOCAL_SCOPE void swap_parent_and_child(bplib_rbt_root_t *tree, bplib_rbt_link
  * This may change the root location of the tree, if one of the nodes is the current root
  *
  * @param tree   Pointer to the entire tree
- * @param parent Pointer to the current parent which should become child
- * @param child  Pointer to the current child which should become parent
+ * @param node1  Pointer to the current parent which should become child
+ * @param node2  Pointer to the current child which should become parent
  */
 BP_LOCAL_SCOPE void swap_distant_nodes(bplib_rbt_root_t *tree, bplib_rbt_link_t *node1, bplib_rbt_link_t *node2)
 {

inc/bplib_api_types.h

@@ -279,7 +279,7 @@ static inline int bp_handle_to_serial(bp_handle_t h, bp_handle_t base)
  *
  * @sa bp_handle_to_serial
  *
- * @param h the handle value
+ * @param hv   the handle value
  * @param base the object base handle (indicates the type/class of handle)
  *
  * @returns handle as a serial number

lib/src/v7_dataservice_api.c

@@ -391,8 +391,10 @@ int bplib_serviceflow_forward_egress(void *arg, bplib_mpool_block_t *subq_src)
 /**
  * @brief Append a sub-flow (data service) to the base interface block
  *
- * @param svc_intf
- * @param fblk
+ * @param base_intf_blk
+ * @param svc_num
+ * @param type
+ * @param endpoint_intf_ref
  */
 int bplib_serviceflow_add_to_base(bplib_mpool_block_t *base_intf_blk, bp_val_t svc_num, bplib_dataservice_type_t type,
                                   bplib_mpool_ref_t endpoint_intf_ref)
@@ -447,8 +449,8 @@ int bplib_serviceflow_add_to_base(bplib_mpool_block_t *base_intf_blk, bp_val_t s
 /**
  * @brief Append a sub-flow (data service) to the base interface block
  *
- * @param svc_intf
- * @param fblk
+ * @param base_intf_blk
+ * @param svc_num
  */
 bplib_mpool_ref_t bplib_serviceflow_remove_from_base(bplib_mpool_block_t *base_intf_blk, bp_val_t svc_num)
 {

mpool/inc/v7_mpool_bblocks.h

@@ -229,15 +229,15 @@ void bplib_mpool_bblock_cbor_append(bplib_mpool_block_t *head, bplib_mpool_block
  * @brief Append a canonical block to the bundle
  *
  * @param cpb
- * @param ccb
+ * @param blk
  */
 void bplib_mpool_bblock_primary_append(bplib_mpool_bblock_primary_t *cpb, bplib_mpool_block_t *blk);
 
 /**
  * @brief Find a canonical block within the bundle
  *
  * @param cpb
- * @param ccb
+ * @param block_type
  */
 bplib_mpool_block_t *bplib_mpool_bblock_primary_locate_canonical(bplib_mpool_bblock_primary_t *cpb,
                                                                  bp_blocktype_t                block_type);
@@ -248,7 +248,6 @@ bplib_mpool_block_t *bplib_mpool_bblock_primary_locate_canonical(bplib_mpool_bbl
  * This would be used if the logical data has been changed, necessitating re-encoding of the data.
  * The old data blocks are returned to the pool, and the updated contents can replace it.
  *
- * @param pool
  * @param cpb
  */
 void bplib_mpool_bblock_primary_drop_encode(bplib_mpool_bblock_primary_t *cpb);
@@ -259,7 +258,6 @@ void bplib_mpool_bblock_primary_drop_encode(bplib_mpool_bblock_primary_t *cpb);
  * This would be used if the logical data has been changed, necessitating re-encoding of the data.
  * The old data blocks are returned to the pool, and the updated contents can replace it.
  *
- * @param pool
  * @param ccb
  */
 void bplib_mpool_bblock_canonical_drop_encode(bplib_mpool_bblock_canonical_t *ccb);

mpool/inc/v7_mpool_flows.h

@@ -137,7 +137,6 @@ bplib_mpool_block_t *bplib_mpool_flow_alloc(bplib_mpool_t *pool, uint32_t magic_
  * This purges the contents of a queue, such as when the interface is set to a "down" state,
  * this removes any pending items that were in it.
  *
- * @param pool
  * @param subq
  * @return uint32_t
  */

mpool/inc/v7_mpool_job.h

@@ -59,8 +59,7 @@ void bplib_mpool_job_init(bplib_mpool_block_t *base_block, bplib_mpool_job_t *jb
  * Applictions only need to explicitly call this API to mark it as active if there is
  * some other factor that requires it to be processed again.
  *
- * @param pool
- * @param jblk Job that is ready to run
+ * @param job Job that is ready to run
  */
 void bplib_mpool_job_mark_active(bplib_mpool_job_t *job);
 

mpool/inc/v7_mpool_ref.h

@@ -55,7 +55,6 @@ static inline bplib_mpool_block_t *bplib_mpool_dereference(bplib_mpool_ref_t ref
  * @note If this function returns non-NULL, the calling application should no longer directly
  * use the blk pointer that was passed in.  It should only use the reference pointers.
  *
- * @param pool
  * @param blk
  * @return bplib_mpool_ref_t*
  */
@@ -73,7 +72,6 @@ bplib_mpool_ref_t bplib_mpool_ref_from_block(bplib_mpool_block_t *rblk);
  * This decrements the reference count, and if the reference count reaches 0, it also recycles the
  * original object.
  *
- * @param pool
  * @param refptr
  */
 void bplib_mpool_ref_release(bplib_mpool_ref_t refptr);
@@ -91,8 +89,8 @@ void bplib_mpool_ref_release(bplib_mpool_ref_t refptr);
  * @note This increments the refcount, so the calling application should call
  * bplib_mpool_ref_release() on the original ref if it does not keep it.
  *
- * @param pool
- * @param blk
+ * @param refptr
+ * @param magic_number
  * @param init_arg Opaque pointer to pass to initializer (may be NULL)
  * @return bplib_mpool_block_t*
  */

mpool/src/v7_mpool_internal.h

@@ -223,7 +223,6 @@ static inline void bplib_mpool_lock_broadcast_signal(bplib_mpool_lock_t *lock)
  * @note  it is imperative that all calls use the same referece address (such as the head
  * of the list) when referring to the same resource for locking to work correctly.
  *
- * @param pool
  * @param resource_addr
  * @return bplib_mpool_lock_t*
  */
@@ -237,7 +236,6 @@ bplib_mpool_lock_t *bplib_mpool_lock_prepare(void *resource_addr);
  * @note  it is imperative that all calls use the same referece address (such as the head
  * of the list) when referring to the same resource for locking to work correctly.
  *
- * @param pool
  * @param resource_addr
  * @return bplib_mpool_lock_t*
  */