From: Kevin Day <kevin@kevux.org>
Date: Wed, 21 Feb 2024 03:38:31 +0000 (-0600)
Subject: Cleanup: Function documentation comments, removing or fixing invalid comments.
X-Git-Url: https://git.kevux.org/?a=commitdiff_plain;h=39a86be606986e531068602a7fed5625b7b7de05;p=fll

Cleanup: Function documentation comments, removing or fixing invalid comments.

The Doxygen wizard reported warnings that exposed these problems.
---

diff --git a/level_0/f_capability/c/capability.h b/level_0/f_capability/c/capability.h
index 72c4539..09d7eb1 100644
--- a/level_0/f_capability/c/capability.h
+++ b/level_0/f_capability/c/capability.h
@@ -892,9 +892,6 @@ extern "C" {
 /**
  * Check if capabilities support ambient, using special libcap function/macro.
  *
- * @param code
- *   The capability code.
- *
  * @return
  *   TRUE if ambient is supported.
  *   FALSE otherwise.
diff --git a/level_0/f_console/c/console.h b/level_0/f_console/c/console.h
index 2d1a2ce..e21132c 100644
--- a/level_0/f_console/c/console.h
+++ b/level_0/f_console/c/console.h
@@ -33,8 +33,8 @@ extern "C" {
  *
  * All values are appended to the environment maps.
  *
- * @param parameters
- *   The parameters to process.
+ * @param arguments
+ *   The arguments to process.
  * @param environment
  *   Maps representing the environment variable names and values.
  *   Both the name and the value strings may not be NULL terminated.
diff --git a/level_0/f_environment/c/environment.h b/level_0/f_environment/c/environment.h
index a9a9e55..e87a358 100644
--- a/level_0/f_environment/c/environment.h
+++ b/level_0/f_environment/c/environment.h
@@ -52,13 +52,9 @@ extern "C" {
  * The variable is copied into a new dynamically allocated string and is safe to alter.
  *
  * @param name
- *   The name of the environment variable to get.
+ *   The name of the environment variable to check the existence of.
  *   The name string must not contain the '=' character.
  *   The name must be NULL terminated.
- * @param value
- *   The value associated with name.
- *   The value will not be null terminated.
- *   The value will be appended (set value->used to 0 to replace).
  *
  * @return
  *   F_data_not if name.used is 0.
diff --git a/level_0/f_fss/c/fss.h b/level_0/f_fss/c/fss.h
index 6927693..9287b37 100644
--- a/level_0/f_fss/c/fss.h
+++ b/level_0/f_fss/c/fss.h
@@ -196,8 +196,6 @@ extern "C" {
  *   The string to process.
  * @param range
  *   The character at the start position will be checked against the graph.
- * @param header
- *   The header data to populate with results of this function.
  * @param state
  *   A state for providing flags and handling interrupts during long running operations.
  *
@@ -227,8 +225,6 @@ extern "C" {
  *   The string to process.
  * @param range
  *   The character at the start position will be checked against the graph.
- * @param header
- *   The header data to populate with results of this function.
  * @param state
  *   A state for providing flags and handling interrupts during long running operations.
  *
@@ -258,8 +254,6 @@ extern "C" {
  *   The string to process.
  * @param range
  *   The character at the start position will be checked against the graph.
- * @param header
- *   The header data to populate with results of this function.
  * @param state
  *   A state for providing flags and handling interrupts during long running operations.
  *
diff --git a/level_0/f_print/c/print.h b/level_0/f_print/c/print.h
index 914c337..514f030 100644
--- a/level_0/f_print/c/print.h
+++ b/level_0/f_print/c/print.h
@@ -50,7 +50,6 @@ extern "C" {
  *   The string to output.
  * @param length
  *   The total number of characters to print.
-
  * @param file
  *   The file structure containing a valid stream to output to, including standard streams such as stdout and stderr.
  *
@@ -79,7 +78,6 @@ extern "C" {
  *
  * @param character
  *   The character to verify as safe or not and then print.
-
  * @param file
  *   The file structure containing a valid stream to output to, including standard streams such as stdout and stderr.
  *
@@ -115,7 +113,6 @@ extern "C" {
  *
  * @param character
  *   The character to verify as safe or not and then print.
-
  * @param file
  *   The file structure containing a valid stream to output to, including standard streams such as stdout and stderr.
  *
@@ -171,7 +168,6 @@ extern "C" {
  *
  * @param buffer
  *   The string to output.
-
  * @param file
  *   The file structure containing a valid stream to output to, including standard streams such as stdout and stderr.
  *
@@ -204,7 +200,6 @@ extern "C" {
  *   The string to output.
  * @param range
  *   The range within the provided string to print.
-
  * @param file
  *   The file structure containing a valid stream to output to, including standard streams such as stdout and stderr.
  *
@@ -239,7 +234,6 @@ extern "C" {
  *   The string to output.
  * @param range
  *   The range within the provided string to print.
-
  * @param file
  *   The file structure containing a valid stream to output to, including standard streams such as stdout and stderr.
  *
@@ -277,7 +271,6 @@ extern "C" {
  *   The string to output.
  * @param range
  *   The range within the provided string to print.
-
  * @param file
  *   The file structure containing a valid stream to output to, including standard streams such as stdout and stderr.
  *
@@ -315,7 +308,6 @@ extern "C" {
  *   The string to output.
  * @param range
  *   The range within the provided string to print.
-
  * @param file
  *   The file structure containing a valid stream to output to, including standard streams such as stdout and stderr.
  *
@@ -350,7 +342,6 @@ extern "C" {
  *
  * @param buffer
  *   The string to output.
-
  * @param file
  *   The file structure containing a valid stream to output to, including standard streams such as stdout and stderr.
  *
@@ -386,7 +377,6 @@ extern "C" {
  *
  * @param buffer
  *   The string to output.
-
  * @param file
  *   The file structure containing a valid stream to output to, including standard streams such as stdout and stderr.
  *
@@ -422,7 +412,6 @@ extern "C" {
  *
  * @param buffer
  *   The string to output.
-
  * @param file
  *   The file structure containing a valid stream to output to, including standard streams such as stdout and stderr.
  *
@@ -465,7 +454,6 @@ extern "C" {
  * @param except
  *   An array of locations within the given string to not print.
  *   The array of locations is required/assumed to be in linear order.
-
  * @param file
  *   The file structure containing a valid stream to output to, including standard streams such as stdout and stderr.
  *
@@ -500,7 +488,6 @@ extern "C" {
  * @param except
  *   An array of locations within the given string to not print.
  *   The array of locations is required/assumed to be in linear order.
-
  * @param file
  *   The file structure containing a valid stream to output to, including standard streams such as stdout and stderr.
  *
@@ -537,7 +524,6 @@ extern "C" {
  * @param except
  *   An array of locations within the given string to not print.
  *   The array of locations is required/assumed to be in linear order.
-
  * @param file
  *   The file structure containing a valid stream to output to, including standard streams such as stdout and stderr.
  *
@@ -576,7 +562,6 @@ extern "C" {
  * @param except
  *   An array of locations within the given string to not print.
  *   The array of locations is required/assumed to be in linear order.
-
  * @param file
  *   The file structure containing a valid stream to output to, including standard streams such as stdout and stderr.
  *
@@ -618,7 +603,6 @@ extern "C" {
  * @param except
  *   An array of locations within the given string to not print.
  *   The array of locations is required/assumed to be in linear order.
-
  * @param file
  *   The file structure containing a valid stream to output to, including standard streams such as stdout and stderr.
  *
@@ -660,7 +644,6 @@ extern "C" {
  * @param except
  *   An array of locations within the given string to not print.
  *   The array of locations is required/assumed to be in linear order.
-
  * @param file
  *   The file structure containing a valid stream to output to, including standard streams such as stdout and stderr.
  *
@@ -699,7 +682,6 @@ extern "C" {
  * @param except
  *   An array of locations within the given string to not print.
  *   The array of locations is required/assumed to be in linear order.
-
  * @param file
  *   The file structure containing a valid stream to output to, including standard streams such as stdout and stderr.
  *
@@ -739,7 +721,6 @@ extern "C" {
  * @param except
  *   An array of locations within the given string to not print.
  *   The array of locations is required/assumed to be in linear order.
-
  * @param file
  *   The file structure containing a valid stream to output to, including standard streams such as stdout and stderr.
  *
@@ -779,7 +760,6 @@ extern "C" {
  * @param except
  *   An array of locations within the given string to not print.
  *   The array of locations is required/assumed to be in linear order.
-
  * @param file
  *   The file structure containing a valid stream to output to, including standard streams such as stdout and stderr.
  *
@@ -826,7 +806,6 @@ extern "C" {
  * @param except_in
  *   An array of ranges within the string to not print.
  *   The array of ranges is required/assumed to be in linear order.
-
  * @param file
  *   The file structure containing a valid stream to output to, including standard streams such as stdout and stderr.
  *
@@ -865,7 +844,6 @@ extern "C" {
  * @param except_in
  *   An array of ranges within the string to not print.
  *   The array of ranges is required/assumed to be in linear order.
-
  * @param file
  *   The file structure containing a valid stream to output to, including standard streams such as stdout and stderr.
  *
@@ -906,7 +884,6 @@ extern "C" {
  * @param except_in
  *   An array of ranges within the string to not print.
  *   The array of ranges is required/assumed to be in linear order.
-
  * @param file
  *   The file structure containing a valid stream to output to, including standard streams such as stdout and stderr.
  *
@@ -949,7 +926,6 @@ extern "C" {
  * @param except_in
  *   An array of ranges within the string to not print.
  *   The array of ranges is required/assumed to be in linear order.
-
  * @param file
  *   The file structure containing a valid stream to output to, including standard streams such as stdout and stderr.
  *
@@ -992,7 +968,6 @@ extern "C" {
  * @param except_in
  *   An array of ranges within the string to not print.
  *   The array of ranges is required/assumed to be in linear order.
-
  * @param file
  *   The file structure containing a valid stream to output to, including standard streams such as stdout and stderr.
  *
@@ -1035,7 +1010,6 @@ extern "C" {
  * @param except_in
  *   An array of ranges within the string to not print.
  *   The array of ranges is required/assumed to be in linear order.
-
  * @param file
  *   The file structure containing a valid stream to output to, including standard streams such as stdout and stderr.
  *
@@ -1078,7 +1052,6 @@ extern "C" {
  * @param except_in
  *   An array of ranges within the string to not print.
  *   The array of ranges is required/assumed to be in linear order.
-
  * @param file
  *   The file structure containing a valid stream to output to, including standard streams such as stdout and stderr.
  *
@@ -1122,7 +1095,6 @@ extern "C" {
  * @param except_in
  *   An array of ranges within the string to not print.
  *   The array of ranges is required/assumed to be in linear order.
-
  * @param file
  *   The file structure containing a valid stream to output to, including standard streams such as stdout and stderr.
  *
@@ -1214,7 +1186,6 @@ extern "C" {
  * @param except_in
  *   An array of ranges within the string to not print.
  *   The array of ranges is required/assumed to be in linear order.
-
  * @param file
  *   The file structure containing a valid stream to output to, including standard streams such as stdout and stderr.
  *
@@ -1264,7 +1235,6 @@ extern "C" {
  * @param except_in
  *   An array of ranges within the string to not print.
  *   The array of ranges is required/assumed to be in linear order.
-
  * @param file
  *   The file structure containing a valid stream to output to, including standard streams such as stdout and stderr.
  *
@@ -1314,7 +1284,6 @@ extern "C" {
  * @param except_in
  *   An array of ranges within the string to not print.
  *   The array of ranges is required/assumed to be in linear order.
-
  * @param file
  *   The file structure containing a valid stream to output to, including standard streams such as stdout and stderr.
  *
@@ -1359,7 +1328,6 @@ extern "C" {
  * @param except
  *   An array of locations within the given string to not print.
  *   The array of locations is required/assumed to be in linear order.
-
  * @param file
  *   The file structure containing a valid stream to output to, including standard streams such as stdout and stderr.
  *
@@ -1403,7 +1371,6 @@ extern "C" {
  * @param except
  *   An array of locations within the given string to not print.
  *   The array of locations is required/assumed to be in linear order.
-
  * @param file
  *   The file structure containing a valid stream to output to, including standard streams such as stdout and stderr.
  *
@@ -1447,7 +1414,6 @@ extern "C" {
  * @param except
  *   An array of locations within the given string to not print.
  *   The array of locations is required/assumed to be in linear order.
-
  * @param file
  *   The file structure containing a valid stream to output to, including standard streams such as stdout and stderr.
  *
@@ -1484,7 +1450,6 @@ extern "C" {
  *   The string to output.
  * @param length
  *   The total number of characters to print.
-
  * @param file
  *   The file structure containing a valid stream to output to, including standard streams such as stdout and stderr.
  *
@@ -1522,7 +1487,6 @@ extern "C" {
  *   The string to output.
  * @param length
  *   The total number of characters to print.
-
  * @param file
  *   The file structure containing a valid stream to output to, including standard streams such as stdout and stderr.
  *
@@ -1555,7 +1519,6 @@ extern "C" {
  *
  * @param string
  *   The string to output.
-
  * @param file
  *   The file structure containing a valid stream to output to, including standard streams such as stdout and stderr.
  *
@@ -1591,7 +1554,6 @@ extern "C" {
  *   The string to output.
  * @param length
  *   The total number of characters to print.
-
  * @param file
  *   The file structure containing a valid stream to output to, including standard streams such as stdout and stderr.
  *
@@ -1688,7 +1650,6 @@ extern "C" {
  *
  * @param string
  *   The string to output.
-
  * @param file
  *   The file structure containing a valid stream to output to, including standard streams such as stdout and stderr.
  *
diff --git a/level_0/f_string/c/string/static.h b/level_0/f_string/c/string/static.h
index dbdcf63..7da2489 100644
--- a/level_0/f_string/c/string/static.h
+++ b/level_0/f_string/c/string/static.h
@@ -1290,7 +1290,7 @@ extern "C" {
 
 /**
  * Define the end of line character.
- * FLL forbids '\r' and '\r\n' as end of line characters, \r will be silently ignored.
+ * FLL forbids '\r' and '\r\n' as end of line characters, '\r' will be silently ignored.
  */
 #ifndef _di_f_string_eol_s_
   #define f_string_eol_s f_string_ascii_feed_line_s
diff --git a/level_0/f_thread/c/thread.h b/level_0/f_thread/c/thread.h
index 64f4f76..dec9e6e 100644
--- a/level_0/f_thread/c/thread.h
+++ b/level_0/f_thread/c/thread.h
@@ -58,7 +58,7 @@ extern "C" {
  *   The function to call before forking.
  * @param after_parent
  *   The function called after forking, for the parent process.
- * @param child_parent
+ * @param after_child
  *   The function called after forking, for the child process.
  *
  * @return
@@ -2101,6 +2101,8 @@ extern "C" {
  *
  * Subsequent calls will not call the given routine.
  *
+ * @param routine
+ *   The callback.
  * @param once
  *   The once variable designating that the given routine will be called only once.
  *
diff --git a/level_1/fl_control_group/c/control_group.h b/level_1/fl_control_group/c/control_group.h
index 4537c6b..b38e1d5 100644
--- a/level_1/fl_control_group/c/control_group.h
+++ b/level_1/fl_control_group/c/control_group.h
@@ -41,7 +41,7 @@ extern "C" {
 /**
  * Apply the given control groups to the process represented by the PID.
  *
- * @param control
+ * @param control_group
  *   The control group(s) to apply.
  * @param id
  *   The PID of the process to apply the control group(s) to.
diff --git a/level_1/fl_print/c/print.h b/level_1/fl_print/c/print.h
index 767d592..3f6a6a7 100644
--- a/level_1/fl_print/c/print.h
+++ b/level_1/fl_print/c/print.h
@@ -1475,8 +1475,6 @@ extern "C" {
  *
  * @param buffer
  *   The string to output.
- * @param offset
- *   The inclusive start point to start printing.
  * @param except_at
  *   An array of locations within the given string to not print.
  *   The array of locations is required/assumed to be in linear order.
diff --git a/level_1/fl_utf_file/c/utf_file.h b/level_1/fl_utf_file/c/utf_file.h
index 33b7bd7..106772b 100644
--- a/level_1/fl_utf_file/c/utf_file.h
+++ b/level_1/fl_utf_file/c/utf_file.h
@@ -237,8 +237,8 @@ extern "C" {
  * @param file
  *   The file to write to.
  *   The file must already be open.
- * @param destination
- *   The destination to write to the file.
+ * @param buffer
+ *   The string to write to the file.
  * @param range
  *   An inclusive start an stop range within the destination to read.
  * @param written
diff --git a/level_2/fll_control_group/c/control_group.h b/level_2/fll_control_group/c/control_group.h
index 2b090fe..8a3b3dd 100644
--- a/level_2/fll_control_group/c/control_group.h
+++ b/level_2/fll_control_group/c/control_group.h
@@ -36,7 +36,7 @@ extern "C" {
  *
  * This does not, however, create the control_group.path and will error out if that directory does not exist.
  *
- * @param control
+ * @param control_group
  *   The control group(s) to ensure the directories exist.
  *
  * @return
diff --git a/level_2/fll_print/c/print.h b/level_2/fll_print/c/print.h
index f1482e6..1eca3f9 100644
--- a/level_2/fll_print/c/print.h
+++ b/level_2/fll_print/c/print.h
@@ -1205,8 +1205,6 @@ extern "C" {
  *
  * @param string
  *   The string to output.
- * @param length
- *   The total number of characters to print.
  * @param file
  *   The file structure containing a valid stream to output to, including standard streams such as stdout and stderr.
  *