From 1ae9990bd6e45b0f7c6467d8638fca6872b336be Mon Sep 17 00:00:00 2001 From: Kevin Day Date: Sun, 2 Jun 2024 10:44:32 -0500 Subject: [PATCH] Cleanup: Add newline before NULL comment and add dash to de-allocate. The "Must not be NULL." documentation comments are not consistently structured. I don't remember which decision I made and so now I am just forcibly setting the same structure with a new line before it. Improve grammar by adding a dash to de-allocate. --- level_0/f_abstruse/c/abstruse/abstruse.h | 4 + level_0/f_abstruse/c/abstruse/map.h | 4 + level_0/f_account/c/account/accounts.h | 4 + level_0/f_capability/c/capability.h | 3 + level_0/f_console/c/console.h | 1 + level_0/f_directory/c/directory/listing.h | 4 + level_0/f_directory/c/directory/recurse_do.h | 4 + level_0/f_directory/c/directory/status.h | 4 + level_0/f_file/c/file.h | 12 +++ level_0/f_file/c/file/stream.h | 4 + level_0/f_fss/c/fss/item.h | 4 + level_0/f_fss/c/fss/named.h | 4 + level_0/f_fss/c/fss/nest.h | 4 + level_0/f_fss/c/fss/set.h | 4 + level_0/f_fss/c/fss/set_quote.h | 4 + level_0/f_fss/c/fss/simple_packet.h | 9 ++ level_0/f_iki/c/iki/data.h | 4 + level_0/f_limit/c/limit/set.h | 2 + level_0/f_limit/c/limit/value.h | 2 + level_0/f_memory/c/memory/common.h | 4 +- level_0/f_parse/c/parse.h | 1 + level_0/f_signal/c/signal.h | 6 ++ level_0/f_socket/c/socket.h | 4 + level_0/f_socket/c/socket/address.h | 2 + level_0/f_socket/c/socket/socket.h | 2 + level_0/f_string/c/string/common.h | 2 +- level_0/f_string/c/string/dynamics.h | 2 + level_0/f_string/c/string/dynamicss.h | 2 + level_0/f_string/c/string/map_multis.h | 2 + level_0/f_string/c/string/map_multiss.h | 2 + level_0/f_string/c/string/maps.h | 2 + level_0/f_string/c/string/mapss.h | 2 + level_0/f_string/c/string/triples.h | 2 + level_0/f_string/c/string/tripless.h | 2 + level_0/f_thread/c/thread.h | 118 +++++++++++++++++++++ level_0/f_thread/c/thread/attribute.h | 4 + level_0/f_thread/c/thread/barrier.h | 4 + level_0/f_thread/c/thread/barrier_attribute.h | 4 + level_0/f_thread/c/thread/condition.h | 4 + level_0/f_thread/c/thread/condition_attribute.h | 4 + level_0/f_thread/c/thread/key.h | 4 + level_0/f_thread/c/thread/lock.h | 4 + level_0/f_thread/c/thread/lock_attribute.h | 4 + level_0/f_thread/c/thread/mutex.h | 4 + level_0/f_thread/c/thread/mutex_attribute.h | 4 + level_0/f_thread/c/thread/semaphore.h | 4 + level_0/f_thread/c/thread/set.h | 4 + level_0/f_thread/c/thread/spin.h | 4 + level_0/f_time/c/time.h | 1 + level_0/f_type_array/c/type_array/cell.h | 2 + level_0/f_type_array/c/type_array/file.h | 2 + level_0/f_type_array/c/type_array/fll_id.h | 4 + level_0/f_type_array/c/type_array/int128.h | 2 + level_0/f_type_array/c/type_array/int16.h | 2 + level_0/f_type_array/c/type_array/int32.h | 2 + level_0/f_type_array/c/type_array/int64.h | 2 + level_0/f_type_array/c/type_array/int8.h | 2 + level_0/f_type_array/c/type_array/number_signed.h | 2 + .../f_type_array/c/type_array/number_unsigned.h | 2 + level_0/f_type_array/c/type_array/poll.h | 2 + level_0/f_type_array/c/type_array/range_doubless.h | 2 + level_0/f_type_array/c/type_array/rangess.h | 2 + level_0/f_type_array/c/type_array/state.h | 2 + level_0/f_type_array/c/type_array/status.h | 2 + level_0/f_type_array/c/type_array/uint128.h | 2 + level_0/f_type_array/c/type_array/uint16.h | 2 + level_0/f_type_array/c/type_array/uint32.h | 2 + level_0/f_type_array/c/type_array/uint64.h | 2 + level_0/f_type_array/c/type_array/uint8.h | 2 + level_0/f_utf/c/utf/dynamics.h | 2 + level_0/f_utf/c/utf/dynamicss.h | 2 + level_0/f_utf/c/utf/is.h | 2 + level_0/f_utf/c/utf/is_character.h | 2 + level_0/f_utf/c/utf/map_multis.h | 2 + level_0/f_utf/c/utf/map_multiss.h | 2 + level_0/f_utf/c/utf/maps.h | 2 + level_0/f_utf/c/utf/mapss.h | 2 + level_0/f_utf/c/utf/static.h | 2 +- level_0/f_utf/c/utf/triples.h | 2 + level_0/f_utf/c/utf/tripless.h | 2 + level_1/fl_fss/c/fss/basic.h | 1 + level_1/fl_fss/c/fss/basic_list.h | 1 + level_1/fl_fss/c/fss/embedded_list.h | 2 + level_1/fl_fss/c/fss/extended.h | 2 + level_1/fl_fss/c/fss/extended_list.h | 2 + level_1/fl_fss/c/private-fss.h | 2 + level_2/fll_execute/c/execute.h | 1 + level_2/fll_fss/c/fss.h | 21 ++++ level_2/fll_fss/c/fss/basic.h | 1 + level_2/fll_fss/c/fss/basic_list.h | 1 + level_2/fll_fss/c/fss/embedded_list.h | 2 + level_2/fll_fss/c/fss/extended.h | 2 + level_2/fll_fss/c/fss/extended_list.h | 2 + level_2/fll_fss/c/fss/payload.h | 1 + level_2/fll_print/c/print.h | 1 + level_2/fll_program/c/program.h | 1 + level_2/fll_program/c/program/common.h | 1 + level_3/byte_dump/c/main/common/type.h | 2 +- level_3/controller/c/common.h | 50 ++++----- level_3/controller/c/common/private-cache.h | 8 +- level_3/controller/c/common/private-lock.h | 4 +- level_3/controller/c/common/private-process.h | 8 +- level_3/controller/c/common/private-thread.h | 4 +- level_3/controller/c/process/private-process.h | 2 + level_3/controller/c/thread/private-thread.c | 6 +- .../controller/c/thread/private-thread_control.c | 4 +- level_3/controller/c/thread/private-thread_entry.c | 8 +- .../controller/c/thread/private-thread_process.c | 4 +- level_3/example/c/main/common/type.h | 4 +- level_3/fake/c/main/common/type.h | 8 +- level_3/firewall/c/main/common/type.h | 6 +- level_3/fss_identify/c/main/common/type.h | 2 +- level_3/fss_read/c/main/common/type.h | 6 +- level_3/fss_write/c/main/common/type.h | 2 +- level_3/iki_read/c/main/common/type.h | 2 +- level_3/iki_write/c/main/common/type.h | 2 +- level_3/status_code/c/main/common/type.h | 2 +- level_3/utf8/c/main/common/type.h | 2 +- 118 files changed, 462 insertions(+), 71 deletions(-) diff --git a/level_0/f_abstruse/c/abstruse/abstruse.h b/level_0/f_abstruse/c/abstruse/abstruse.h index 278082a..5ded859 100644 --- a/level_0/f_abstruse/c/abstruse/abstruse.h +++ b/level_0/f_abstruse/c/abstruse/abstruse.h @@ -216,6 +216,7 @@ extern "C" { * The exclusive stop position in the array to stop deleting. * @param array * The array structure to delete all values of. + * * Must not be NULL. * * @return @@ -269,6 +270,7 @@ extern "C" { * The exclusive stop position in the array to stop deleting. * @param array * The array structure to delete all values of. + * * Must not be NULL. * * @return @@ -322,6 +324,7 @@ extern "C" { * The exclusive stop position in the array to stop deleting. * @param array * The array structure to delete all values of. + * * Must not be NULL. * * @return @@ -375,6 +378,7 @@ extern "C" { * The exclusive stop position in the array to stop deleting. * @param array * The array structure to delete all values of. + * * Must not be NULL. * * @return diff --git a/level_0/f_abstruse/c/abstruse/map.h b/level_0/f_abstruse/c/abstruse/map.h index 8ca88de..f2d8bf3 100644 --- a/level_0/f_abstruse/c/abstruse/map.h +++ b/level_0/f_abstruse/c/abstruse/map.h @@ -183,6 +183,7 @@ extern "C" { * The exclusive stop position in the array to stop deleting. * @param array * The array structure to delete all values of. + * * Must not be NULL. * * @return @@ -211,6 +212,7 @@ extern "C" { * The exclusive stop position in the array to stop deleting. * @param array * The array structure to delete all values of. + * * Must not be NULL. * * @return @@ -239,6 +241,7 @@ extern "C" { * The exclusive stop position in the array to stop deleting. * @param array * The array structure to delete all values of. + * * Must not be NULL. * * @return @@ -267,6 +270,7 @@ extern "C" { * The exclusive stop position in the array to stop deleting. * @param array * The array structure to delete all values of. + * * Must not be NULL. * * @return diff --git a/level_0/f_account/c/account/accounts.h b/level_0/f_account/c/account/accounts.h index febf5de..5dd8d83 100644 --- a/level_0/f_account/c/account/accounts.h +++ b/level_0/f_account/c/account/accounts.h @@ -67,6 +67,7 @@ extern "C" { * The exclusive stop position in the array to stop deleting. * @param array * The array structure to delete all values of. + * * Must not be NULL. * * @return @@ -95,6 +96,7 @@ extern "C" { * The exclusive stop position in the array to stop deleting. * @param array * The array structure to delete all values of. + * * Must not be NULL. * * @return @@ -123,6 +125,7 @@ extern "C" { * The exclusive stop position in the array to stop deleting. * @param array * The array structure to delete all values of. + * * Must not be NULL. * * @return @@ -153,6 +156,7 @@ extern "C" { * The exclusive stop position in the array to stop deleting. * @param array * The array structure to delete all values of. + * * Must not be NULL. * * @return diff --git a/level_0/f_capability/c/capability.h b/level_0/f_capability/c/capability.h index 66cdfe3..c4bb771 100644 --- a/level_0/f_capability/c/capability.h +++ b/level_0/f_capability/c/capability.h @@ -166,6 +166,7 @@ extern "C" { * The second capability to compare. * @param flags * (optional) This represents which of the flags that differ on miss. + * * Set to NULL to not use. * * @return @@ -219,6 +220,7 @@ extern "C" { * The (external) capability the (internal) capability is copied to. * @param size * (optional) The size (in bytes) copied into the (external) capability. + * * Set to NULL to not use. * * @return @@ -466,6 +468,7 @@ extern "C" { * The name of the capability (must be all lower case). * @param code * (optional) The determined code. + * * Set to NULL to not use. * * @return diff --git a/level_0/f_console/c/console.h b/level_0/f_console/c/console.h index e21132c..51fbaab 100644 --- a/level_0/f_console/c/console.h +++ b/level_0/f_console/c/console.h @@ -176,6 +176,7 @@ extern "C" { * Errors (with error bit) from: f_utf_char_to_character(). * @param data * (optional) A variable passed to the callback, if provided. + * * Set to NULL to not use. * * @see f_memory_array_increase_by() diff --git a/level_0/f_directory/c/directory/listing.h b/level_0/f_directory/c/directory/listing.h index 7362ca3..d1f1673 100644 --- a/level_0/f_directory/c/directory/listing.h +++ b/level_0/f_directory/c/directory/listing.h @@ -163,6 +163,7 @@ extern "C" { * The exclusive stop position in the array to stop deleting. * @param array * The array structure to delete all values of. + * * Must not be NULL. * * @return @@ -191,6 +192,7 @@ extern "C" { * The exclusive stop position in the array to stop deleting. * @param array * The array structure to delete all values of. + * * Must not be NULL. * * @return @@ -219,6 +221,7 @@ extern "C" { * The exclusive stop position in the array to stop deleting. * @param array * The array structure to delete all values of. + * * Must not be NULL. * * @return @@ -247,6 +250,7 @@ extern "C" { * The exclusive stop position in the array to stop deleting. * @param array * The array structure to delete all values of. + * * Must not be NULL. * * @return diff --git a/level_0/f_directory/c/directory/recurse_do.h b/level_0/f_directory/c/directory/recurse_do.h index 30bd987..4026d5f 100644 --- a/level_0/f_directory/c/directory/recurse_do.h +++ b/level_0/f_directory/c/directory/recurse_do.h @@ -214,6 +214,7 @@ extern "C" { * The exclusive stop position in the array to stop deleting. * @param array * The array structure to delete all values of. + * * Must not be NULL. * * @return @@ -242,6 +243,7 @@ extern "C" { * The exclusive stop position in the array to stop deleting. * @param array * The array structure to delete all values of. + * * Must not be NULL. * * @return @@ -270,6 +272,7 @@ extern "C" { * The exclusive stop position in the array to stop deleting. * @param array * The array structure to delete all values of. + * * Must not be NULL. * * @return @@ -298,6 +301,7 @@ extern "C" { * The exclusive stop position in the array to stop deleting. * @param array * The array structure to delete all values of. + * * Must not be NULL. * * @return diff --git a/level_0/f_directory/c/directory/status.h b/level_0/f_directory/c/directory/status.h index 60d36a6..5accf9e 100644 --- a/level_0/f_directory/c/directory/status.h +++ b/level_0/f_directory/c/directory/status.h @@ -100,6 +100,7 @@ extern "C" { * The exclusive stop position in the array to stop deleting. * @param array * The array structure to delete all values of. + * * Must not be NULL. * * @return @@ -128,6 +129,7 @@ extern "C" { * The exclusive stop position in the array to stop deleting. * @param array * The array structure to delete all values of. + * * Must not be NULL. * * @return @@ -156,6 +158,7 @@ extern "C" { * The exclusive stop position in the array to stop deleting. * @param array * The array structure to delete all values of. + * * Must not be NULL. * * @return @@ -184,6 +187,7 @@ extern "C" { * The exclusive stop position in the array to stop deleting. * @param array * The array structure to delete all values of. + * * Must not be NULL. * * @return diff --git a/level_0/f_file/c/file.h b/level_0/f_file/c/file.h index d3fbc55..7c0335e 100644 --- a/level_0/f_file/c/file.h +++ b/level_0/f_file/c/file.h @@ -1997,15 +1997,19 @@ extern "C" { * This cannot be 0. * @param read * (optional) The set of file descriptors for descriptors that become available for reading. + * * Set to NULL to not use. * @param write * (optional) The set of file descriptors for descriptors that become available for writing. + * * Set to NULL to not use. * @param except * (optional) The set of file descriptors for descriptors that become available for any error conditions. + * * Set to NULL to not use. * @param timeout * (optional) The time to wait before returning. + * * Set to NULL to not use. * * @return @@ -2037,15 +2041,19 @@ extern "C" { * This cannot be 0. * @param read * (optional) The set of file descriptors for descriptors that become available for reading. + * * Set to NULL to not use. * @param write * (optional) The set of file descriptors for descriptors that become available for writing. + * * Set to NULL to not use. * @param except * (optional) The set of file descriptors for descriptors that become available for any error conditions. + * * Set to NULL to not use. * @param timeout * (optional) The time to wait before returning. + * * Set to NULL to not use. * @param signal * (optional) The signals to atomically mask while running the pselect() operation. @@ -2455,6 +2463,7 @@ extern "C" { * The buffer to write to the file. * @param written * (optional) The total bytes written. + * * Set to NULL to not use. * * @return @@ -2489,6 +2498,7 @@ extern "C" { * The buffer to write to the file. * @param written * (optional) The total bytes written. + * * Set to NULL to not use. * * @return @@ -2524,6 +2534,7 @@ extern "C" { * The total bytes to write, unless end of buffer is reached first. * @param written * (optional) The total bytes written. + * * Set to NULL to not use. * * @return @@ -2559,6 +2570,7 @@ extern "C" { * An inclusive start an stop range within the buffer to read. * @param written * (optional) The total bytes written. + * * Set to NULL to not use. * * @return diff --git a/level_0/f_file/c/file/stream.h b/level_0/f_file/c/file/stream.h index 7161bb4..82e62c6 100644 --- a/level_0/f_file/c/file/stream.h +++ b/level_0/f_file/c/file/stream.h @@ -396,6 +396,7 @@ extern "C" { * The buffer to write to the file. * @param written * (optional) The total bytes written. + * * Set to NULL to not use. * * @return @@ -432,6 +433,7 @@ extern "C" { * The buffer to write to the file. * @param written * (optional) The total bytes written. + * * Set to NULL to not use. * * @return @@ -468,6 +470,7 @@ extern "C" { * The total bytes to write, unless end of buffer is reached first. * @param written * (optional) The total bytes written. + * * Set to NULL to not use. * * @return @@ -504,6 +507,7 @@ extern "C" { * An inclusive start an stop range within the buffer to read. * @param written * (optional) The total bytes written. + * * Set to NULL to not use. * * @return diff --git a/level_0/f_fss/c/fss/item.h b/level_0/f_fss/c/fss/item.h index e866d26..6620cdd 100644 --- a/level_0/f_fss/c/fss/item.h +++ b/level_0/f_fss/c/fss/item.h @@ -166,6 +166,7 @@ extern "C" { * The exclusive stop position in the array to stop deleting. * @param array * The array structure to delete all values of. + * * Must not be NULL. * * @return @@ -194,6 +195,7 @@ extern "C" { * The exclusive stop position in the array to stop deleting. * @param array * The array structure to delete all values of. + * * Must not be NULL. * * @return @@ -222,6 +224,7 @@ extern "C" { * The exclusive stop position in the array to stop deleting. * @param array * The array structure to delete all values of. + * * Must not be NULL. * * @return @@ -250,6 +253,7 @@ extern "C" { * The exclusive stop position in the array to stop deleting. * @param array * The array structure to delete all values of. + * * Must not be NULL. * * @return diff --git a/level_0/f_fss/c/fss/named.h b/level_0/f_fss/c/fss/named.h index 096dd97..af3fdc3 100644 --- a/level_0/f_fss/c/fss/named.h +++ b/level_0/f_fss/c/fss/named.h @@ -152,6 +152,7 @@ extern "C" { * The exclusive stop position in the array to stop deleting. * @param array * The array structure to delete all values of. + * * Must not be NULL. * * @return @@ -182,6 +183,7 @@ extern "C" { * The exclusive stop position in the array to stop deleting. * @param array * The array structure to delete all values of. + * * Must not be NULL. * * @return @@ -212,6 +214,7 @@ extern "C" { * The exclusive stop position in the array to stop deleting. * @param array * The array structure to delete all values of. + * * Must not be NULL. * * @return @@ -242,6 +245,7 @@ extern "C" { * The exclusive stop position in the array to stop deleting. * @param array * The array structure to delete all values of. + * * Must not be NULL. * * @return diff --git a/level_0/f_fss/c/fss/nest.h b/level_0/f_fss/c/fss/nest.h index 05e1a38..b1b94db 100644 --- a/level_0/f_fss/c/fss/nest.h +++ b/level_0/f_fss/c/fss/nest.h @@ -143,6 +143,7 @@ extern "C" { * The exclusive stop position in the array to stop deleting. * @param array * The array structure to delete all values of. + * * Must not be NULL. * * @return @@ -171,6 +172,7 @@ extern "C" { * The exclusive stop position in the array to stop deleting. * @param array * The array structure to delete all values of. + * * Must not be NULL. * * @return @@ -199,6 +201,7 @@ extern "C" { * The exclusive stop position in the array to stop deleting. * @param array * The array structure to delete all values of. + * * Must not be NULL. * * @return @@ -227,6 +230,7 @@ extern "C" { * The exclusive stop position in the array to stop deleting. * @param array * The array structure to delete all values of. + * * Must not be NULL. * * @return diff --git a/level_0/f_fss/c/fss/set.h b/level_0/f_fss/c/fss/set.h index 5572155..8d239d4 100644 --- a/level_0/f_fss/c/fss/set.h +++ b/level_0/f_fss/c/fss/set.h @@ -144,6 +144,7 @@ extern "C" { * The exclusive stop position in the array to stop deleting. * @param array * The array structure to delete all values of. + * * Must not be NULL. * * @return @@ -174,6 +175,7 @@ extern "C" { * The exclusive stop position in the array to stop deleting. * @param array * The array structure to delete all values of. + * * Must not be NULL. * * @return @@ -204,6 +206,7 @@ extern "C" { * The exclusive stop position in the array to stop deleting. * @param array * The array structure to delete all values of. + * * Must not be NULL. * * @return @@ -234,6 +237,7 @@ extern "C" { * The exclusive stop position in the array to stop deleting. * @param array * The array structure to delete all values of. + * * Must not be NULL. * * @return diff --git a/level_0/f_fss/c/fss/set_quote.h b/level_0/f_fss/c/fss/set_quote.h index 53abde6..a1147ad 100644 --- a/level_0/f_fss/c/fss/set_quote.h +++ b/level_0/f_fss/c/fss/set_quote.h @@ -151,6 +151,7 @@ extern "C" { * The exclusive stop position in the array to stop deleting. * @param array * The array structure to delete all values of. + * * Must not be NULL. * * @return @@ -181,6 +182,7 @@ extern "C" { * The exclusive stop position in the array to stop deleting. * @param array * The array structure to delete all values of. + * * Must not be NULL. * * @return @@ -211,6 +213,7 @@ extern "C" { * The exclusive stop position in the array to stop deleting. * @param array * The array structure to delete all values of. + * * Must not be NULL. * * @return @@ -241,6 +244,7 @@ extern "C" { * The exclusive stop position in the array to stop deleting. * @param array * The array structure to delete all values of. + * * Must not be NULL. * * @return diff --git a/level_0/f_fss/c/fss/simple_packet.h b/level_0/f_fss/c/fss/simple_packet.h index 22bbf1f..0890807 100644 --- a/level_0/f_fss/c/fss/simple_packet.h +++ b/level_0/f_fss/c/fss/simple_packet.h @@ -210,6 +210,7 @@ extern "C" { * @param packet * The packet extracted from the given buffer, without doing anything to the payload. * The caller can allocate the payload and extract it at any time by just selecting the string from F_fss_simple_packet_block_header_size_d until at most F_fss_simple_packet_block_payload_size_d. + * * Must not be NULL. * * @return @@ -233,6 +234,7 @@ extern "C" { * This buffer is considered binary data and so any NULL found within is treated as a valid part of the buffer. * @param packet * The packet range extracted from the given buffer, with the payload being represented by a range. + * * Must not be NULL. * * @return @@ -251,6 +253,7 @@ extern "C" { * * @param simple_packet * The FSS-000F (Simple Packet) to delete. + * * Must not be NULL. * * @return @@ -273,6 +276,7 @@ extern "C" { * * @param simple_packet * The FSS-000F (Simple Packet) to destroy. + * * Must not be NULL. * * @return @@ -301,6 +305,7 @@ extern "C" { * The size to encode into the size block. * @param destination * The string buffer to encode the packet parts into. + * * Must not be NULL. * * @return @@ -329,6 +334,7 @@ extern "C" { * The exclusive stop position in the array to stop deleting. * @param array * The array structure to delete all values of. + * * Must not be NULL. * * @return @@ -357,6 +363,7 @@ extern "C" { * The exclusive stop position in the array to stop deleting. * @param array * The array structure to delete all values of. + * * Must not be NULL. * * @return @@ -385,6 +392,7 @@ extern "C" { * The exclusive stop position in the array to stop deleting. * @param array * The array structure to delete all values of. + * * Must not be NULL. * * @return @@ -413,6 +421,7 @@ extern "C" { * The exclusive stop position in the array to stop deleting. * @param array * The array structure to delete all values of. + * * Must not be NULL. * * @return diff --git a/level_0/f_iki/c/iki/data.h b/level_0/f_iki/c/iki/data.h index 7241899..3d2e0f6 100644 --- a/level_0/f_iki/c/iki/data.h +++ b/level_0/f_iki/c/iki/data.h @@ -119,6 +119,7 @@ extern "C" { * The exclusive stop position in the array to stop deleting. * @param array * The array structure to delete all values of. + * * Must not be NULL. * * @return @@ -148,6 +149,7 @@ extern "C" { * The exclusive stop position in the array to stop deleting. * @param array * The array structure to delete all values of. + * * Must not be NULL. * * @return @@ -225,6 +227,7 @@ extern "C" { * The exclusive stop position in the array to stop deleting. * @param array * The array structure to delete all values of. + * * Must not be NULL. * * @return @@ -253,6 +256,7 @@ extern "C" { * The exclusive stop position in the array to stop deleting. * @param array * The array structure to delete all values of. + * * Must not be NULL. * * @return diff --git a/level_0/f_limit/c/limit/set.h b/level_0/f_limit/c/limit/set.h index 29df683..4e42835 100644 --- a/level_0/f_limit/c/limit/set.h +++ b/level_0/f_limit/c/limit/set.h @@ -95,6 +95,7 @@ extern "C" { * The exclusive stop position in the array to stop deleting. * @param array * The array structure to delete all values of. + * * Must not be NULL. * * @return @@ -123,6 +124,7 @@ extern "C" { * The exclusive stop position in the array to stop deleting. * @param array * The array structure to delete all values of. + * * Must not be NULL. * * @return diff --git a/level_0/f_limit/c/limit/value.h b/level_0/f_limit/c/limit/value.h index 92a0000..8036458 100644 --- a/level_0/f_limit/c/limit/value.h +++ b/level_0/f_limit/c/limit/value.h @@ -91,6 +91,7 @@ extern "C" { * The exclusive stop position in the array to stop deleting. * @param array * The array structure to delete all values of. + * * Must not be NULL. * * @return @@ -119,6 +120,7 @@ extern "C" { * The exclusive stop position in the array to stop deleting. * @param array * The array structure to delete all values of. + * * Must not be NULL. * * @return diff --git a/level_0/f_memory/c/memory/common.h b/level_0/f_memory/c/memory/common.h index 2b018a7..5e28463 100644 --- a/level_0/f_memory/c/memory/common.h +++ b/level_0/f_memory/c/memory/common.h @@ -19,8 +19,8 @@ extern "C" { /** * Check to make sure these two macros are not defined at the same time. * - * If _f_memory_FORCE_secure_memory_ is defined, then all to-be deallocated address spaces are set to 0 before freeing or resizing. - * If _f_memory_FORCE_fast_memory_ is defined, then all to-be deallocated address spaces remain unchanged before freeing or resizing. + * If _f_memory_FORCE_secure_memory_ is defined, then all to-be de-allocated address spaces are set to 0 before freeing or resizing. + * If _f_memory_FORCE_fast_memory_ is defined, then all to-be de-allocated address spaces remain unchanged before freeing or resizing. */ #if defined(_f_memory_FORCE_secure_memory_) && defined(_f_memory_FORCE_fast_memory_) #error You cannot define both _f_memory_FORCE_fast_memory_ and _f_memory_FORCE_secure_memory_ at the same time. diff --git a/level_0/f_parse/c/parse.h b/level_0/f_parse/c/parse.h index 18aae5a..96ad06b 100644 --- a/level_0/f_parse/c/parse.h +++ b/level_0/f_parse/c/parse.h @@ -188,6 +188,7 @@ extern "C" { * Be aware that if a UTF-8 character exists at the end of the string but extends beyond the range stop, the stop position may be after the UTF-8 byte and not 1 byte after the stop point. * @param id * (optional) The FLL Identifier found. + * * Set to NULL to not use. * * @return diff --git a/level_0/f_signal/c/signal.h b/level_0/f_signal/c/signal.h index 45c1f8e..8625652 100644 --- a/level_0/f_signal/c/signal.h +++ b/level_0/f_signal/c/signal.h @@ -36,10 +36,12 @@ extern "C" { * The signal settings. * @param action * (optional) The signal action to use. + * * Set to NULL to not use. * Both action and previous may not be NULL. * @param previous * (optional) The previous signal action. + * * Set to NULL to not use. * * @return @@ -92,9 +94,11 @@ extern "C" { * Set this to 0 when only trying to get the current signal set. * @param next * (optional) The new set of signals to handle. + * * Set to NULL to not use. * @param current * (optional) The current set of signals being handled. + * * Set to NULL to not use. * * @return @@ -368,6 +372,7 @@ extern "C" { * The set of signals to wait for. * @param information * (optional) The resulting signal information. + * * Set to NULL to not use. * * @return @@ -393,6 +398,7 @@ extern "C" { * The amount of time to wait. * @param information * (optional) The resulting signal information. + * * Set to NULL to not use. * * @return diff --git a/level_0/f_socket/c/socket.h b/level_0/f_socket/c/socket.h index ce33bf0..ae3050b 100644 --- a/level_0/f_socket/c/socket.h +++ b/level_0/f_socket/c/socket.h @@ -534,6 +534,7 @@ extern "C" { * (optional) The length of the buffer. * This gets replaced with the value of a positive ssize_t representing the length read. * Data may be lost if the amount of data read is larger than given buffer length. + * * Set to NULL to not use. * * @return @@ -638,6 +639,7 @@ extern "C" { * (optional) The length of the buffer. * This gets replaced with the value of a positive ssize_t representing the length read. * Data may be lost if the amount of data read is larger than given buffer length. + * * Set to NULL to not use. * * @return @@ -692,6 +694,7 @@ extern "C" { * (optional) The length of the buffer. * This gets replaced with the value of a positive ssize_t representing the length send. * Data may be lost if the amount of data send is larger than given buffer length. + * * Set to NULL to not use. * * @return @@ -804,6 +807,7 @@ extern "C" { * (optional) The length of the buffer. * This gets replaced with the value of a positive ssize_t representing the length send. * Data may be lost if the amount of data send is larger than given buffer length. + * * Set to NULL to not use. * * @return diff --git a/level_0/f_socket/c/socket/address.h b/level_0/f_socket/c/socket/address.h index 19e7e9c..aa8f3b0 100644 --- a/level_0/f_socket/c/socket/address.h +++ b/level_0/f_socket/c/socket/address.h @@ -229,6 +229,7 @@ extern "C" { * The exclusive stop position in the array to stop deleting. * @param array * The array structure to delete all values of. + * * Must not be NULL. * * @return @@ -257,6 +258,7 @@ extern "C" { * The exclusive stop position in the array to stop deleting. * @param array * The array structure to delete all values of. + * * Must not be NULL. * * @return diff --git a/level_0/f_socket/c/socket/socket.h b/level_0/f_socket/c/socket/socket.h index 3246ee9..7b8ad77 100644 --- a/level_0/f_socket/c/socket/socket.h +++ b/level_0/f_socket/c/socket/socket.h @@ -209,6 +209,7 @@ extern "C" { * The exclusive stop position in the array to stop deleting. * @param array * The array structure to delete all values of. + * * Must not be NULL. * * @return @@ -237,6 +238,7 @@ extern "C" { * The exclusive stop position in the array to stop deleting. * @param array * The array structure to delete all values of. + * * Must not be NULL. * * @return diff --git a/level_0/f_string/c/string/common.h b/level_0/f_string/c/string/common.h index b8f9b27..cef1fca 100644 --- a/level_0/f_string/c/string/common.h +++ b/level_0/f_string/c/string/common.h @@ -69,7 +69,7 @@ extern "C" { * Define the constant string type. * * This is needed when passing a constant string as a function argument. - * This cannot be allocated or deallocated. + * This cannot be allocated or de-allocated. * This is provided for compatibility with some projects that return "const char *". * * GCC errors such as: "warning: assignment discards ‘const’ qualifier from pointer target type [-Wdiscarded-qualifiers]" can be avoided using this. diff --git a/level_0/f_string/c/string/dynamics.h b/level_0/f_string/c/string/dynamics.h index 5a84429..778eb6f 100644 --- a/level_0/f_string/c/string/dynamics.h +++ b/level_0/f_string/c/string/dynamics.h @@ -89,6 +89,7 @@ extern "C" { * The exclusive stop position in the array to stop deleting. * @param array * The array structure to delete all values of. + * * Must not be NULL. * * @return @@ -117,6 +118,7 @@ extern "C" { * The exclusive stop position in the array to stop deleting. * @param array * The array structure to delete all values of. + * * Must not be NULL. * * @return diff --git a/level_0/f_string/c/string/dynamicss.h b/level_0/f_string/c/string/dynamicss.h index 5540c03..42b3ca7 100644 --- a/level_0/f_string/c/string/dynamicss.h +++ b/level_0/f_string/c/string/dynamicss.h @@ -89,6 +89,7 @@ extern "C" { * The exclusive stop position in the array to stop deleting. * @param array * The array structure to delete all values of. + * * Must not be NULL. * * @return @@ -117,6 +118,7 @@ extern "C" { * The exclusive stop position in the array to stop deleting. * @param array * The array structure to delete all values of. + * * Must not be NULL. * * @return diff --git a/level_0/f_string/c/string/map_multis.h b/level_0/f_string/c/string/map_multis.h index 09c6c84..47a4578 100644 --- a/level_0/f_string/c/string/map_multis.h +++ b/level_0/f_string/c/string/map_multis.h @@ -97,6 +97,7 @@ extern "C" { * The exclusive stop position in the array to stop deleting. * @param array * The array structure to delete all values of. + * * Must not be NULL. * * @return @@ -125,6 +126,7 @@ extern "C" { * The exclusive stop position in the array to stop deleting. * @param array * The array structure to delete all values of. + * * Must not be NULL. * * @return diff --git a/level_0/f_string/c/string/map_multiss.h b/level_0/f_string/c/string/map_multiss.h index 85ea400..2635d5a 100644 --- a/level_0/f_string/c/string/map_multiss.h +++ b/level_0/f_string/c/string/map_multiss.h @@ -97,6 +97,7 @@ extern "C" { * The exclusive stop position in the array to stop deleting. * @param array * The array structure to delete all values of. + * * Must not be NULL. * * @return @@ -125,6 +126,7 @@ extern "C" { * The exclusive stop position in the array to stop deleting. * @param array * The array structure to delete all values of. + * * Must not be NULL. * * @return diff --git a/level_0/f_string/c/string/maps.h b/level_0/f_string/c/string/maps.h index eb238a6..40848f8 100644 --- a/level_0/f_string/c/string/maps.h +++ b/level_0/f_string/c/string/maps.h @@ -97,6 +97,7 @@ extern "C" { * The exclusive stop position in the array to stop deleting. * @param array * The array structure to delete all values of. + * * Must not be NULL. * * @return @@ -125,6 +126,7 @@ extern "C" { * The exclusive stop position in the array to stop deleting. * @param array * The array structure to delete all values of. + * * Must not be NULL. * * @return diff --git a/level_0/f_string/c/string/mapss.h b/level_0/f_string/c/string/mapss.h index b30f5d1..f52e2e9 100644 --- a/level_0/f_string/c/string/mapss.h +++ b/level_0/f_string/c/string/mapss.h @@ -97,6 +97,7 @@ extern "C" { * The exclusive stop position in the array to stop deleting. * @param array * The array structure to delete all values of. + * * Must not be NULL. * * @return @@ -125,6 +126,7 @@ extern "C" { * The exclusive stop position in the array to stop deleting. * @param array * The array structure to delete all values of. + * * Must not be NULL. * * @return diff --git a/level_0/f_string/c/string/triples.h b/level_0/f_string/c/string/triples.h index e3948c2..895fc32 100644 --- a/level_0/f_string/c/string/triples.h +++ b/level_0/f_string/c/string/triples.h @@ -98,6 +98,7 @@ extern "C" { * The exclusive stop position in the array to stop deleting. * @param array * The array structure to delete all values of. + * * Must not be NULL. * * @return @@ -126,6 +127,7 @@ extern "C" { * The exclusive stop position in the array to stop deleting. * @param array * The array structure to delete all values of. + * * Must not be NULL. * * @return diff --git a/level_0/f_string/c/string/tripless.h b/level_0/f_string/c/string/tripless.h index 0d7c5aa..8bf44f1 100644 --- a/level_0/f_string/c/string/tripless.h +++ b/level_0/f_string/c/string/tripless.h @@ -98,6 +98,7 @@ extern "C" { * The exclusive stop position in the array to stop deleting. * @param array * The array structure to delete all values of. + * * Must not be NULL. * * @return @@ -126,6 +127,7 @@ extern "C" { * The exclusive stop position in the array to stop deleting. * @param array * The array structure to delete all values of. + * * Must not be NULL. * * @return diff --git a/level_0/f_thread/c/thread.h b/level_0/f_thread/c/thread.h index 31abe60..3cb1cca 100644 --- a/level_0/f_thread/c/thread.h +++ b/level_0/f_thread/c/thread.h @@ -56,12 +56,15 @@ extern "C" { * * @param before * The function to call before forking. + * * Must not be NULL. * @param after_parent * The function called after forking, for the parent process. + * * Must not be NULL. * @param after_child * The function called after forking, for the child process. + * * Must not be NULL. * * @return @@ -87,6 +90,7 @@ extern "C" { * The size of the affinity_set. * @param affinity_set * The assigned affinity information. + * * Must not be NULL. * * @return @@ -111,6 +115,7 @@ extern "C" { * The affinity information to assign. * @param attribute * The thread attributes to update. + * * Must not be NULL. * * @return @@ -135,6 +140,7 @@ extern "C" { * * @param level * The concurrency level. + * * Must not be NULL. * * @return @@ -178,6 +184,7 @@ extern "C" { * * @param attribute * The attribute to set. + * * Must not be NULL. * * @return @@ -199,6 +206,7 @@ extern "C" { * * @param attribute * The thread attributes to process. + * * Must not be NULL. * * @return @@ -219,6 +227,7 @@ extern "C" { * * @param attribute * The thread attributes to update. + * * Must not be NULL. * * @return @@ -245,6 +254,7 @@ extern "C" { * * @param attribute * The thread attributes to delete. + * * Must not be NULL. * * @return @@ -267,6 +277,7 @@ extern "C" { * The thread attributes to process. * @param state * The currently assigned state. + * * Must not be NULL. * * @return @@ -289,6 +300,7 @@ extern "C" { * The state to assign (such as PTHREAD_CREATE_DETACHED or PTHREAD_CREATE_JOINABLE). * @param attribute * The thread attributes to update. + * * Must not be NULL. * * @return @@ -311,6 +323,7 @@ extern "C" { * The thread attributes to process. * @param guard * The currently assigned guard size. + * * Must not be NULL. * * @return @@ -333,6 +346,7 @@ extern "C" { * The guard size to assign. * @param attribute * The thread attributes to update. + * * Must not be NULL. * * @return @@ -355,6 +369,7 @@ extern "C" { * The thread attributes to process. * @param inherit * The currently assigned scheduler inherit state. + * * Must not be NULL. * * @return @@ -377,6 +392,7 @@ extern "C" { * The inherit state of the scheduler (such as PTHREAD_INHERIT_SCHED or PTHREAD_EXPLICIT_SCHED). * @param attribute * The thread attributes to update. + * * Must not be NULL. * * @return @@ -399,6 +415,7 @@ extern "C" { * The thread attributes to process. * @param parameter * The currently assigned scheduler parameters. + * * Must not be NULL. * * @return @@ -421,6 +438,7 @@ extern "C" { * The parameters of the scheduler. * @param attribute * The thread attributes to update. + * * Must not be NULL. * * @return @@ -443,6 +461,7 @@ extern "C" { * The thread attributes to process. * @param policy * The currently assigned scheduler policy state. + * * Must not be NULL. * * @return @@ -465,6 +484,7 @@ extern "C" { * The policy state of the scheduler (such as SCHED_FIFO, SCHED_RR, or SCHED_OTHER). * @param attribute * The thread attributes to update. + * * Must not be NULL. * * @return @@ -487,6 +507,7 @@ extern "C" { * The thread attributes to process. * @param scope * The currently assigned scheduler scope state. + * * Must not be NULL. * * @return @@ -509,6 +530,7 @@ extern "C" { * The scope state of the scheduler (such as PTHREAD_SCOPE_SYSTEM or PTHREAD_SCOPE_PROCESS). * @param attribute * The thread attributes to update. + * * Must not be NULL. * * @return @@ -532,9 +554,11 @@ extern "C" { * The thread attributes to process. * @param stack_size * The size of the stack. + * * Must not be NULL. * @param stack * The assigned stack. + * * Must not be NULL. * * @return @@ -558,6 +582,7 @@ extern "C" { * The size of the stack. * @param stack * The stack to assign. + * * Must not be NULL. * @param attribute * The thread attributes to update @@ -584,6 +609,7 @@ extern "C" { * The thread attributes to process. * @param stack_size * The assigned size of the stack. + * * Must not be NULL. * * @return @@ -606,6 +632,7 @@ extern "C" { * The size of the stack. * @param attribute * The thread attributes to update. + * * Must not be NULL. * * @return @@ -626,6 +653,7 @@ extern "C" { * * @param attribute * The attribute to set. + * * Must not be NULL. * * @return @@ -652,6 +680,7 @@ extern "C" { * * @param attribute * The thread barrier_attributes to delete. + * * Must not be NULL. * * @return @@ -672,9 +701,11 @@ extern "C" { * * @param attribute * The barrier thread attribute. + * * Must not be NULL. * @param shared * The process shared attribute value. + * * Must not be NULL. * * @return @@ -697,6 +728,7 @@ extern "C" { * The process shared attribute value. * @param attribute * The barrier thread attribute. + * * Must not be NULL. * * @return @@ -722,6 +754,7 @@ extern "C" { * Set to NULL to not use (in which case the default barrier attributes are used). * @param barrier * The barrier to set. + * * Must not be NULL. * * @return @@ -750,6 +783,7 @@ extern "C" { * * @param barrier * The thread barriers to delete. + * * Must not be NULL. * * @return @@ -770,9 +804,11 @@ extern "C" { * * @param barrier * The barrier to wait on. + * * Must not be NULL. * @param result * (optional) the return value, which will be PTHREAD_BARRIER_SERIAL_THREAD for one thread and 0 for others. + * * Set to NULL to not use. * * @return @@ -824,6 +860,7 @@ extern "C" { * The cancellation state to assign. * @param previous * (optional) The previously assigned cancellation state. + * * Set to NULL to not use. * * @return @@ -861,6 +898,7 @@ extern "C" { * The cancellation type to assign. * @param previous * (optional) The previously assigned cancellation type. + * * Set to NULL to not use. * (Note: Linux allows this to be optional/NULL but POSIX does not explicitly defined this and there may be portability issues.) * @@ -884,6 +922,7 @@ extern "C" { * The ID of the thread to use. * @param id_clock * The retrieved clock ID. + * * Must not be NULL. * * @return @@ -922,6 +961,7 @@ extern "C" { * @param attribute * The attribute to set. * This assigns the default to the attribute. + * * Must not be NULL. * * @return @@ -942,9 +982,11 @@ extern "C" { * * @param attribute * The thread condition attribute. + * * Must not be NULL. * @param id * The clock ID. + * * Must not be NULL. * * @return @@ -967,6 +1009,7 @@ extern "C" { * The clock ID. * @param attribute * The thread condition attribute. + * * Must not be NULL. * * @return @@ -990,6 +1033,7 @@ extern "C" { * * @param attribute * The attribute to delete. + * * Must not be NULL. * * @return @@ -1078,6 +1122,7 @@ extern "C" { * * @param condition * The condition to delete. + * * Must not be NULL. * * @return @@ -1170,9 +1215,11 @@ extern "C" { * The wait time is relative to the clock, so consider calling clock_gettime() or gettimeofday() and then adding the amount of wait time. * @param condition * The condition to wait on. + * * Must not be NULL. * @param mutex * The mutex to use for waiting on condition. + * * Must not be NULL. * * @return @@ -1201,9 +1248,11 @@ extern "C" { * @param id * The thread ID. * This gets populated with the created thread ID (aka: the "child" thread). + * * Must not be NULL. * @param routine * The function to execute. + * * Must not be NULL. * @param argument * (optional) The structure containing all arguments to pass to the routine. @@ -1255,6 +1304,7 @@ extern "C" { * * @param result * The code returned by the exited thread. + * * Must not be NULL. * * @return @@ -1278,6 +1328,7 @@ extern "C" { * @param result * (optional) The data returned by the terminated thread (usually the exist status). * If the terminated thread is cancelled, then this holds PTHREAD_CANCELED. + * * Set to NULL to not use. * * @return @@ -1306,6 +1357,7 @@ extern "C" { * @param result * (optional) The data returned by the terminated thread (usually the exist status). * If the terminated thread is cancelled, then this holds PTHREAD_CANCELED. + * * Set to NULL to not use. * * @return @@ -1339,6 +1391,7 @@ extern "C" { * @param result * (optional) The data returned by the terminated thread (usually the exist status). * If the terminated thread is cancelled, then this holds PTHREAD_CANCELED. + * * Set to NULL to not use. * * @return @@ -1364,9 +1417,11 @@ extern "C" { * * @param routine * The function to execute for deallocation/deleting. + * * Must not be NULL. * @param key * The thread key. + * * Must not be NULL. * * @return @@ -1392,6 +1447,7 @@ extern "C" { * * @param key * The key to delete. + * * Must not be NULL. * * @return @@ -1414,6 +1470,7 @@ extern "C" { * The thread key. * @param value * The assigned thread key value. + * * Must not be NULL. * * @return @@ -1434,6 +1491,7 @@ extern "C" { * The thread key. * @param value * The thread key value to assign. + * * Must not be NULL. * * @return @@ -1454,6 +1512,7 @@ extern "C" { * * @param attribute * The lock attributes to create. + * * Must not be NULL. * * @return @@ -1481,6 +1540,7 @@ extern "C" { * * @param attribute * The attribute to delete. + * * Must not be NULL. * * @return @@ -1502,9 +1562,11 @@ extern "C" { * * @param attribute * The lock attribute. + * * Must not be NULL. * @param shared * The lock shared attribute value. + * * Must not be NULL. * * @return @@ -1527,6 +1589,7 @@ extern "C" { * The lock shared attribute value. * @param attribute * The lock attribute. + * * Must not be NULL. * * @return @@ -1547,6 +1610,7 @@ extern "C" { * * @param attribute * The lock attribute. + * * Must not be NULL. * @param lock * The lock to create. @@ -1574,6 +1638,7 @@ extern "C" { * * @param lock * The lock to delete. + * * Must not be NULL. * * @return @@ -1597,6 +1662,7 @@ extern "C" { * * @param lock * The thread lock. + * * Must not be NULL. * * @return @@ -1623,9 +1689,11 @@ extern "C" { * * @param timeout * The timeout. + * * Must not be NULL. * @param lock * The read/write lock. + * * Must not be NULL. * * @return @@ -1653,6 +1721,7 @@ extern "C" { * * @param lock * The thread lock. + * * Must not be NULL. * * @return @@ -1677,6 +1746,7 @@ extern "C" { * * @param lock * The thread lock. + * * Must not be NULL. * * @return @@ -1703,9 +1773,11 @@ extern "C" { * * @param timeout * The timeout. + * * Must not be NULL. * @param lock * The read/write lock. + * * Must not be NULL. * * @return @@ -1732,6 +1804,7 @@ extern "C" { * * @param lock * The thread lock. + * * Must not be NULL. * * @return @@ -1754,6 +1827,7 @@ extern "C" { * * @param attribute * The mutex attributes to create. + * * Must not be NULL. * * @return @@ -1780,6 +1854,7 @@ extern "C" { * * @param attribute * The attribute to delete. + * * Must not be NULL. * * @return @@ -1800,9 +1875,11 @@ extern "C" { * * @param attribute * The thread mutex attribute. + * * Must not be NULL. * @param ceiling * The priority ceiling. + * * Must not be NULL. * * @return @@ -1824,6 +1901,7 @@ extern "C" { * The priority ceiling. * @param attribute * The thread mutex attribute. + * * Must not be NULL. * * @return @@ -1843,9 +1921,11 @@ extern "C" { * * @param attribute * The thread mutex attribute. + * * Must not be NULL. * @param protocol * The protocol. + * * Must not be NULL. * * @return @@ -1869,6 +1949,7 @@ extern "C" { * The protocol. * @param attribute * The thread mutex attribute. + * * Must not be NULL. * * @return @@ -1891,9 +1972,11 @@ extern "C" { * * @param attribute * The mutex attribute. + * * Must not be NULL. * @param shared * The mutex shared attribute value. + * * Must not be NULL. * * @return @@ -1916,6 +1999,7 @@ extern "C" { * The mutex shared attribute value. * @param attribute * The mutex attribute. + * * Must not be NULL. * * @return @@ -1936,9 +2020,11 @@ extern "C" { * * @param attribute * The mutex attribute. + * * Must not be NULL. * @param type * The type. + * * Must not be NULL. * * @return @@ -1961,6 +2047,7 @@ extern "C" { * The type. * @param attribute * The mutex attribute. + * * Must not be NULL. * * @return @@ -1984,6 +2071,7 @@ extern "C" { * Set to NULL to not use (in which case the default attributes are used). * @param mutex * The mutex to create. + * * Must not be NULL. * * @return @@ -2011,6 +2099,7 @@ extern "C" { * * @param mutex * The mutex to delete. + * * Must not be NULL. * * @return @@ -2032,9 +2121,11 @@ extern "C" { * * @param mutex * The thread mutex. + * * Must not be NULL. * @param ceiling * The priority ceiling. + * * Must not be NULL. * * @return @@ -2058,9 +2149,11 @@ extern "C" { * The priority ceiling. * @param mutex * The thread mutex. + * * Must not be NULL. * @param previous * (optional) The previous priority ceiling. + * * Set to NULL to not use. * * @return @@ -2086,6 +2179,7 @@ extern "C" { * * @param mutex * The thread mutex. + * * Must not be NULL. * * @return @@ -2110,6 +2204,7 @@ extern "C" { * * @param mutex * The thread mutex. + * * Must not be NULL. * * @return @@ -2136,9 +2231,11 @@ extern "C" { * * @param timeout * The timeout. + * * Must not be NULL. * @param mutex * The thread mutex. + * * Must not be NULL. * * @return @@ -2169,6 +2266,7 @@ extern "C" { * * @param mutex * The thread mutex. + * * Must not be NULL. * * @return @@ -2195,6 +2293,7 @@ extern "C" { * The callback. * @param once * The once variable designating that the given routine will be called only once. + * * Must not be NULL. * * @return @@ -2295,6 +2394,7 @@ extern "C" { * The value to initially assign the semaphore on creation. * @param semaphore * The semaphore to create. + * * Must not be NULL. * * @return @@ -2319,6 +2419,7 @@ extern "C" { * * @param semaphore * The semaphore to delete. + * * Must not be NULL. * * @return @@ -2342,6 +2443,7 @@ extern "C" { * * @param semaphore * The semaphore to delete. + * * Must not be NULL. * * @return @@ -2394,6 +2496,7 @@ extern "C" { * Ignored if O_CREAT is not used in flag. * Ignored if the named semaphore already exists. * Not optional when O_CREAT flag is set. + * * Set to NULL to not use. * @param value * (optional) The value to initially assign the semaphore on creation. @@ -2403,6 +2506,7 @@ extern "C" { * Ignored when mode is NULL. * @param semaphore * The thread semaphore. + * * Must not be NULL. * * @return @@ -2435,6 +2539,7 @@ extern "C" { * * @param semaphore * The thread semaphore. + * * Must not be NULL. * * @return @@ -2462,6 +2567,7 @@ extern "C" { * The timeout. * @param semaphore * The thread semaphore. + * * Must not be NULL. * * @return @@ -2488,6 +2594,7 @@ extern "C" { * * @param semaphore * The thread semaphore. + * * Must not be NULL. * * @return @@ -2512,6 +2619,7 @@ extern "C" { * * @param semaphore * The thread semaphore. + * * Must not be NULL. * * @return @@ -2533,9 +2641,11 @@ extern "C" { * * @param semaphore * The thread semaphore. + * * Must not be NULL. * @param value * The semaphore's value. + * * Must not be NULL. * * @return @@ -2561,9 +2671,11 @@ extern "C" { * Set this to 0 when only trying to get the current signal set. * @param next * (optional) The new set of signals to handle. + * * Set to NULL to not use. * @param current * (optional) The current set of signals being handled. + * * Set to NULL to not use. * * @return @@ -2635,6 +2747,7 @@ extern "C" { * The shared process setting. * @param spin * The spin to create. + * * Must not be NULL. * * @return @@ -2660,6 +2773,7 @@ extern "C" { * * @param spin * The spin to delete. + * * Must not be NULL. * * @return @@ -2683,6 +2797,7 @@ extern "C" { * * @param spin * The thread spin. + * * Must not be NULL. * * @return @@ -2709,6 +2824,7 @@ extern "C" { * * @param spin * The thread spin. + * * Must not be NULL. * * @return @@ -2731,6 +2847,7 @@ extern "C" { * * @param spin * The thread spin. + * * Must not be NULL. * * @return @@ -2753,6 +2870,7 @@ extern "C" { * * @param lock * The thread lock. + * * Must not be NULL. * * @return diff --git a/level_0/f_thread/c/thread/attribute.h b/level_0/f_thread/c/thread/attribute.h index f630988..740e63c 100644 --- a/level_0/f_thread/c/thread/attribute.h +++ b/level_0/f_thread/c/thread/attribute.h @@ -65,6 +65,7 @@ extern "C" { * The exclusive stop position in the array to stop deleting. * @param array * The array structure to delete all values of. + * * Must not be NULL. * * @return @@ -94,6 +95,7 @@ extern "C" { * The exclusive stop position in the array to stop deleting. * @param array * The array structure to delete all values of. + * * Must not be NULL. * * @return @@ -123,6 +125,7 @@ extern "C" { * The exclusive stop position in the array to stop deleting. * @param array * The array structure to delete all values of. + * * Must not be NULL. * * @return @@ -152,6 +155,7 @@ extern "C" { * The exclusive stop position in the array to stop deleting. * @param array * The array structure to delete all values of. + * * Must not be NULL. * * @return diff --git a/level_0/f_thread/c/thread/barrier.h b/level_0/f_thread/c/thread/barrier.h index 6b60d4e..81d32c1 100644 --- a/level_0/f_thread/c/thread/barrier.h +++ b/level_0/f_thread/c/thread/barrier.h @@ -64,6 +64,7 @@ extern "C" { * The exclusive stop position in the array to stop deleting. * @param array * The array structure to delete all values of. + * * Must not be NULL. * * @return @@ -93,6 +94,7 @@ extern "C" { * The exclusive stop position in the array to stop deleting. * @param array * The array structure to delete all values of. + * * Must not be NULL. * * @return @@ -122,6 +124,7 @@ extern "C" { * The exclusive stop position in the array to stop deleting. * @param array * The array structure to delete all values of. + * * Must not be NULL. * * @return @@ -151,6 +154,7 @@ extern "C" { * The exclusive stop position in the array to stop deleting. * @param array * The array structure to delete all values of. + * * Must not be NULL. * * @return diff --git a/level_0/f_thread/c/thread/barrier_attribute.h b/level_0/f_thread/c/thread/barrier_attribute.h index 8df8b40..b598943 100644 --- a/level_0/f_thread/c/thread/barrier_attribute.h +++ b/level_0/f_thread/c/thread/barrier_attribute.h @@ -65,6 +65,7 @@ extern "C" { * The exclusive stop position in the array to stop deleting. * @param array * The array structure to delete all values of. + * * Must not be NULL. * * @return @@ -94,6 +95,7 @@ extern "C" { * The exclusive stop position in the array to stop deleting. * @param array * The array structure to delete all values of. + * * Must not be NULL. * * @return @@ -123,6 +125,7 @@ extern "C" { * The exclusive stop position in the array to stop deleting. * @param array * The array structure to delete all values of. + * * Must not be NULL. * * @return @@ -152,6 +155,7 @@ extern "C" { * The exclusive stop position in the array to stop deleting. * @param array * The array structure to delete all values of. + * * Must not be NULL. * * @return diff --git a/level_0/f_thread/c/thread/condition.h b/level_0/f_thread/c/thread/condition.h index f759b45..c63d687 100644 --- a/level_0/f_thread/c/thread/condition.h +++ b/level_0/f_thread/c/thread/condition.h @@ -65,6 +65,7 @@ extern "C" { * The exclusive stop position in the array to stop deleting. * @param array * The array structure to delete all values of. + * * Must not be NULL. * * @return @@ -94,6 +95,7 @@ extern "C" { * The exclusive stop position in the array to stop deleting. * @param array * The array structure to delete all values of. + * * Must not be NULL. * * @return @@ -123,6 +125,7 @@ extern "C" { * The exclusive stop position in the array to stop deleting. * @param array * The array structure to delete all values of. + * * Must not be NULL. * * @return @@ -152,6 +155,7 @@ extern "C" { * The exclusive stop position in the array to stop deleting. * @param array * The array structure to delete all values of. + * * Must not be NULL. * * @return diff --git a/level_0/f_thread/c/thread/condition_attribute.h b/level_0/f_thread/c/thread/condition_attribute.h index 5366caa..67e8a69 100644 --- a/level_0/f_thread/c/thread/condition_attribute.h +++ b/level_0/f_thread/c/thread/condition_attribute.h @@ -65,6 +65,7 @@ extern "C" { * The exclusive stop position in the array to stop deleting. * @param array * The array structure to delete all values of. + * * Must not be NULL. * * @return @@ -94,6 +95,7 @@ extern "C" { * The exclusive stop position in the array to stop deleting. * @param array * The array structure to delete all values of. + * * Must not be NULL. * * @return @@ -123,6 +125,7 @@ extern "C" { * The exclusive stop position in the array to stop deleting. * @param array * The array structure to delete all values of. + * * Must not be NULL. * * @return @@ -152,6 +155,7 @@ extern "C" { * The exclusive stop position in the array to stop deleting. * @param array * The array structure to delete all values of. + * * Must not be NULL. * * @return diff --git a/level_0/f_thread/c/thread/key.h b/level_0/f_thread/c/thread/key.h index f04fa39..60eeaa5 100644 --- a/level_0/f_thread/c/thread/key.h +++ b/level_0/f_thread/c/thread/key.h @@ -64,6 +64,7 @@ extern "C" { * The exclusive stop position in the array to stop deleting. * @param array * The array structure to delete all values of. + * * Must not be NULL. * * @return @@ -93,6 +94,7 @@ extern "C" { * The exclusive stop position in the array to stop deleting. * @param array * The array structure to delete all values of. + * * Must not be NULL. * * @return @@ -122,6 +124,7 @@ extern "C" { * The exclusive stop position in the array to stop deleting. * @param array * The array structure to delete all values of. + * * Must not be NULL. * * @return @@ -151,6 +154,7 @@ extern "C" { * The exclusive stop position in the array to stop deleting. * @param array * The array structure to delete all values of. + * * Must not be NULL. * * @return diff --git a/level_0/f_thread/c/thread/lock.h b/level_0/f_thread/c/thread/lock.h index ca12c4c..73a3f11 100644 --- a/level_0/f_thread/c/thread/lock.h +++ b/level_0/f_thread/c/thread/lock.h @@ -65,6 +65,7 @@ extern "C" { * The exclusive stop position in the array to stop deleting. * @param array * The array structure to delete all values of. + * * Must not be NULL. * * @return @@ -94,6 +95,7 @@ extern "C" { * The exclusive stop position in the array to stop deleting. * @param array * The array structure to delete all values of. + * * Must not be NULL. * * @return @@ -123,6 +125,7 @@ extern "C" { * The exclusive stop position in the array to stop deleting. * @param array * The array structure to delete all values of. + * * Must not be NULL. * * @return @@ -152,6 +155,7 @@ extern "C" { * The exclusive stop position in the array to stop deleting. * @param array * The array structure to delete all values of. + * * Must not be NULL. * * @return diff --git a/level_0/f_thread/c/thread/lock_attribute.h b/level_0/f_thread/c/thread/lock_attribute.h index ea8cabe..f6a7cb2 100644 --- a/level_0/f_thread/c/thread/lock_attribute.h +++ b/level_0/f_thread/c/thread/lock_attribute.h @@ -65,6 +65,7 @@ extern "C" { * The exclusive stop position in the array to stop deleting. * @param array * The array structure to delete all values of. + * * Must not be NULL. * * @return @@ -94,6 +95,7 @@ extern "C" { * The exclusive stop position in the array to stop deleting. * @param array * The array structure to delete all values of. + * * Must not be NULL. * * @return @@ -123,6 +125,7 @@ extern "C" { * The exclusive stop position in the array to stop deleting. * @param array * The array structure to delete all values of. + * * Must not be NULL. * * @return @@ -152,6 +155,7 @@ extern "C" { * The exclusive stop position in the array to stop deleting. * @param array * The array structure to delete all values of. + * * Must not be NULL. * * @return diff --git a/level_0/f_thread/c/thread/mutex.h b/level_0/f_thread/c/thread/mutex.h index 345ef33..f77f17d 100644 --- a/level_0/f_thread/c/thread/mutex.h +++ b/level_0/f_thread/c/thread/mutex.h @@ -67,6 +67,7 @@ extern "C" { * The exclusive stop position in the array to stop deleting. * @param array * The array structure to delete all values of. + * * Must not be NULL. * * @return @@ -96,6 +97,7 @@ extern "C" { * The exclusive stop position in the array to stop deleting. * @param array * The array structure to delete all values of. + * * Must not be NULL. * * @return @@ -125,6 +127,7 @@ extern "C" { * The exclusive stop position in the array to stop deleting. * @param array * The array structure to delete all values of. + * * Must not be NULL. * * @return @@ -154,6 +157,7 @@ extern "C" { * The exclusive stop position in the array to stop deleting. * @param array * The array structure to delete all values of. + * * Must not be NULL. * * @return diff --git a/level_0/f_thread/c/thread/mutex_attribute.h b/level_0/f_thread/c/thread/mutex_attribute.h index fc3acc5..7beec57 100644 --- a/level_0/f_thread/c/thread/mutex_attribute.h +++ b/level_0/f_thread/c/thread/mutex_attribute.h @@ -65,6 +65,7 @@ extern "C" { * The exclusive stop position in the array to stop deleting. * @param array * The array structure to delete all values of. + * * Must not be NULL. * * @return @@ -94,6 +95,7 @@ extern "C" { * The exclusive stop position in the array to stop deleting. * @param array * The array structure to delete all values of. + * * Must not be NULL. * * @return @@ -123,6 +125,7 @@ extern "C" { * The exclusive stop position in the array to stop deleting. * @param array * The array structure to delete all values of. + * * Must not be NULL. * * @return @@ -152,6 +155,7 @@ extern "C" { * The exclusive stop position in the array to stop deleting. * @param array * The array structure to delete all values of. + * * Must not be NULL. * * @return diff --git a/level_0/f_thread/c/thread/semaphore.h b/level_0/f_thread/c/thread/semaphore.h index d69e65a..7e12f57 100644 --- a/level_0/f_thread/c/thread/semaphore.h +++ b/level_0/f_thread/c/thread/semaphore.h @@ -66,6 +66,7 @@ extern "C" { * The exclusive stop position in the array to stop deleting. * @param array * The array structure to delete all values of. + * * Must not be NULL. * * @return @@ -95,6 +96,7 @@ extern "C" { * The exclusive stop position in the array to stop deleting. * @param array * The array structure to delete all values of. + * * Must not be NULL. * * @return @@ -124,6 +126,7 @@ extern "C" { * The exclusive stop position in the array to stop deleting. * @param array * The array structure to delete all values of. + * * Must not be NULL. * * @return @@ -153,6 +156,7 @@ extern "C" { * The exclusive stop position in the array to stop deleting. * @param array * The array structure to delete all values of. + * * Must not be NULL. * * @return diff --git a/level_0/f_thread/c/thread/set.h b/level_0/f_thread/c/thread/set.h index be282de..5ffae78 100644 --- a/level_0/f_thread/c/thread/set.h +++ b/level_0/f_thread/c/thread/set.h @@ -76,6 +76,7 @@ extern "C" { * The exclusive stop position in the array to stop deleting. * @param array * The array structure to delete all values of. + * * Must not be NULL. * * @return @@ -105,6 +106,7 @@ extern "C" { * The exclusive stop position in the array to stop deleting. * @param array * The array structure to delete all values of. + * * Must not be NULL. * * @return @@ -134,6 +136,7 @@ extern "C" { * The exclusive stop position in the array to stop deleting. * @param array * The array structure to delete all values of. + * * Must not be NULL. * * @return @@ -163,6 +166,7 @@ extern "C" { * The exclusive stop position in the array to stop deleting. * @param array * The array structure to delete all values of. + * * Must not be NULL. * * @return diff --git a/level_0/f_thread/c/thread/spin.h b/level_0/f_thread/c/thread/spin.h index efb852c..e2eb19e 100644 --- a/level_0/f_thread/c/thread/spin.h +++ b/level_0/f_thread/c/thread/spin.h @@ -64,6 +64,7 @@ extern "C" { * The exclusive stop position in the array to stop deleting. * @param array * The array structure to delete all values of. + * * Must not be NULL. * * @return @@ -93,6 +94,7 @@ extern "C" { * The exclusive stop position in the array to stop deleting. * @param array * The array structure to delete all values of. + * * Must not be NULL. * * @return @@ -122,6 +124,7 @@ extern "C" { * The exclusive stop position in the array to stop deleting. * @param array * The array structure to delete all values of. + * * Must not be NULL. * * @return @@ -151,6 +154,7 @@ extern "C" { * The exclusive stop position in the array to stop deleting. * @param array * The array structure to delete all values of. + * * Must not be NULL. * * @return diff --git a/level_0/f_time/c/time.h b/level_0/f_time/c/time.h index b7bfe36..6bc0d2c 100644 --- a/level_0/f_time/c/time.h +++ b/level_0/f_time/c/time.h @@ -179,6 +179,7 @@ extern "C" { * The time to sleep (in seconds and nanoseconds). * @param remaining * (optional) Contains the remaining time if stopped on interrupt. + * * Set to NULL to not use. * * @return diff --git a/level_0/f_type_array/c/type_array/cell.h b/level_0/f_type_array/c/type_array/cell.h index 585bbf0..3e0eca3 100644 --- a/level_0/f_type_array/c/type_array/cell.h +++ b/level_0/f_type_array/c/type_array/cell.h @@ -29,6 +29,7 @@ extern "C" { * The exclusive stop position in the array to stop deleting. * @param array * The array structure to delete all values of. + * * Must not be NULL. * * @return @@ -58,6 +59,7 @@ extern "C" { * The exclusive stop position in the array to stop deleting. * @param array * The array structure to delete all values of. + * * Must not be NULL. * * @return diff --git a/level_0/f_type_array/c/type_array/file.h b/level_0/f_type_array/c/type_array/file.h index eab7267..25ff90d 100644 --- a/level_0/f_type_array/c/type_array/file.h +++ b/level_0/f_type_array/c/type_array/file.h @@ -29,6 +29,7 @@ extern "C" { * The exclusive stop position in the array to stop deleting. * @param array * The array structure to delete all values of. + * * Must not be NULL. * * @return @@ -58,6 +59,7 @@ extern "C" { * The exclusive stop position in the array to stop deleting. * @param array * The array structure to delete all values of. + * * Must not be NULL. * * @return diff --git a/level_0/f_type_array/c/type_array/fll_id.h b/level_0/f_type_array/c/type_array/fll_id.h index ebd9c48..9848af2 100644 --- a/level_0/f_type_array/c/type_array/fll_id.h +++ b/level_0/f_type_array/c/type_array/fll_id.h @@ -29,6 +29,7 @@ extern "C" { * The exclusive stop position in the array to stop deleting. * @param array * The array structure to delete all values of. + * * Must not be NULL. * * @return @@ -58,6 +59,7 @@ extern "C" { * The exclusive stop position in the array to stop deleting. * @param array * The array structure to delete all values of. + * * Must not be NULL. * * @return @@ -87,6 +89,7 @@ extern "C" { * The exclusive stop position in the array to stop deleting. * @param array * The array structure to delete all values of. + * * Must not be NULL. * * @return @@ -116,6 +119,7 @@ extern "C" { * The exclusive stop position in the array to stop deleting. * @param array * The array structure to delete all values of. + * * Must not be NULL. * * @return diff --git a/level_0/f_type_array/c/type_array/int128.h b/level_0/f_type_array/c/type_array/int128.h index cb8ab50..3a77e42 100644 --- a/level_0/f_type_array/c/type_array/int128.h +++ b/level_0/f_type_array/c/type_array/int128.h @@ -29,6 +29,7 @@ extern "C" { * The exclusive stop position in the array to stop deleting. * @param array * The array structure to delete all values of. + * * Must not be NULL. * * @return @@ -58,6 +59,7 @@ extern "C" { * The exclusive stop position in the array to stop deleting. * @param array * The array structure to delete all values of. + * * Must not be NULL. * * @return diff --git a/level_0/f_type_array/c/type_array/int16.h b/level_0/f_type_array/c/type_array/int16.h index a1cf49b..143951d 100644 --- a/level_0/f_type_array/c/type_array/int16.h +++ b/level_0/f_type_array/c/type_array/int16.h @@ -29,6 +29,7 @@ extern "C" { * The exclusive stop position in the array to stop deleting. * @param array * The array structure to delete all values of. + * * Must not be NULL. * * @return @@ -58,6 +59,7 @@ extern "C" { * The exclusive stop position in the array to stop deleting. * @param array * The array structure to delete all values of. + * * Must not be NULL. * * @return diff --git a/level_0/f_type_array/c/type_array/int32.h b/level_0/f_type_array/c/type_array/int32.h index 28657eb..d13a755 100644 --- a/level_0/f_type_array/c/type_array/int32.h +++ b/level_0/f_type_array/c/type_array/int32.h @@ -29,6 +29,7 @@ extern "C" { * The exclusive stop position in the array to stop deleting. * @param array * The array structure to delete all values of. + * * Must not be NULL. * * @return @@ -58,6 +59,7 @@ extern "C" { * The exclusive stop position in the array to stop deleting. * @param array * The array structure to delete all values of. + * * Must not be NULL. * * @return diff --git a/level_0/f_type_array/c/type_array/int64.h b/level_0/f_type_array/c/type_array/int64.h index 3d702f0..a9e60a6 100644 --- a/level_0/f_type_array/c/type_array/int64.h +++ b/level_0/f_type_array/c/type_array/int64.h @@ -29,6 +29,7 @@ extern "C" { * The exclusive stop position in the array to stop deleting. * @param array * The array structure to delete all values of. + * * Must not be NULL. * * @return @@ -58,6 +59,7 @@ extern "C" { * The exclusive stop position in the array to stop deleting. * @param array * The array structure to delete all values of. + * * Must not be NULL. * * @return diff --git a/level_0/f_type_array/c/type_array/int8.h b/level_0/f_type_array/c/type_array/int8.h index 4ef5031..60262e2 100644 --- a/level_0/f_type_array/c/type_array/int8.h +++ b/level_0/f_type_array/c/type_array/int8.h @@ -29,6 +29,7 @@ extern "C" { * The exclusive stop position in the array to stop deleting. * @param array * The array structure to delete all values of. + * * Must not be NULL. * * @return @@ -58,6 +59,7 @@ extern "C" { * The exclusive stop position in the array to stop deleting. * @param array * The array structure to delete all values of. + * * Must not be NULL. * * @return diff --git a/level_0/f_type_array/c/type_array/number_signed.h b/level_0/f_type_array/c/type_array/number_signed.h index 237f2c6..ab2e533 100644 --- a/level_0/f_type_array/c/type_array/number_signed.h +++ b/level_0/f_type_array/c/type_array/number_signed.h @@ -29,6 +29,7 @@ extern "C" { * The exclusive stop position in the array to stop deleting. * @param array * The array structure to delete all values of. + * * Must not be NULL. * * @return @@ -58,6 +59,7 @@ extern "C" { * The exclusive stop position in the array to stop deleting. * @param array * The array structure to delete all values of. + * * Must not be NULL. * * @return diff --git a/level_0/f_type_array/c/type_array/number_unsigned.h b/level_0/f_type_array/c/type_array/number_unsigned.h index 8838e76..91139e1 100644 --- a/level_0/f_type_array/c/type_array/number_unsigned.h +++ b/level_0/f_type_array/c/type_array/number_unsigned.h @@ -29,6 +29,7 @@ extern "C" { * The exclusive stop position in the array to stop deleting. * @param array * The array structure to delete all values of. + * * Must not be NULL. * * @return @@ -58,6 +59,7 @@ extern "C" { * The exclusive stop position in the array to stop deleting. * @param array * The array structure to delete all values of. + * * Must not be NULL. * * @return diff --git a/level_0/f_type_array/c/type_array/poll.h b/level_0/f_type_array/c/type_array/poll.h index e11bf46..b278cea 100644 --- a/level_0/f_type_array/c/type_array/poll.h +++ b/level_0/f_type_array/c/type_array/poll.h @@ -29,6 +29,7 @@ extern "C" { * The exclusive stop position in the array to stop deleting. * @param array * The array structure to delete all values of. + * * Must not be NULL. * * @return @@ -58,6 +59,7 @@ extern "C" { * The exclusive stop position in the array to stop deleting. * @param array * The array structure to delete all values of. + * * Must not be NULL. * * @return diff --git a/level_0/f_type_array/c/type_array/range_doubless.h b/level_0/f_type_array/c/type_array/range_doubless.h index ff76532..b890501 100644 --- a/level_0/f_type_array/c/type_array/range_doubless.h +++ b/level_0/f_type_array/c/type_array/range_doubless.h @@ -69,6 +69,7 @@ extern "C" { * The exclusive stop position in the array to stop deleting. * @param array * The array structure to delete all values of. + * * Must not be NULL. * * @return @@ -97,6 +98,7 @@ extern "C" { * The exclusive stop position in the array to stop deleting. * @param array * The array structure to delete all values of. + * * Must not be NULL. * * @return diff --git a/level_0/f_type_array/c/type_array/rangess.h b/level_0/f_type_array/c/type_array/rangess.h index 937308f..99a0994 100644 --- a/level_0/f_type_array/c/type_array/rangess.h +++ b/level_0/f_type_array/c/type_array/rangess.h @@ -69,6 +69,7 @@ extern "C" { * The exclusive stop position in the array to stop deleting. * @param array * The array structure to delete all values of. + * * Must not be NULL. * * @return @@ -97,6 +98,7 @@ extern "C" { * The exclusive stop position in the array to stop deleting. * @param array * The array structure to delete all values of. + * * Must not be NULL. * * @return diff --git a/level_0/f_type_array/c/type_array/state.h b/level_0/f_type_array/c/type_array/state.h index c78fccf..7638251 100644 --- a/level_0/f_type_array/c/type_array/state.h +++ b/level_0/f_type_array/c/type_array/state.h @@ -29,6 +29,7 @@ extern "C" { * The exclusive stop position in the array to stop deleting. * @param array * The array structure to delete all values of. + * * Must not be NULL. * * @return @@ -58,6 +59,7 @@ extern "C" { * The exclusive stop position in the array to stop deleting. * @param array * The array structure to delete all values of. + * * Must not be NULL. * * @return diff --git a/level_0/f_type_array/c/type_array/status.h b/level_0/f_type_array/c/type_array/status.h index 40ede73..cfaa90c 100644 --- a/level_0/f_type_array/c/type_array/status.h +++ b/level_0/f_type_array/c/type_array/status.h @@ -29,6 +29,7 @@ extern "C" { * The exclusive stop position in the array to stop deleting. * @param array * The array structure to delete all values of. + * * Must not be NULL. * * @return @@ -58,6 +59,7 @@ extern "C" { * The exclusive stop position in the array to stop deleting. * @param array * The array structure to delete all values of. + * * Must not be NULL. * * @return diff --git a/level_0/f_type_array/c/type_array/uint128.h b/level_0/f_type_array/c/type_array/uint128.h index adb664c..97ddc95 100644 --- a/level_0/f_type_array/c/type_array/uint128.h +++ b/level_0/f_type_array/c/type_array/uint128.h @@ -29,6 +29,7 @@ extern "C" { * The exclusive stop position in the array to stop deleting. * @param array * The array structure to delete all values of. + * * Must not be NULL. * * @return @@ -58,6 +59,7 @@ extern "C" { * The exclusive stop position in the array to stop deleting. * @param array * The array structure to delete all values of. + * * Must not be NULL. * * @return diff --git a/level_0/f_type_array/c/type_array/uint16.h b/level_0/f_type_array/c/type_array/uint16.h index 1249dbf..fca0fdf 100644 --- a/level_0/f_type_array/c/type_array/uint16.h +++ b/level_0/f_type_array/c/type_array/uint16.h @@ -29,6 +29,7 @@ extern "C" { * The exclusive stop position in the array to stop deleting. * @param array * The array structure to delete all values of. + * * Must not be NULL. * * @return @@ -58,6 +59,7 @@ extern "C" { * The exclusive stop position in the array to stop deleting. * @param array * The array structure to delete all values of. + * * Must not be NULL. * * @return diff --git a/level_0/f_type_array/c/type_array/uint32.h b/level_0/f_type_array/c/type_array/uint32.h index c6253e7..1f6632e 100644 --- a/level_0/f_type_array/c/type_array/uint32.h +++ b/level_0/f_type_array/c/type_array/uint32.h @@ -29,6 +29,7 @@ extern "C" { * The exclusive stop position in the array to stop deleting. * @param array * The array structure to delete all values of. + * * Must not be NULL. * * @return @@ -58,6 +59,7 @@ extern "C" { * The exclusive stop position in the array to stop deleting. * @param array * The array structure to delete all values of. + * * Must not be NULL. * * @return diff --git a/level_0/f_type_array/c/type_array/uint64.h b/level_0/f_type_array/c/type_array/uint64.h index b4aff40..d1c9579 100644 --- a/level_0/f_type_array/c/type_array/uint64.h +++ b/level_0/f_type_array/c/type_array/uint64.h @@ -29,6 +29,7 @@ extern "C" { * The exclusive stop position in the array to stop deleting. * @param array * The array structure to delete all values of. + * * Must not be NULL. * * @return @@ -58,6 +59,7 @@ extern "C" { * The exclusive stop position in the array to stop deleting. * @param array * The array structure to delete all values of. + * * Must not be NULL. * * @return diff --git a/level_0/f_type_array/c/type_array/uint8.h b/level_0/f_type_array/c/type_array/uint8.h index e9162ec..a18f1bf 100644 --- a/level_0/f_type_array/c/type_array/uint8.h +++ b/level_0/f_type_array/c/type_array/uint8.h @@ -29,6 +29,7 @@ extern "C" { * The exclusive stop position in the array to stop deleting. * @param array * The array structure to delete all values of. + * * Must not be NULL. * * @return @@ -58,6 +59,7 @@ extern "C" { * The exclusive stop position in the array to stop deleting. * @param array * The array structure to delete all values of. + * * Must not be NULL. * * @return diff --git a/level_0/f_utf/c/utf/dynamics.h b/level_0/f_utf/c/utf/dynamics.h index 387500e..da76c53 100644 --- a/level_0/f_utf/c/utf/dynamics.h +++ b/level_0/f_utf/c/utf/dynamics.h @@ -89,6 +89,7 @@ extern "C" { * The exclusive stop position in the array to stop deleting. * @param array * The array structure to delete all values of. + * * Must not be NULL. * * @return @@ -117,6 +118,7 @@ extern "C" { * The exclusive stop position in the array to stop deleting. * @param array * The array structure to delete all values of. + * * Must not be NULL. * * @return diff --git a/level_0/f_utf/c/utf/dynamicss.h b/level_0/f_utf/c/utf/dynamicss.h index 0fd5281..f8d4100 100644 --- a/level_0/f_utf/c/utf/dynamicss.h +++ b/level_0/f_utf/c/utf/dynamicss.h @@ -89,6 +89,7 @@ extern "C" { * The exclusive stop position in the array to stop deleting. * @param array * The array structure to delete all values of. + * * Must not be NULL. * * @return @@ -117,6 +118,7 @@ extern "C" { * The exclusive stop position in the array to stop deleting. * @param array * The array structure to delete all values of. + * * Must not be NULL. * * @return diff --git a/level_0/f_utf/c/utf/is.h b/level_0/f_utf/c/utf/is.h index babe2f8..1ecb62b 100644 --- a/level_0/f_utf/c/utf/is.h +++ b/level_0/f_utf/c/utf/is.h @@ -78,6 +78,7 @@ extern "C" { * Can be anything greater than 0. * @param value * (optional) The integer representation of the sequence if the sequence represents a decimal of any base type. + * * Set to NULL to not use. * * @return @@ -294,6 +295,7 @@ extern "C" { * Can be anything greater than 0. * @param value * (optional) The integer representation of the sequence if the sequence represents a decimal of any base type. + * * Set to NULL to not use. * * @return diff --git a/level_0/f_utf/c/utf/is_character.h b/level_0/f_utf/c/utf/is_character.h index 740c651..6f6b3d7 100644 --- a/level_0/f_utf/c/utf/is_character.h +++ b/level_0/f_utf/c/utf/is_character.h @@ -71,6 +71,7 @@ extern "C" { * The byte sequence to validate as a character. * @param value * (optional) The integer representation of the sequence if the sequence represents a decimal of any base type. + * * Set to NULL to not use. * * @return @@ -242,6 +243,7 @@ extern "C" { * The byte sequence to validate as a character. * @param value * (optional) The integer representation of the sequence if the sequence represents a decimal of any base type. + * * Set to NULL to not use. * * @return diff --git a/level_0/f_utf/c/utf/map_multis.h b/level_0/f_utf/c/utf/map_multis.h index 768dc65..2354f1d 100644 --- a/level_0/f_utf/c/utf/map_multis.h +++ b/level_0/f_utf/c/utf/map_multis.h @@ -92,6 +92,7 @@ extern "C" { * The exclusive stop position in the array to stop deleting. * @param array * The array structure to delete all values of. + * * Must not be NULL. * * @return @@ -120,6 +121,7 @@ extern "C" { * The exclusive stop position in the array to stop deleting. * @param array * The array structure to delete all values of. + * * Must not be NULL. * * @return diff --git a/level_0/f_utf/c/utf/map_multiss.h b/level_0/f_utf/c/utf/map_multiss.h index 8b777dc..c7c8a17 100644 --- a/level_0/f_utf/c/utf/map_multiss.h +++ b/level_0/f_utf/c/utf/map_multiss.h @@ -92,6 +92,7 @@ extern "C" { * The exclusive stop position in the array to stop deleting. * @param array * The array structure to delete all values of. + * * Must not be NULL. * * @return @@ -120,6 +121,7 @@ extern "C" { * The exclusive stop position in the array to stop deleting. * @param array * The array structure to delete all values of. + * * Must not be NULL. * * @return diff --git a/level_0/f_utf/c/utf/maps.h b/level_0/f_utf/c/utf/maps.h index aed0b77..6b4e0e4 100644 --- a/level_0/f_utf/c/utf/maps.h +++ b/level_0/f_utf/c/utf/maps.h @@ -92,6 +92,7 @@ extern "C" { * The exclusive stop position in the array to stop deleting. * @param array * The array structure to delete all values of. + * * Must not be NULL. * * @return @@ -120,6 +121,7 @@ extern "C" { * The exclusive stop position in the array to stop deleting. * @param array * The array structure to delete all values of. + * * Must not be NULL. * * @return diff --git a/level_0/f_utf/c/utf/mapss.h b/level_0/f_utf/c/utf/mapss.h index be52715..68c9302 100644 --- a/level_0/f_utf/c/utf/mapss.h +++ b/level_0/f_utf/c/utf/mapss.h @@ -92,6 +92,7 @@ extern "C" { * The exclusive stop position in the array to stop deleting. * @param array * The array structure to delete all values of. + * * Must not be NULL. * * @return @@ -120,6 +121,7 @@ extern "C" { * The exclusive stop position in the array to stop deleting. * @param array * The array structure to delete all values of. + * * Must not be NULL. * * @return diff --git a/level_0/f_utf/c/utf/static.h b/level_0/f_utf/c/utf/static.h index 107b0a3..f4cf5f6 100644 --- a/level_0/f_utf/c/utf/static.h +++ b/level_0/f_utf/c/utf/static.h @@ -19,7 +19,7 @@ extern "C" { /** * A string that is analogous to f_utf_string_dynamic_t but intended for static-only uses. * - * The f_utf_string_static_t type should never be directly allocated or deallocated. + * The f_utf_string_static_t type should never be directly allocated or de-allocated. * * A special macro_f_utf_string_static_t_initialize_1() is provided for the special purpose of easily initialize a static string. * A special macro_f_utf_string_static_t_initialize_2() is provided for the special purpose of easily initialize a static string with an identical used and size. diff --git a/level_0/f_utf/c/utf/triples.h b/level_0/f_utf/c/utf/triples.h index 42676d6..f3ad261 100644 --- a/level_0/f_utf/c/utf/triples.h +++ b/level_0/f_utf/c/utf/triples.h @@ -93,6 +93,7 @@ extern "C" { * The exclusive stop position in the array to stop deleting. * @param array * The array structure to delete all values of. + * * Must not be NULL. * * @return @@ -121,6 +122,7 @@ extern "C" { * The exclusive stop position in the array to stop deleting. * @param array * The array structure to delete all values of. + * * Must not be NULL. * * @return diff --git a/level_0/f_utf/c/utf/tripless.h b/level_0/f_utf/c/utf/tripless.h index 96dd836..65b315a 100644 --- a/level_0/f_utf/c/utf/tripless.h +++ b/level_0/f_utf/c/utf/tripless.h @@ -93,6 +93,7 @@ extern "C" { * The exclusive stop position in the array to stop deleting. * @param array * The array structure to delete all values of. + * * Must not be NULL. * * @return @@ -121,6 +122,7 @@ extern "C" { * The exclusive stop position in the array to stop deleting. * @param array * The array structure to delete all values of. + * * Must not be NULL. * * @return diff --git a/level_1/fl_fss/c/fss/basic.h b/level_1/fl_fss/c/fss/basic.h index 6184acc..ea3e74e 100644 --- a/level_1/fl_fss/c/fss/basic.h +++ b/level_1/fl_fss/c/fss/basic.h @@ -156,6 +156,7 @@ extern "C" { * A location where a valid object was found. * @param quote * (optional) This will store the quote type representing the character to use (from the f_fss_quote_type_*_e). + * * Set to NULL to not use. * @param delimits * A delimits array representing where delimits exist within the buffer. diff --git a/level_1/fl_fss/c/fss/basic_list.h b/level_1/fl_fss/c/fss/basic_list.h index 962e577..2f59af5 100644 --- a/level_1/fl_fss/c/fss/basic_list.h +++ b/level_1/fl_fss/c/fss/basic_list.h @@ -113,6 +113,7 @@ extern "C" { * @param prepend * (optional) A string of whitespace to prepend at the start of each line. * This should only be whitespace, anything else could produce invalid content. + * * Set to NULL to not use. * @param range * The start/stop location within the content string to write as an content. diff --git a/level_1/fl_fss/c/fss/embedded_list.h b/level_1/fl_fss/c/fss/embedded_list.h index 1873c4c..8564ba0 100644 --- a/level_1/fl_fss/c/fss/embedded_list.h +++ b/level_1/fl_fss/c/fss/embedded_list.h @@ -117,11 +117,13 @@ extern "C" { * @param prepend * (optional) A string of whitespace to prepend at the start of each line. * This should only be whitespace, anything else could produce invalid content. + * * Set to NULL to not use. * @param ignore * (optional) A list of ranges within the string to ignore. * These ranges are only checked/ignored if there is a valid nested object open or a valid nested object close. * Any valid nested object open or valid nested object close inside an ingore range will not be escaped. + * * Set to NULL to not use. * @param range * The start/stop location within the content string to write as an content. diff --git a/level_1/fl_fss/c/fss/extended.h b/level_1/fl_fss/c/fss/extended.h index c15d3e4..0251e85 100644 --- a/level_1/fl_fss/c/fss/extended.h +++ b/level_1/fl_fss/c/fss/extended.h @@ -46,6 +46,7 @@ extern "C" { * @param quotes * (optional) This will store the quote type representing the character to use (from the f_fss_quote_type_*_e). * Each index in quotes represents a position within the found array index. + * * Set to NULL to not use. * @param delimits * A delimits array representing where delimits exist within the buffer. @@ -183,6 +184,7 @@ extern "C" { * A location where a valid object was found. * @param quote * (optional) This will store the quote type representing the character to use (from the f_fss_quote_type_*_e). + * * Set to NULL to not use. * @param delimits * A delimits array representing where delimits exist within the buffer. diff --git a/level_1/fl_fss/c/fss/extended_list.h b/level_1/fl_fss/c/fss/extended_list.h index 035856d..a61421d 100644 --- a/level_1/fl_fss/c/fss/extended_list.h +++ b/level_1/fl_fss/c/fss/extended_list.h @@ -115,11 +115,13 @@ extern "C" { * @param prepend * (optional) A string of whitespace to prepend at the start of each line. * This should only be whitespace, anything else could produce invalid content. + * * Set to NULL to not use. * @param ignore * (optional) A list of ranges within the string to ignore. * These ranges are only checked/ignored if there is a valid nested object open or a valid nested object close. * Any valid nested object open or valid nested object close inside an ingore range will not be escaped. + * * Set to NULL to not use. * @param range * The start/stop location within the content string to write as an content. diff --git a/level_1/fl_fss/c/private-fss.h b/level_1/fl_fss/c/private-fss.h index aab37d4..bdb46c7 100644 --- a/level_1/fl_fss/c/private-fss.h +++ b/level_1/fl_fss/c/private-fss.h @@ -104,6 +104,7 @@ extern "C" { * A set of all locations where a valid object was found. * @param quote * (optional) This will store the quote type representing the character to use (from the f_fss_quote_type_*_e). + * * Set to NULL to not use. * @param delimits * An array of delimits detected during processing. @@ -212,6 +213,7 @@ extern "C" { * Errors (with error bit) from: f_utf_buffer_increment(). * @param internal * (optional) Used by certain functions to pass local data to the interrupt() and similar callbacks. + * * Set to NULL to not use. * * @see f_fss_is_space() diff --git a/level_2/fll_execute/c/execute.h b/level_2/fll_execute/c/execute.h index be74a00..d8eb981 100644 --- a/level_2/fll_execute/c/execute.h +++ b/level_2/fll_execute/c/execute.h @@ -284,6 +284,7 @@ extern "C" { * (optional) The execute status code returned after finishing or attempting to finish execution of program. * When FL_execute_parameter_option_return_d is passed via parameter.option, then this instead stores the child process id (PID). * This is should be of (int *) except when FL_execute_parameter_option_return_d this should instead be (pid_t *). + * * Set to NULL to not use. * * @return diff --git a/level_2/fll_fss/c/fss.h b/level_2/fll_fss/c/fss.h index 1f5194f..9e5fcc9 100644 --- a/level_2/fll_fss/c/fss.h +++ b/level_2/fll_fss/c/fss.h @@ -51,6 +51,7 @@ extern "C" { * On success, the range->start should be after the last valid position (for example for "# fss-1234 fss-4321\n", the ast valid position would be the byte after the "\n"). * @param ids * (optional) The FLL Identifiers to populate with results of this function. + * * Set to NULL to not use. * * When non-NULL, this will have its length reset to 0. @@ -101,9 +102,11 @@ extern "C" { * An array of values where "snatched" content is stored. * @param matches * (optional) An array representing the if an Object was matched. + * * Set to NULL to not use. * @param indexs * (optional) An array representing the index within the Objects where the Content match was made. + * * Set to NULL to not use. * * @return @@ -149,9 +152,11 @@ extern "C" { * An array of values where "snatched" content is stored. * @param matches * (optional) An array representing the if an Object was matched. + * * Set to NULL to not use. * @param indexs * (optional) An array representing the index within the Objects where the Content match was made. + * * Set to NULL to not use. * * @return @@ -201,9 +206,11 @@ extern "C" { * An array of map arrays where "snatched" content is stored. * @param matches * (optional) An array representing the if an Object was matched. + * * Set to NULL to not use. * @param indexs * (optional) An array representing the index within the Objects where the Content match was made. + * * Set to NULL to not use. * * @return @@ -253,9 +260,11 @@ extern "C" { * An array of multi map arrays where "snatched" content is stored. * @param matches * (optional) An array representing the if an Object was matched. + * * Set to NULL to not use. * @param indexs * (optional) An array representing the index within the Objects where the Content match was made. + * * Set to NULL to not use. * * @return @@ -306,9 +315,11 @@ extern "C" { * An array of multi map value arrays where "snatched" content is stored. * @param matches * (optional) An array representing the if an Object was matched. + * * Set to NULL to not use. * @param indexs * (optional) An array representing the index within the Objects where the Content match was made. + * * Set to NULL to not use. * * @return @@ -357,9 +368,11 @@ extern "C" { * An array of multi map value arrays where "snatched" content is stored. * @param matches * (optional) An array representing the if an Object was matched. + * * Set to NULL to not use. * @param indexs * (optional) An array representing the index within the Objects where the Content match was made. + * * Set to NULL to not use. * * @return @@ -410,9 +423,11 @@ extern "C" { * An array of map arrays where "snatched" content is stored. * @param matches * (optional) An array representing the if an Object was matched. + * * Set to NULL to not use. * @param indexs * (optional) An array representing the index within the Objects where the Content match was made. + * * Set to NULL to not use. * * @return @@ -460,9 +475,11 @@ extern "C" { * An array of values where "snatched" content is stored. * @param matches * (optional) An array representing the if an Object was matched. + * * Set to NULL to not use. * @param indexs * (optional) An array representing the index within the Objects where the Content match was made. + * * Set to NULL to not use. * * @return @@ -508,9 +525,11 @@ extern "C" { * An array of values where "snatched" content is stored. * @param matches * (optional) An array representing the if an Object was matched. + * * Set to NULL to not use. * @param indexs * (optional) An array representing the index within the Objects where the Content match was made. + * * Set to NULL to not use. * * @return @@ -556,9 +575,11 @@ extern "C" { * An array of values where "snatched" content is stored. * @param matches * (optional) An array representing the if an Object was matched. + * * Set to NULL to not use. * @param indexs * (optional) An array representing the index within the Objects where the Content match was made. + * * Set to NULL to not use. * * @return diff --git a/level_2/fll_fss/c/fss/basic.h b/level_2/fll_fss/c/fss/basic.h index 9c99d56..0c066b5 100644 --- a/level_2/fll_fss/c/fss/basic.h +++ b/level_2/fll_fss/c/fss/basic.h @@ -39,6 +39,7 @@ extern "C" { * This will be populated with all valid contents found. * @param objects_quoted * (optional) An array mapped to each object in objects representing the quote type discovered (from the f_fss_quote_type_*_e), if any. + * * Set to NULL to not use. * @param objects_delimits * An array of delimits for objects detected during processing. diff --git a/level_2/fll_fss/c/fss/basic_list.h b/level_2/fll_fss/c/fss/basic_list.h index 1b7d73f..fecbb9f 100644 --- a/level_2/fll_fss/c/fss/basic_list.h +++ b/level_2/fll_fss/c/fss/basic_list.h @@ -89,6 +89,7 @@ extern "C" { * A string representing the content. * @param content_prepend * (optional) A string to prepend at the start of each line in content, such as spaces. + * * Set to NULL to not use. * @param destination * The buffer to write to. diff --git a/level_2/fll_fss/c/fss/embedded_list.h b/level_2/fll_fss/c/fss/embedded_list.h index 9d7697c..76c978a 100644 --- a/level_2/fll_fss/c/fss/embedded_list.h +++ b/level_2/fll_fss/c/fss/embedded_list.h @@ -89,11 +89,13 @@ extern "C" { * A string representing the content. * @param content_prepend * (optional) A string to prepend at the start of each line in content, such as spaces. + * * Set to NULL to not use. * @param ignore * (optional) A list of ranges within the string to ignore. * These ranges are only checked/ignored if there is a valid nested object open or a valid nested object close. * Any valid nested object open or valid nested object close inside an ingore range will not be escaped. + * * Set to NULL to not use. * @param destination * The buffer where the content is written to. diff --git a/level_2/fll_fss/c/fss/extended.h b/level_2/fll_fss/c/fss/extended.h index 2287f5e..56e78bb 100644 --- a/level_2/fll_fss/c/fss/extended.h +++ b/level_2/fll_fss/c/fss/extended.h @@ -39,9 +39,11 @@ extern "C" { * This will be populated with all valid contents found. * @param objects_quoted * (optional) An array mapped to each object in objects representing the quote type discovered (from the f_fss_quote_type_*_e), if any. + * * Set to NULL to not use. * @param contents_quoted * (optional) An array mapped to each content in objects representing the quote type discovered (from the f_fss_quote_type_*_e), if any. + * * Set to NULL to not use. * @param objects_delimits * An array of delimits for objects detected during processing. diff --git a/level_2/fll_fss/c/fss/extended_list.h b/level_2/fll_fss/c/fss/extended_list.h index 6d2dd37..81afd10 100644 --- a/level_2/fll_fss/c/fss/extended_list.h +++ b/level_2/fll_fss/c/fss/extended_list.h @@ -93,11 +93,13 @@ extern "C" { * A string representing the content. * @param content_prepend * (optional) A string to prepend at the start of each line in content, such as spaces. + * * Set to NULL to not use. * @param ignore * (optional) A list of ranges within the string to ignore. * These ranges are only checked/ignored if there is a valid nested object open or a valid nested object close. * Any valid nested object open or valid nested object close inside an ingore range will not be escaped. + * * Set to NULL to not use. * @param destination * The buffer where the content is written to. diff --git a/level_2/fll_fss/c/fss/payload.h b/level_2/fll_fss/c/fss/payload.h index 2b9e42b..0118f7b 100644 --- a/level_2/fll_fss/c/fss/payload.h +++ b/level_2/fll_fss/c/fss/payload.h @@ -114,6 +114,7 @@ extern "C" { * @param content_prepend * (optional) A string to prepend at the start of each line in content, such as spaces. * This will not be prepended for the Object "payload". + * * Set to NULL to not use. * @param destination * The buffer to append to. diff --git a/level_2/fll_print/c/print.h b/level_2/fll_print/c/print.h index 1eca3f9..40357d1 100644 --- a/level_2/fll_print/c/print.h +++ b/level_2/fll_print/c/print.h @@ -1075,6 +1075,7 @@ extern "C" { * The variable arguments list. * @param status * The status is stored here rather then via the return. + * * Set to NULL to not use. * * @return diff --git a/level_2/fll_program/c/program.h b/level_2/fll_program/c/program.h index 94c6579..ef0608e 100644 --- a/level_2/fll_program/c/program.h +++ b/level_2/fll_program/c/program.h @@ -115,6 +115,7 @@ extern "C" { * The primary color context to assign. * @param sets * (optional) A NULL terminated array representing additional sets to assign as empty. + * * Set to NULL to not use. * * @return diff --git a/level_2/fll_program/c/program/common.h b/level_2/fll_program/c/program/common.h index f1ca6a7..51796e3 100644 --- a/level_2/fll_program/c/program/common.h +++ b/level_2/fll_program/c/program/common.h @@ -103,6 +103,7 @@ extern "C" { * - output: The output file for normal/non-message output, aka data output (often stdout or a file). * - error: The output file for error output messages. * - warning: The output file for warning output messages. + * - debug: The output file for debug output messages. * * - context: The color context. */ diff --git a/level_3/byte_dump/c/main/common/type.h b/level_3/byte_dump/c/main/common/type.h index f173d8e..072b0ba 100644 --- a/level_3/byte_dump/c/main/common/type.h +++ b/level_3/byte_dump/c/main/common/type.h @@ -132,7 +132,7 @@ extern "C" { #endif // _di_byte_dump_main_t_ /** - * Deallocate main program data. + * De-allocate main program data. * * @param main * The main program data. diff --git a/level_3/controller/c/common.h b/level_3/controller/c/common.h index 258c3d1..352abb2 100644 --- a/level_3/controller/c/common.h +++ b/level_3/controller/c/common.h @@ -1397,7 +1397,7 @@ extern "C" { #endif // _di_controller_main_t_ /** - * Deallocate main program data. + * De-allocate main program data. * * @param main * The main program data. @@ -1654,10 +1654,10 @@ extern "C" { #endif // _di_controller_setting_load_ /** - * Fully deallocate all memory for the given entry action without caring about return status. + * Fully de-allocate all memory for the given entry action without caring about return status. * * @param action - * The action to deallocate. + * The action to de-allocate. * * @see f_memory_arrays_resize() * @@ -1671,10 +1671,10 @@ extern "C" { #endif // _di_controller_entry_action_delete_ /** - * Fully deallocate all memory for the given entry actions without caring about return status. + * Fully de-allocate all memory for the given entry actions without caring about return status. * * @param actions - * The entry_actions to deallocate. + * The entry_actions to de-allocate. * * @return * F_okay on success. @@ -1711,10 +1711,10 @@ extern "C" { #endif // _di_controller_entry_actions_increase_by_ /** - * Fully deallocate all memory for the given entry item without caring about return status. + * Fully de-allocate all memory for the given entry item without caring about return status. * * @param item - * The item to deallocate. + * The item to de-allocate. * * @return * F_okay on success. @@ -1728,10 +1728,10 @@ extern "C" { #endif // _di_controller_entry_item_delete_ /** - * Fully deallocate all memory for the given entry items without caring about return status. + * Fully de-allocate all memory for the given entry items without caring about return status. * * @param items - * The entry_items to deallocate. + * The entry_items to de-allocate. * * @return * F_okay on success. @@ -1768,10 +1768,10 @@ extern "C" { #endif // _di_controller_entry_items_increase_by_ /** - * Fully deallocate all memory for the given Rule Action without caring about return status. + * Fully de-allocate all memory for the given Rule Action without caring about return status. * * @param action - * The action to deallocate. + * The action to de-allocate. * * @see f_memory_arrays_resize() */ @@ -1780,10 +1780,10 @@ extern "C" { #endif // _di_controller_rule_action_delete_ /** - * Fully deallocate all memory for the given Rule Actions without caring about return status. + * Fully de-allocate all memory for the given Rule Actions without caring about return status. * * @param actions - * The rule_actions to deallocate. + * The rule_actions to de-allocate. * * @see controller_rule_action_delete() * @see f_memory_delete() @@ -1813,10 +1813,10 @@ extern "C" { #endif // _di_controller_rule_actions_increase_by_ /** - * Fully deallocate all memory for the given Rule without caring about return status. + * Fully de-allocate all memory for the given Rule without caring about return status. * * @param rule - * The rule to deallocate. + * The rule to de-allocate. * * @see controller_rule_items_delete() * @see f_capability_delete() @@ -1828,10 +1828,10 @@ extern "C" { #endif // _di_controller_rule_delete_ /** - * Fully deallocate all memory for the given Rule Item without caring about return status. + * Fully de-allocate all memory for the given Rule Item without caring about return status. * * @param item - * The item to deallocate. + * The item to de-allocate. * * @see f_memory_array_resize() */ @@ -1840,10 +1840,10 @@ extern "C" { #endif // _di_controller_rule_item_delete_ /** - * Fully deallocate all memory for the given Rule Items without caring about return status. + * Fully de-allocate all memory for the given Rule Items without caring about return status. * * @param items - * The rule_items to deallocate. + * The rule_items to de-allocate. * * @see controller_rule_item_delete() * @see f_memory_delete() @@ -1853,10 +1853,10 @@ extern "C" { #endif // _di_controller_rule_items_delete_ /** - * Fully deallocate all memory for the given Rule Item without caring about return status. + * Fully de-allocate all memory for the given Rule Item without caring about return status. * * @param on - * The on to deallocate. + * The on to de-allocate. * * @see f_memory_array_resize() */ @@ -1865,10 +1865,10 @@ extern "C" { #endif // _di_controller_rule_on_delete_ /** - * Fully deallocate all memory for the given Rule Items without caring about return status. + * Fully de-allocate all memory for the given Rule Items without caring about return status. * * @param ons - * The rule_ons to deallocate. + * The rule_ons to de-allocate. * * @see controller_rule_on_delete() * @see f_memory_delete() @@ -1921,10 +1921,10 @@ extern "C" { #endif // _di_controller_rule_ons_resize_ /** - * Fully deallocate all memory for the given Rules without caring about return status. + * Fully de-allocate all memory for the given Rules without caring about return status. * * @param rules - * The rules to deallocate. + * The rules to de-allocate. * * @see controller_rules_resize() */ diff --git a/level_3/controller/c/common/private-cache.h b/level_3/controller/c/common/private-cache.h index 7ad3118..33930aa 100644 --- a/level_3/controller/c/common/private-cache.h +++ b/level_3/controller/c/common/private-cache.h @@ -120,10 +120,10 @@ extern "C" { #endif // _di_controller_cache_t_ /** - * Fully deallocate all memory for the given cache without caring about return status. + * Fully de-allocate all memory for the given cache without caring about return status. * * @param cache - * The cache to deallocate. + * The cache to de-allocate. * * @see f_memory_array_resize() */ @@ -132,10 +132,10 @@ extern "C" { #endif // _di_controller_cache_action_delete_simple_ /** - * Fully deallocate all memory for the given cache without caring about return status. + * Fully de-allocate all memory for the given cache without caring about return status. * * @param cache - * The cache to deallocate. + * The cache to de-allocate. * * @see controller_cache_action_delete_simple() * diff --git a/level_3/controller/c/common/private-lock.h b/level_3/controller/c/common/private-lock.h index ee7baee..e5e5bca 100644 --- a/level_3/controller/c/common/private-lock.h +++ b/level_3/controller/c/common/private-lock.h @@ -73,10 +73,10 @@ extern "C" { #endif // _di_controller_lock_delete_rw_ /** - * Fully deallocate all memory for the given lock without caring about return status. + * Fully de-allocate all memory for the given lock without caring about return status. * * @param lock - * The lock to deallocate. + * The lock to de-allocate. * * @see f_thread_lock_delete() * @see f_thread_mutex_delete() diff --git a/level_3/controller/c/common/private-process.h b/level_3/controller/c/common/private-process.h index db92641..ade813c 100644 --- a/level_3/controller/c/common/private-process.h +++ b/level_3/controller/c/common/private-process.h @@ -213,10 +213,10 @@ extern "C" { #endif // _di_controller_pids_resize_ /** - * Fully deallocate all memory for the given process without caring about return status. + * Fully de-allocate all memory for the given process without caring about return status. * * @param data - * The data to deallocate. + * The data to de-allocate. * * @see f_memory_array_resize() * @see f_thread_condition_delete() @@ -227,10 +227,10 @@ extern "C" { #endif // _di_controller_data_delete_simple_ /** - * Fully deallocate all memory for the given processs without caring about return status. + * Fully de-allocate all memory for the given processs without caring about return status. * * @param processs - * The process array to deallocate. + * The process array to de-allocate. * * @see controller_processs_resize() */ diff --git a/level_3/controller/c/common/private-thread.h b/level_3/controller/c/common/private-thread.h index c14fc28..b22e520 100644 --- a/level_3/controller/c/common/private-thread.h +++ b/level_3/controller/c/common/private-thread.h @@ -133,10 +133,10 @@ extern "C" { #endif // _di_controller_thread_t_ /** - * Fully deallocate all memory for the given setting without caring about return status. + * Fully de-allocate all memory for the given setting without caring about return status. * * @param thread - * The thread to deallocate. + * The thread to de-allocate. * * @see controller_asynchronouss_resize() * @see f_thread_mutex_unlock() diff --git a/level_3/controller/c/process/private-process.h b/level_3/controller/c/process/private-process.h index d7b48bc..440fcdd 100644 --- a/level_3/controller/c/process/private-process.h +++ b/level_3/controller/c/process/private-process.h @@ -33,6 +33,7 @@ extern "C" { * The Rule alias to use. * @param id * (optional) The process ID when found or created. + * * Set to NULL to not use. * * @return @@ -74,6 +75,7 @@ extern "C" { * The Rule alias to use. * @param id * (optional) The process ID when found or created. + * * Set to NULL to not use. * * @return diff --git a/level_3/controller/c/thread/private-thread.c b/level_3/controller/c/thread/private-thread.c index 93e6426..22298d8 100644 --- a/level_3/controller/c/thread/private-thread.c +++ b/level_3/controller/c/thread/private-thread.c @@ -117,7 +117,7 @@ extern "C" { } } - // Deallocate dynamic portions of the structure that are only ever needed while the process is running. + // De-allocate dynamic portions of the structure that are only ever needed while the process is running. controller_cache_delete_simple(&process->cache); f_memory_array_resize(0, sizeof(f_number_unsigned_t), (void **) &process->stack.array, &process->stack.used, &process->stack.size); @@ -132,14 +132,14 @@ extern "C" { } } - // Deallocate the PID files. + // De-allocate the PID files. if (process->path_pids.used) { process->path_pids.used = 0; f_memory_arrays_resize(0, sizeof(f_string_dynamic_t), (void **) &process->path_pids.array, &process->path_pids.used, &process->path_pids.size, &f_string_dynamics_delete_callback); } - // Deallocate any rules in the space that is declared to be unused. + // De-allocate any rules in the space that is declared to be unused. if (i >= global->thread->processs.used) { controller_rule_delete(&process->rule); } diff --git a/level_3/controller/c/thread/private-thread_control.c b/level_3/controller/c/thread/private-thread_control.c index f1680d5..8f40bcd 100644 --- a/level_3/controller/c/thread/private-thread_control.c +++ b/level_3/controller/c/thread/private-thread_control.c @@ -23,9 +23,9 @@ extern "C" { if (status == F_child) { - // A forked child process should deallocate memory on exit. + // A forked child process should de-allocate memory on exit. // It seems that this function doesn't return to the calling thread for a forked child process, even with the "return 0;" below. - // Deallocate as much as possible. + // De-allocate as much as possible. controller_thread_delete_simple(global->thread); controller_process_delete(global->setting); controller_main_delete(global->main); diff --git a/level_3/controller/c/thread/private-thread_entry.c b/level_3/controller/c/thread/private-thread_entry.c index 7e686a8..07cecdc 100644 --- a/level_3/controller/c/thread/private-thread_entry.c +++ b/level_3/controller/c/thread/private-thread_entry.c @@ -132,9 +132,9 @@ extern "C" { if (*status == F_child) { - // A forked child process should deallocate memory on exit. + // A forked child process should de-allocate memory on exit. // It seems that this function doesn't return to the calling thread for a forked child process, even with the "return 0;" below. - // Deallocate as much as possible. + // De-allocate as much as possible. controller_thread_delete_simple(entry->global->thread); controller_process_delete(entry->global->setting); controller_main_delete(entry->global->main); @@ -250,9 +250,9 @@ extern "C" { if (*status == F_child) { - // A forked child process should deallocate memory on exit. + // A forked child process should de-allocate memory on exit. // It seems that this function doesn't return to the calling thread for a forked child process, even with the "return 0;" below. - // Deallocate as much as possible. + // De-allocate as much as possible. controller_thread_delete_simple(entry->global->thread); controller_process_delete(entry->global->setting); controller_main_delete(entry->global->main); diff --git a/level_3/controller/c/thread/private-thread_process.c b/level_3/controller/c/thread/private-thread_process.c index d25da66..e2958dd 100644 --- a/level_3/controller/c/thread/private-thread_process.c +++ b/level_3/controller/c/thread/private-thread_process.c @@ -25,9 +25,9 @@ extern "C" { if (status == F_child) { - // A forked child process should deallocate memory on exit. + // A forked child process should de-allocate memory on exit. // It seems that this function doesn't return to the calling thread for a forked child process, even with the "return 0;" below. - // Deallocate as much as possible. + // De-allocate as much as possible. controller_main_t *main = (controller_main_t *) process->main_data; controller_process_t *setting = (controller_process_t *) process->main_setting; controller_thread_t *thread = (controller_thread_t *) process->main_thread; diff --git a/level_3/example/c/main/common/type.h b/level_3/example/c/main/common/type.h index 37f1f19..dde2a81 100644 --- a/level_3/example/c/main/common/type.h +++ b/level_3/example/c/main/common/type.h @@ -86,7 +86,7 @@ extern "C" { #endif // _di_example_main_t_ /** - * Deallocate main program data. + * De-allocate main program data. * * @param cache * The program cache. @@ -100,7 +100,7 @@ extern "C" { #endif // _di_example_cache_delete_ /** - * Deallocate main program data. + * De-allocate main program data. * * @param main * The main program data. diff --git a/level_3/fake/c/main/common/type.h b/level_3/fake/c/main/common/type.h index 91cf445..fc4d36e 100644 --- a/level_3/fake/c/main/common/type.h +++ b/level_3/fake/c/main/common/type.h @@ -954,7 +954,7 @@ extern "C" { #endif // _di_fake_build_stage_delete_ /** - * Deallocate program data. + * De-allocate program data. * * @param data * The program data. @@ -968,7 +968,7 @@ extern "C" { #endif // _di_fake_data_delete_ /** - * Deallocate make data. + * De-allocate make data. * * @param data_make * The make data. @@ -982,7 +982,7 @@ extern "C" { #endif // _di_fake_make_data_delete_ /** - * Deallocate main program data. + * De-allocate main program data. * * @param main * The main program data. @@ -1002,7 +1002,7 @@ extern "C" { #endif // _di_fake_main_delete_ /** - * Deallocate make setting data. + * De-allocate make setting data. * * @param setting_make * The make setting data. diff --git a/level_3/firewall/c/main/common/type.h b/level_3/firewall/c/main/common/type.h index 6d4f7e6..b51a7f4 100644 --- a/level_3/firewall/c/main/common/type.h +++ b/level_3/firewall/c/main/common/type.h @@ -201,7 +201,7 @@ extern "C" { #endif // _di_firewall_main_t_ /** - * Deallocate firewall cache. + * De-allocate firewall cache. * * @param cache * The firewall cache. @@ -219,7 +219,7 @@ extern "C" { #endif // _di_firewall_cache_delete_ /** - * Deallocate firewall data. + * De-allocate firewall data. * * @param data * The firewall data. @@ -236,7 +236,7 @@ extern "C" { #endif // _di_firewall_data_delete_ /** - * Deallocate main program data. + * De-allocate main program data. * * @param main * The main program data. diff --git a/level_3/fss_identify/c/main/common/type.h b/level_3/fss_identify/c/main/common/type.h index b34ce46..8b6db31 100644 --- a/level_3/fss_identify/c/main/common/type.h +++ b/level_3/fss_identify/c/main/common/type.h @@ -98,7 +98,7 @@ extern "C" { #endif // _di_fss_identify_main_t_ /** - * Deallocate main program data. + * De-allocate main program data. * * @param main * The main program data. diff --git a/level_3/fss_read/c/main/common/type.h b/level_3/fss_read/c/main/common/type.h index f972104..580c90b 100644 --- a/level_3/fss_read/c/main/common/type.h +++ b/level_3/fss_read/c/main/common/type.h @@ -298,10 +298,10 @@ extern "C" { #endif // _di_fss_read_main_t_ /** - * Deallocate the read depth. + * De-allocate the read depth. * * @param depth - * The depth to deallocate. + * The depth to de-allocate. * * Must not be NULL. * @@ -358,7 +358,7 @@ extern "C" { #endif // _di_fss_read_files_resize_ /** - * Deallocate main program data. + * De-allocate main program data. * * @param main * The program and settings data. diff --git a/level_3/fss_write/c/main/common/type.h b/level_3/fss_write/c/main/common/type.h index 4622ecd..26fd8d2 100644 --- a/level_3/fss_write/c/main/common/type.h +++ b/level_3/fss_write/c/main/common/type.h @@ -149,7 +149,7 @@ extern "C" { #endif // _di_fss_write_main_t_ /** - * Deallocate main program data. + * De-allocate main program data. * * @param main * The main program data. diff --git a/level_3/iki_read/c/main/common/type.h b/level_3/iki_read/c/main/common/type.h index aa5b1ae..3fe16d9 100644 --- a/level_3/iki_read/c/main/common/type.h +++ b/level_3/iki_read/c/main/common/type.h @@ -111,7 +111,7 @@ extern "C" { #endif // _di_iki_read_main_t_ /** - * Deallocate main program data. + * De-allocate main program data. * * @param main * The main program data. diff --git a/level_3/iki_write/c/main/common/type.h b/level_3/iki_write/c/main/common/type.h index 82ede43..6d09bfd 100644 --- a/level_3/iki_write/c/main/common/type.h +++ b/level_3/iki_write/c/main/common/type.h @@ -90,7 +90,7 @@ extern "C" { #endif // _di_iki_write_main_t_ /** - * Deallocate main program data. + * De-allocate main program data. * * @param main * The main program data. diff --git a/level_3/status_code/c/main/common/type.h b/level_3/status_code/c/main/common/type.h index ff7e484..e1ae1e2 100644 --- a/level_3/status_code/c/main/common/type.h +++ b/level_3/status_code/c/main/common/type.h @@ -79,7 +79,7 @@ extern "C" { #endif // _di_status_code_main_t_ /** - * Deallocate main program data. + * De-allocate main program data. * * @param main * The main program data.. diff --git a/level_3/utf8/c/main/common/type.h b/level_3/utf8/c/main/common/type.h index e73dd9d..765b5fa 100644 --- a/level_3/utf8/c/main/common/type.h +++ b/level_3/utf8/c/main/common/type.h @@ -103,7 +103,7 @@ extern "C" { #endif // _di_utf8_main_t_ /** - * Deallocate main program data. + * De-allocate main program data. * * @param main * The main program data. -- 1.8.3.1