docs: fix a number of problems in the function header comments

Reported-by: Brian Cain <brian.cain@gmail.com>
Signed-off-by: Paul Moore <pmoore@redhat.com>
(imported from commit 0cd288bee5879af3aab6c447de55c90d4971e38c)

5 files changed, 10 insertions, 12 deletions

diff --git a/src/api.c b/src/api.c
index 684c0e7..182b896 100644
--- a/src/api.c
+++ b/src/api.c
@@ -380,7 +380,7 @@ syscall_priority_failure:
  * @param action the filter action
  * @param syscall the syscall number
  * @param arg_cnt the number of argument filters in the argument filter chain
- * @param arg_list the argument filter chain, (uint, enum scmp_compare, ulong)
+ * @param arg_array the argument filter chain, (uint, enum scmp_compare, ulong)
  *
  * This function adds a new argument/comparison/value to the seccomp filter for
  * a syscall; multiple arguments can be specified and they will be chained
diff --git a/src/arch.c b/src/arch.c
index e29b579..9681115 100644
--- a/src/arch.c
+++ b/src/arch.c
@@ -129,7 +129,7 @@ const struct arch_def *arch_def_lookup(uint32_t token)
 
 /**
  * Lookup the architecture definition by name
- * @param arch the architecure name
+ * @param arch_name the architecure name
  *
  * Return the matching architecture definition, returns NULL on failure.
  *
diff --git a/src/db.c b/src/db.c
index 9923442..ab079db 100644
--- a/src/db.c
+++ b/src/db.c
@@ -72,10 +72,9 @@ static unsigned int __db_tree_free(struct db_arg_chain_tree *tree)
 
 /**
  * Free a syscall filter argument chain tree
- * @param list the argument chain list
+ * @param tree the argument chain list
  *
- * This function frees a syscall argument chain list and returns the number of
- * nodes freed.
+ * This function frees a tree and returns the number of nodes freed.
  *
  */
 static unsigned int _db_tree_free(struct db_arg_chain_tree *tree)
@@ -576,7 +575,7 @@ int db_col_attr_get(const struct db_filter_col *col,
 
 /**
  * Set a filter attribute
- * @param db the seccomp filter collection
+ * @param col the seccomp filter collection
  * @param attr the filter attribute
  * @param value the filter attribute value
  *
@@ -699,7 +698,6 @@ int db_col_db_remove(struct db_filter_col *col, uint32_t arch_token)
 /**
  * Free and reset the seccomp filter DB
  * @param db the seccomp filter DB
- * @param def_action the default filter action
  *
  * This function frees any existing filters and resets the filter DB to a
  * default state; only the DB architecture is preserved.
diff --git a/src/gen_bpf.c b/src/gen_bpf.c
index 175bf6b..452d954 100644
--- a/src/gen_bpf.c
+++ b/src/gen_bpf.c
@@ -516,7 +516,7 @@ static void _program_free(struct bpf_program *prg)
 
 /**
  * Free the BPF state
- * @param the BPF state
+ * @param state the BPF state
  *
  * Free all of the BPF state, including the BPF program if present.
  *
@@ -1943,7 +1943,7 @@ bpf_generate_end:
 
 /**
  * Free memory associated with a BPF representation
- * @param fprog the BPF representation
+ * @param program the BPF representation
  *
  * Free the memory associated with a BPF representation generated by the
  * gen_bpf_generate() function.
diff --git a/src/hash.c b/src/hash.c
index cb52b3b..1228307 100644
--- a/src/hash.c
+++ b/src/hash.c
@@ -189,7 +189,7 @@ static uint32_t jhash_word(const uint32_t *k, size_t length, uint32_t initval)
 
 /**
  * Hash a variable-length key into a 32-bit value
- * @param k the key (the unaligned variable-length array of bytes)
+ * @param key the key (the unaligned variable-length array of bytes)
  * @param length the length of the key, counting by bytes
  * @param initval can be any 4-byte value
  *
@@ -456,7 +456,7 @@ static uint32_t jhash_le(const void *key, size_t length, uint32_t initval)
 
 /**
  * Hash a variable-length key into a 32-bit value
- * @param k the key (the unaligned variable-length array of bytes)
+ * @param key the key (the unaligned variable-length array of bytes)
  * @param length the length of the key, counting by bytes
  * @param initval can be any 4-byte value
  *
@@ -655,7 +655,7 @@ static uint32_t jhash_be( const void *key, size_t length, uint32_t initval)
 
 /**
  * Hash a variable-length key into a 32-bit value
- * @param k the key (the unaligned variable-length array of bytes)
+ * @param key the key (the unaligned variable-length array of bytes)
  * @param length the length of the key, counting by bytes
  * @param initval can be any 4-byte value
  *