From: Kevin Day Date: Sun, 16 Jul 2023 00:56:12 +0000 (-0500) Subject: Cleanup: Documentation comments regarding structures. X-Git-Url: https://git.kevux.org/?a=commitdiff_plain;h=75df49ee39d1b16b188f0a7ece43a3c19103d4ed;p=fll Cleanup: Documentation comments regarding structures. Add "Properties: " and related styling to the documentation comments for type definition structures. Fix capitalization and other formatting issues that I noticed. I did not focus on any of the programs. However, some program related files happened to be open and so I updated those out of convenience. A follow up commit will be needed to address the programs and any other files in which I may have missed in this pass. --- diff --git a/level_0/f_account/c/account/common.h b/level_0/f_account/c/account/common.h index f73a252..7ee1e8b 100644 --- a/level_0/f_account/c/account/common.h +++ b/level_0/f_account/c/account/common.h @@ -31,13 +31,14 @@ extern "C" { /** * Provide a complete standard password account structure. * - * id_user: The user ID. - * id_group: The group ID. - * home: The user's home directory. - * label: The user's display name (gecos). - * name: The user's account name. - * password: The user's password. - * shell: The user's shell program. + * Properties: + * - id_user: The user ID. + * - id_group: The group ID. + * - home: The user's home directory. + * - label: The user's display name (gecos). + * - name: The user's account name. + * - password: The user's password. + * - shell: The user's shell program. */ #ifndef _di_f_account_t_ typedef struct { @@ -77,9 +78,10 @@ extern "C" { /** * An array of accounts. * - * array: The array of accounts. - * size: Total amount of space available. - * used: Total number of space used. + * Properties: + * - array: The array of accounts. + * - size: Total amount of space available. + * - used: Total number of space used. */ #ifndef _di_f_accounts_t_ typedef struct { @@ -111,9 +113,10 @@ extern "C" { /** * An array of f_accounts_t. * - * array: The array of f_accounts_t. - * size: Total amount of allocated space. - * used: Total number of allocated spaces used. + * Properties: + * - array: The array of f_accounts_t. + * - size: Total amount of allocated space. + * - used: Total number of allocated spaces used. */ #ifndef _di_f_accounts_t_ typedef struct { diff --git a/level_0/f_color/c/color/common.h b/level_0/f_color/c/color/common.h index 126ec2f..fe0e027 100644 --- a/level_0/f_color/c/color/common.h +++ b/level_0/f_color/c/color/common.h @@ -407,9 +407,10 @@ extern "C" { /** * Provide structure for containing color format control strings. * - * begin: String used to designate the start of a color code sequence. - * end: String used to designate the end of a color code sequence. - * medium: String used to designate the separation between two codes in a color code sequence. + * Properties: + * - begin: String used to designate the start of a color code sequence. + * - end: String used to designate the end of a color code sequence. + * - medium: String used to designate the separation between two codes in a color code sequence. */ #ifndef _di_f_color_format_t_ typedef struct { @@ -463,44 +464,45 @@ extern "C" { * - f_color_t_initialize_linux: ideal for linux console. * - f_color_t_initialize_xterminal: ideal for linux x-terminal. * - * reset: String used to describe reset color code. - * bold: String used to describe bold color code. - * underline: String used to describe underline color code. - * blink: String used to describe blink color code. - * reverse: String used to describe revese color code. - * conceal: String used to describe conceal color code. - * black: String used to describe black color code. - * red: String used to describe red color code. - * green: String used to describe green color code. - * yellow: String used to describe yellow color code. - * blue: String used to describe blue color code. - * purple: String used to describe purple color code. - * teal: String used to describe teal color code. - * white: String used to describe white color code. - * black_bg: String used to describe black background color code. - * red_bg: String used to describe red backgound color code. - * green_bg: String used to describe green backgound color code. - * yellow_bg: String used to describe yellow backgound color code. - * blue_bg: String used to describe blue backgound color code. - * purple_bg: String used to describe purple backgound color code. - * teal_bg: String used to describe teal backgound color code. - * white_bg: String used to describe white backgound color code. - * bright_black: String used to describe bright black backgound color code. - * bright_red: String used to describe bright red backgound color code. - * bright_green: String used to describe bright green backgound color code. - * bright_yellow: String used to describe bright yellow backgound color code. - * bright_blue: String used to describe bright blue backgound color code. - * bright_purple: String used to describe bright purple backgound color code. - * bright_teal: String used to describe bright teal backgound color code. - * bright_white: String used to describe bright white backgound color code. - * bright_black_bg: String used to describe bright black backgound color code. - * bright_red_bg: String used to describe bright red backgound color code. - * bright_green_bg: String used to describe bright green backgound color code. - * bright_yellow_bg: String used to describe bright yellow backgound color code. - * bright_blue_bg: String used to describe bright blue backgound color code. - * bright_purple_bg: String used to describe bright purple backgound color code. - * bright_teal_bg: String used to describe bright teal backgound color code. - * bright_white_bg: String used to describe bright white backgound color code. + * Properties: + * - reset: String used to describe reset color code. + * - bold: String used to describe bold color code. + * - underline: String used to describe underline color code. + * - blink: String used to describe blink color code. + * - reverse: String used to describe revese color code. + * - conceal: String used to describe conceal color code. + * - black: String used to describe black color code. + * - red: String used to describe red color code. + * - green: String used to describe green color code. + * - yellow: String used to describe yellow color code. + * - blue: String used to describe blue color code. + * - purple: String used to describe purple color code. + * - teal: String used to describe teal color code. + * - white: String used to describe white color code. + * - black_bg: String used to describe black background color code. + * - red_bg: String used to describe red backgound color code. + * - green_bg: String used to describe green backgound color code. + * - yellow_bg: String used to describe yellow backgound color code. + * - blue_bg: String used to describe blue backgound color code. + * - purple_bg: String used to describe purple backgound color code. + * - teal_bg: String used to describe teal backgound color code. + * - white_bg: String used to describe white backgound color code. + * - bright_black: String used to describe bright black backgound color code. + * - bright_red: String used to describe bright red backgound color code. + * - bright_green: String used to describe bright green backgound color code. + * - bright_yellow: String used to describe bright yellow backgound color code. + * - bright_blue: String used to describe bright blue backgound color code. + * - bright_purple: String used to describe bright purple backgound color code. + * - bright_teal: String used to describe bright teal backgound color code. + * - bright_white: String used to describe bright white backgound color code. + * - bright_black_bg: String used to describe bright black backgound color code. + * - bright_red_bg: String used to describe bright red backgound color code. + * - bright_green_bg: String used to describe bright green backgound color code. + * - bright_yellow_bg: String used to describe bright yellow backgound color code. + * - bright_blue_bg: String used to describe bright blue backgound color code. + * - bright_purple_bg: String used to describe bright purple backgound color code. + * - bright_teal_bg: String used to describe bright teal backgound color code. + * - bright_white_bg: String used to describe bright white backgound color code. */ #ifndef _di_f_color_t_ typedef struct { @@ -794,8 +796,9 @@ extern "C" { * This is intended to be used for printing, such that the printed code is prefixed with the "before" and postfixed with the "after". * These color strings should be NULL terminated. * - * before: A pointer to the dynamic string representing the before color to assign, set to NULL to disable. - * after: A pointer to the dynamic string representing the after color to assign, set to NULL to disable. + * Properties: + * - before: A pointer to the dynamic string representing the before color to assign, set to NULL to disable. + * - after: A pointer to the dynamic string representing the after color to assign, set to NULL to disable. */ #ifndef _di_f_color_set_t_ typedef struct { @@ -824,16 +827,17 @@ extern "C" { * * This is intended to be used for printing, such that the printed code is prefixed with the "before" and postfixed with the "after", for each context. * - * error: Color context associated with "error". - * important: Color context associated with "important". - * normal: Color context associated with "normal". - * normal_reset: Color context associated with "normal_reset". - * notable: Color context associated with "notable". - * reset: Reset the color context. - * standout: Color context associated with "standout". - * success: Color context associated with "success". - * title: Color context associated with "title". - * warning: Color context associated with "warning". + * Properties: + * - error: Color context associated with "error". + * - important: Color context associated with "important". + * - normal: Color context associated with "normal". + * - normal_reset: Color context associated with "normal_reset". + * - notable: Color context associated with "notable". + * - reset: Reset the color context. + * - standout: Color context associated with "standout". + * - success: Color context associated with "success". + * - title: Color context associated with "title". + * - warning: Color context associated with "warning". */ #ifndef _di_f_color_set_context_t_ typedef struct { @@ -893,21 +897,22 @@ extern "C" { * * This is intended to be used for printing, and this provides a management structure for all color context related data. * - * list: A list of colors, each with their specific color code string. - * format: The color code formatting strings. - * mode: A code representing the color mode. - * set: A collection of color context sets for direct use in color printing. + * Properties: + * - list: A list of colors, each with their specific color code string. + * - format: The color code formatting strings. + * - mode: A code representing the color mode. + * - set: A collection of color context sets for direct use in color printing. * - * error: Color context associated with "error". - * important: Color context associated with "important". - * normal: Color context associated with "normal". - * normal_reset: Color context associated with "normal_reset". - * notable: Color context associated with "notable". - * reset: Reset the color context. - * standout: Color context associated with "standout". - * success: Color context associated with "success". - * title: Color context associated with "title". - * warning: Color context associated with "warning". + * - error: Color context associated with "error". + * - important: Color context associated with "important". + * - normal: Color context associated with "normal". + * - normal_reset: Color context associated with "normal_reset". + * - notable: Color context associated with "notable". + * - reset: Reset the color context. + * - standout: Color context associated with "standout". + * - success: Color context associated with "success". + * - title: Color context associated with "title". + * - warning: Color context associated with "warning". */ #ifndef _di_f_color_context_t_ typedef struct { diff --git a/level_0/f_console/c/console/common.h b/level_0/f_console/c/console/common.h index 32744f1..337245c 100644 --- a/level_0/f_console/c/console/common.h +++ b/level_0/f_console/c/console/common.h @@ -205,12 +205,13 @@ extern "C" { * * This is intended to only store the argc and argv and should not be treated as dynamic. * - * argc: The total number of arguments in argv. + * Properties: + * - argc: The total number of arguments in argv. * - * argv: An array of strings representing arguments passed to some program. - * envp: Any array of strings representing all environment variables at the time the program is called. + * - argv: An array of strings representing arguments passed to some program. + * - envp: Any array of strings representing all environment variables at the time the program is called. * - * macro_f_console_arguments_t_initialize_1() initializes the structure. + * - macro_f_console_arguments_t_initialize_1() initializes the structure. */ #ifndef _di_f_console_arguments_t_ typedef struct { @@ -234,19 +235,20 @@ extern "C" { * * Any changes to the f_console_parameter_process() code likely requires changes or re-interpretation of these properties. * - * type: Describe the kind of processing is being performed. - * depth: Designate how many loops to break or continue out of (0 = one loop, 1 = two loops). - * width: Used like a cache to store width results such as from macro_f_utf_byte_width_is(). - * found: Designate that the currently process parameter has been matched. + * Properties: + * - type: Describe the kind of processing is being performed. + * - depth: Designate how many loops to break or continue out of (0 = one loop, 1 = two loops). + * - width: Used like a cache to store width results such as from macro_f_utf_byte_width_is(). + * - found: Designate that the currently process parameter has been matched. * - * result: The parameter result state determined by the appropriate f_console_identify() or similar call. - * state: A pointer to the state information. + * - result: The parameter result state determined by the appropriate f_console_identify() or similar call. + * - state: A pointer to the state information. * - * at: The location in the parameters array currently being processed (not all types use this). - * location: The current location within the argv array. - * location_sub: The current location within the argv[location] string. - * increment_by: The amount of characters being processed within the argv[location] for the current pass. - * need: The number of additional parameters that need to be grabbed. + * - at: The location in the parameters array currently being processed (not all types use this). + * - location: The current location within the argv array. + * - location_sub: The current location within the argv[location] string. + * - increment_by: The amount of characters being processed within the argv[location] for the current pass. + * - need: The number of additional parameters that need to be grabbed. * * The expected processing of each type (f_console_parameter_state_type_*_e) is as follows: * - identify: Determine what type of parameter is being processed. @@ -347,22 +349,23 @@ extern "C" { * The long parameters are prepended with either '--' or '++'. * The simple parameters have no prefix characters. * - * match_short: The NULL terminated single character string, such as 'h' in '-h'. - * match_long: The NULL terminated multi-character string, such as 'help' in '--help'. - * match_simple: The NULL terminated parameter that has no prefix, such as 'all' in 'make all'. + * Properties: + * - match_short: The NULL terminated single character string, such as 'h' in '-h'. + * - match_long: The NULL terminated multi-character string, such as 'help' in '--help'. + * - match_simple: The NULL terminated parameter that has no prefix, such as 'all' in 'make all'. * - * values_total: Designates that a parameter will have a given number of values arguments, such as 'blue' in '--color blue'. + * - values_total: Designates that a parameter will have a given number of values arguments, such as 'blue' in '--color blue'. * - * flag: A set of bits for providing states associated with the parameter. - * result: A set of bits representing if and how the parameter is found (such as '-h' vs '--help'). + * - flag: A set of bits for providing states associated with the parameter. + * - result: A set of bits representing if and how the parameter is found (such as '-h' vs '--help'). * - * location: The last location in argv[] where this parameter is found. - * location_sub: The last sub-location at location in argv (only used by short parameters, such as -h or +l). + * - location: The last location in argv[] where this parameter is found. + * - location_sub: The last sub-location at location in argv (only used by short parameters, such as -h or +l). * - * locations: All locations within argv where this parameter is found (order is preserved). - * locations_sub: All sub-locations within argv where this parameter is found (order is preserved). + * - locations: All locations within argv where this parameter is found (order is preserved). + * - locations_sub: All sub-locations within argv where this parameter is found (order is preserved). * - * values: An array of locations representing where in the argv[] the values arguments are found. + * - values: An array of locations representing where in the argv[] the values arguments are found. * * The macro_f_console_parameter_t_initialize_1() all arguments. * The macro_f_console_parameter_t_initialize_2() reduced arguments has short, long, and simple. @@ -498,10 +501,11 @@ extern "C" { * * This is not intended to be dynamically allocated, so there is no "size" property. * - * array: Intended to be populated with an array of f_console_parameter_t whose size is defined by the "used" property. - * arguments: An array of arguments pointing to the argv[] strings with the string lengths already calculated (This is a dynamic array of f_string_static_t). - * remaining: An array of indexes within the arguments representing unmatched parameters. - * length: The total number of parameters in the parameters array. + * Properties: + * - array: Intended to be populated with an array of f_console_parameter_t whose size is defined by the "used" property. + * - arguments: An array of arguments pointing to the argv[] strings with the string lengths already calculated (This is a dynamic array of f_string_static_t). + * - remaining: An array of indexes within the arguments representing unmatched parameters. + * - length: The total number of parameters in the parameters array. * * callback: A callback to perform when matched in order to handle condition values. * diff --git a/level_0/f_control_group/c/control_group/common.h b/level_0/f_control_group/c/control_group/common.h index c72cd72..61de4fb 100644 --- a/level_0/f_control_group/c/control_group/common.h +++ b/level_0/f_control_group/c/control_group/common.h @@ -51,9 +51,10 @@ extern "C" { /** * Provide a structure for associating some process with one or more control groups (cgroups). * - * as_new: If TRUE then the control group is to be unshared, and FALSE the control group is not to be unshared. - * path: The sysfs path, must have the trailing slash (such as "/sys/fs/cgroup/"). - * groups: An array of control groups, relative to the sysfs path (such as "memory/example"). + * Properties: + * - as_new: If TRUE then the control group is to be unshared, and FALSE the control group is not to be unshared. + * - path: The sysfs path, must have the trailing slash (such as "/sys/fs/cgroup/"). + * - groups: An array of control groups, relative to the sysfs path (such as "memory/example"). */ #ifndef _di_f_control_group_t_ typedef struct { diff --git a/level_0/f_conversion/c/conversion/common.h b/level_0/f_conversion/c/conversion/common.h index f07c948..7c5498c 100644 --- a/level_0/f_conversion/c/conversion/common.h +++ b/level_0/f_conversion/c/conversion/common.h @@ -79,9 +79,10 @@ extern "C" { /** * Provide a structure for customizing conversion settings for a conversion function to use. * - * base: The base unit the number is to be represented as, only the numbers 2 through 16 are supported as a base. - * flag: Store flags from f_conversion_data_flag_*. - * width: The number of digits representing a minimum width (a width of 0, should result in not printing a 0 when the number is 0). + * Properties: + * - base: The base unit the number is to be represented as, only the numbers 2 through 16 are supported as a base. + * - flag: Store flags from f_conversion_data_flag_*. + * - width: The number of digits representing a minimum width (a width of 0, should result in not printing a 0 when the number is 0). */ #ifndef _di_f_conversion_data_t_ typedef struct { diff --git a/level_0/f_directory/c/directory/type.h b/level_0/f_directory/c/directory/type.h index 4eb516e..4620e5a 100644 --- a/level_0/f_directory/c/directory/type.h +++ b/level_0/f_directory/c/directory/type.h @@ -21,14 +21,15 @@ extern "C" { * * Each property represents a set of paths grouped by directory entity file type. * - * block: For S_IFBLK. - * character: For S_IFCHR. - * directory: For S_IFDIR. - * regular: For S_IFREG. - * link: For S_IFLNK. - * fifo: For S_IFIFO. - * socket: For S_IFSOCK. - * unknown: For anything else. + * Properties: + * - block: For S_IFBLK. + * - character: For S_IFCHR. + * - directory: For S_IFDIR. + * - regular: For S_IFREG. + * - link: For S_IFLNK. + * - fifo: For S_IFIFO. + * - socket: For S_IFSOCK. + * - unknown: For anything else. */ #ifndef _di_f_directory_listing_t_ typedef struct { @@ -70,9 +71,10 @@ extern "C" { * * The allocation macros apply to the path. * - * step: The allocation step. - * status: The status code. - * path: The dynamically allocated path associated with the status code. + * Properties: + * - step: The allocation step. + * - status: The status code. + * - path: The dynamically allocated path associated with the status code. */ #ifndef _di_f_directory_status_t_ typedef struct { @@ -92,9 +94,10 @@ extern "C" { /** * An array of directory status. * - * array: An array of directory status. - * size: Total amount of allocated space. - * used: Total number of allocated spaces used. + * Properties: + * - array: An array of directory status. + * - size: Total amount of allocated space. + * - used: Total number of allocated spaces used. */ #ifndef _di_f_directory_statuss_t_ typedef struct { @@ -132,20 +135,21 @@ extern "C" { * * The callbacks must take care to properly modify the structure or they could cause security, integrity, or functionality problems. * - * depth: A number representing the depth recursed thus far (generally assigned internally). - * depth_max: The maximum recursion depth to use. - * flag: A set of flags used exclusively by the directory recurse process (not to be confused with state.flag). - * mode: A file mode flag to use when working on files, such as when copying a file. + * Properties: + * - depth: A number representing the depth recursed thus far (generally assigned internally). + * - depth_max: The maximum recursion depth to use. + * - flag: A set of flags used exclusively by the directory recurse process (not to be confused with state.flag). + * - mode: A file mode flag to use when working on files, such as when copying a file. * - * state: A pointer to the state information, where state.interrupt() and state.handle() are called appopriately. - * listing: A directory listing structure used internally to help reduce repeated memory allocation overhead. + * - state: A pointer to the state information, where state.interrupt() and state.handle() are called appopriately. + * - listing: A directory listing structure used internally to help reduce repeated memory allocation overhead. * - * path: A path representing the current directory path being operated on and usually represents the parent path of some file or directory (generally assigned internally). - * path_cache: A path-related cache made available for the caller to use, such as combining the path and the file name in the action callback. - * path_top: A pointer to the top path string, used for error handling and printing (generally assigned internally). + * - path: A path representing the current directory path being operated on and usually represents the parent path of some file or directory (generally assigned internally). + * - path_cache: A path-related cache made available for the caller to use, such as combining the path and the file name in the action callback. + * - path_top: A pointer to the top path string, used for error handling and printing (generally assigned internally). * - * action: A callback used for performing some action (this is required to do anything). - * handle: A callback used for performing error handling during recursion directly relating to a file. + * - action: A callback used for performing some action (this is required to do anything). + * - handle: A callback used for performing error handling during recursion directly relating to a file. * * The macro_f_directory_recurse_do_t_initialize_1() all arguments. * The macro_f_directory_recurse_do_t_initialize_2() all arguments except for internally managed source, destination, mode, and depth. diff --git a/level_0/f_execute/c/execute/common.h b/level_0/f_execute/c/execute/common.h index 9c2e992..4fa42f2 100644 --- a/level_0/f_execute/c/execute/common.h +++ b/level_0/f_execute/c/execute/common.h @@ -155,8 +155,9 @@ extern "C" { /** * A structure representing a scheduler and its parameters for execution. * - * policy: The scheduler policy. - * priority: The scheduler priority; + * Properties: + * - policy: The scheduler policy. + * - priority: The scheduler priority; */ #ifndef _di_f_execute_scheduler_t_ typedef struct { diff --git a/level_0/f_fss/c/fss/common.h b/level_0/f_fss/c/fss/common.h index be97998..604b658 100644 --- a/level_0/f_fss/c/fss/common.h +++ b/level_0/f_fss/c/fss/common.h @@ -133,7 +133,7 @@ extern "C" { /** * Codes for every known FSS standard. * - * f_fss_*: + * f_fss_*_e: * - basic: FSS-0000: Basic. * - extended: FSS-0001: Extended. * - basic_list: FSS-0002: Basic List. @@ -180,7 +180,7 @@ extern "C" { * * The "next" and "end" are only meaningful for a Content and will be treated as "none" for an Object. * - * f_fss_complete_*: + * f_fss_complete_*_e: * - none: Disable completeness. * - end: Complete as if this is the final piece of a set (such as FSS-0001, adding terminating EOL). * - full: Complete and add terminating EOL, where applicable. diff --git a/level_0/f_fss/c/fss/named.h b/level_0/f_fss/c/fss/named.h index 8dbcb91..4a94597 100644 --- a/level_0/f_fss/c/fss/named.h +++ b/level_0/f_fss/c/fss/named.h @@ -22,10 +22,11 @@ extern "C" { * The objects, contents, and quotess should each be of the same used and size. * Any deviation to this would require implementing custom equivelents to the standard management macros. * - * name: The name representing this set. - * objects: The array of objects. - * contents: The array of contents. - * quotess: The array of quote for each content. + * Properties: + * - name: The name representing this set. + * - objects: The array of objects. + * - contents: The array of contents. + * - quotess: The array of quote for each content. */ #ifndef _di_f_fss_named_t_ typedef struct { @@ -61,9 +62,10 @@ extern "C" { /** * This holds an array of f_fss_named_t. * - * array: An array of f_fss_named_t. - * size: Total amount of allocated space. - * used: Total number of allocated spaces used. + * Properties: + * - array: An array of f_fss_named_t. + * - size: Total amount of allocated space. + * - used: Total number of allocated spaces used. */ #ifndef _di_f_fss_nameds_t_ typedef struct { diff --git a/level_0/f_fss/c/fss/nest.h b/level_0/f_fss/c/fss/nest.h index f401dc4..bff95e0 100644 --- a/level_0/f_fss/c/fss/nest.h +++ b/level_0/f_fss/c/fss/nest.h @@ -27,9 +27,10 @@ extern "C" { * This does not have resize/adjust macros due to multiple things to potentially resize. * Any resizing must be manually performed on each applicable property. * - * object: The object. - * content: The content associated with the object. - * parent: A location referencing a parrent object or content that this object content is nested under. + * Properties: + * - object: The object. + * - content: The content associated with the object. + * - parent: A location referencing a parrent object or content that this object content is nested under. */ #ifndef _di_f_fss_item_t_ typedef struct { @@ -84,9 +85,10 @@ extern "C" { * More content after. * } * - * array: The array of object, their associated content, and their associated parent. - * size: Total amount of allocated space. - * used: Total number of allocated spaces used. + * Properties: + * - array: The array of object, their associated content, and their associated parent. + * - size: Total amount of allocated space. + * - used: Total number of allocated spaces used. */ #ifndef _di_f_fss_items_t_ typedef struct { @@ -122,9 +124,10 @@ extern "C" { * The top-level will not have any parent, so "parent" must be ignored on anything at index 0. * The parent identifier is expected to reference a position in the nesting depth immediately above it. * - * depth: An array of f_fss_items_t, with each index representing the depth. - * size: Total amount of allocated space. - * used: Total number of allocated spaces used. + * Properties: + * - depth: An array of f_fss_items_t, with each index representing the depth. + * - size: Total amount of allocated space. + * - used: Total number of allocated spaces used. */ #ifndef _di_f_fss_nest_t_ typedef struct { @@ -156,9 +159,10 @@ extern "C" { /** * This holds an array of f_fss_nest_t. * - * array: an array of f_fss_nest_t. - * size: Total amount of allocated space. - * used: Total number of allocated spaces used. + * Properties: + * - array: An array of f_fss_nest_t. + * - size: Total amount of allocated space. + * - used: Total number of allocated spaces used. */ #ifndef _di_f_fss_nests_t_ typedef struct { diff --git a/level_0/f_fss/c/fss/set.h b/level_0/f_fss/c/fss/set.h index 17a5493..5343e6f 100644 --- a/level_0/f_fss/c/fss/set.h +++ b/level_0/f_fss/c/fss/set.h @@ -22,8 +22,9 @@ extern "C" { * The objects and contents should each be of the same used and size. * Any deviation to this would require implementing custom equivelents to the standard management macros. * - * objects: the array of objects. - * contents: the array of contents. + * Properties: + * - objects: The array of objects. + * - contents: The array of contents. */ #ifndef _di_f_fss_set_t_ typedef struct { @@ -54,9 +55,10 @@ extern "C" { /** * This holds an array of f_fss_set_t. * - * array: an array of f_fss_set_t. - * size: total amount of allocated space. - * used: total number of allocated spaces used. + * Properties: + * - array: An array of f_fss_set_t. + * - size: Total amount of allocated space. + * - used: Total number of allocated spaces used. */ #ifndef _di_f_fss_sets_t_ typedef struct { @@ -91,10 +93,11 @@ extern "C" { * The objects, contents, and quotes should each be of the same used and size. * Any deviation to this would require implementing custom equivelents to the standard management macros. * - * objects: The array of objects. - * contents: The array of contents. - * objects_quote: The array of objects quote types. - * contents_quote: The array of contents quote types. + * Properties: + * - objects: The array of objects. + * - contents: The array of contents. + * - objects_quote: The array of objects quote types. + * - contents_quote: The array of contents quote types. */ #ifndef _di_f_fss_set_quote_t_ typedef struct { @@ -130,9 +133,10 @@ extern "C" { /** * This holds an array of f_fss_set_quote_t. * - * array: an array of f_fss_set_quote_t. - * size: total amount of allocated space. - * used: total number of allocated spaces used. + * Properties: + * - array: An array of f_fss_set_quote_t. + * - size: Total amount of allocated space. + * - used: Total number of allocated spaces used. */ #ifndef _di_f_fss_set_quotes_t_ typedef struct { diff --git a/level_0/f_iki/c/iki/common.h b/level_0/f_iki/c/iki/common.h index 20ecd83..b0b4cad 100644 --- a/level_0/f_iki/c/iki/common.h +++ b/level_0/f_iki/c/iki/common.h @@ -194,10 +194,11 @@ extern "C" { /** * This containg all of the IKI data. * - * content: A set of ranges representing the content (variable value) list to store the content associated with the found vocabulary name. - * delimits: A delimits array representing where delimits exist within the buffer. - * variable: A set of ranges representing the entire vocabulary (variable name), content, and the syntax. - * vocabulary: A set of ranges representing the vocabulary (variable name) list to store the found vocabulary name. + * Properties: + * - content: A set of ranges representing the content (variable value) list to store the content associated with the found vocabulary name. + * - delimits: A delimits array representing where delimits exist within the buffer. + * - variable: A set of ranges representing the entire vocabulary (variable name), content, and the syntax. + * - vocabulary: A set of ranges representing the vocabulary (variable name) list to store the found vocabulary name. */ #ifndef _di_f_iki_data_t_ typedef struct { @@ -229,9 +230,10 @@ extern "C" { /** * An array of f_iki_data_t. * - * array: The array of IKI data. - * size: Total amount of allocated space. - * used: Total number of allocated spaces used. + * Properties: + * - array: The array of IKI data. + * - size: Total amount of allocated space. + * - used: Total number of allocated spaces used. */ #ifndef _di_f_iki_datas_t_ typedef struct { @@ -263,9 +265,10 @@ extern "C" { /** * An array of f_iki_datas_t. * - * array: The array of IKI datas. - * size: Total amount of allocated space. - * used: Total number of allocated spaces used. + * Properties: + * - array: The array of IKI datas. + * - size: Total amount of allocated space. + * - used: Total number of allocated spaces used. */ #ifndef _di_f_iki_datass_t_ typedef struct { diff --git a/level_0/f_limit/c/limit/set.h b/level_0/f_limit/c/limit/set.h index db08625..6ee1098 100644 --- a/level_0/f_limit/c/limit/set.h +++ b/level_0/f_limit/c/limit/set.h @@ -19,8 +19,9 @@ extern "C" { /** * A limit value structure. * - * type: The limit resource type code. - * value: The limit value containing the soft and hard limit. + * Properties: + * - type: The limit resource type code. + * - value: The limit value containing the soft and hard limit. */ #ifndef _di_f_limit_set_t_ typedef struct { @@ -40,9 +41,10 @@ extern "C" { /** * An array of limit sets. * - * array: An array of limit sets. - * size: Total amount of allocated space. - * used: Total number of allocated spaces used. + * Properties: + * - array: An array of limit sets. + * - size: Total amount of allocated space. + * - used: Total number of allocated spaces used. */ #ifndef _di_f_limit_sets_t_ typedef struct { @@ -74,9 +76,10 @@ extern "C" { /** * This holds an array of f_limit_sets_t. * - * array: An array of f_limit_sets_t. - * size: Total amount of allocated space. - * used: Total number of allocated spaces used. + * Properties: + * - array: An array of f_limit_sets_t. + * - size: Total amount of allocated space. + * - used: Total number of allocated spaces used. */ #ifndef _di_f_limit_setss_t_ typedef struct { diff --git a/level_0/f_limit/c/limit/value.h b/level_0/f_limit/c/limit/value.h index 577f093..f3e139d 100644 --- a/level_0/f_limit/c/limit/value.h +++ b/level_0/f_limit/c/limit/value.h @@ -37,9 +37,10 @@ extern "C" { /** * An array of limit values. * - * array: An array of limit values. - * size: Total amount of allocated space. - * used: Total number of allocated spaces used. + * Properties: + * - array: An array of limit values. + * - size: Total amount of allocated space. + * - used: Total number of allocated spaces used. */ #ifndef _di_f_limit_values_t_ typedef struct { @@ -71,9 +72,10 @@ extern "C" { /** * This holds an array of f_limit_values_t. * - * array: An array of f_limit_values_t. - * size: Total amount of allocated space. - * used: Total number of allocated spaces used. + * Properties: + * - array: An array of f_limit_values_t. + * - size: Total amount of allocated space. + * - used: Total number of allocated spaces used. */ #ifndef _di_f_limit_valuess_t_ typedef struct { diff --git a/level_0/f_network/c/network/common.h b/level_0/f_network/c/network/common.h index aad4ba6..5682887 100644 --- a/level_0/f_network/c/network/common.h +++ b/level_0/f_network/c/network/common.h @@ -57,8 +57,9 @@ extern "C" { /** * A structure for managing an IP address version 4 or 6. * - * type: The type, usually either one of f_network_family_ip_4_e or f_network_family_ip_6_e. - * address: The address data. + * Properties: + * - type: The type, usually either one of f_network_family_ip_4_e or f_network_family_ip_6_e. + * - address: The address data. * * macro_f_network_family_ip_4_or_6_t_*: * - initialize_1: Specifically initialize the IP address version 4. diff --git a/level_0/f_signal/c/signal/common.h b/level_0/f_signal/c/signal/common.h index 56e78d7..7c3bb62 100644 --- a/level_0/f_signal/c/signal/common.h +++ b/level_0/f_signal/c/signal/common.h @@ -19,9 +19,10 @@ extern "C" { /** * This holds a signal type. * - * flags: The signal flags associated with this. - * id: The signal descriptor. - * set: The signal set. + * Properties: + * - flags: The signal flags associated with this. + * - id: The signal descriptor. + * - set: The signal set. */ #ifndef _di_f_signal_t_ typedef struct { @@ -43,8 +44,9 @@ extern "C" { /** * This holds a set of signals to block and a set of signals to unblock. * - * block: The signal flags to block. - * block_not: The signal flags to unblock. + * Properties: + * - block: The signal flags to block. + * - block_not: The signal flags to unblock. */ #ifndef _di_f_signal_how_t_ typedef struct { diff --git a/level_0/f_socket/c/socket/common.h b/level_0/f_socket/c/socket/common.h index da8ebb6..b6b9311 100644 --- a/level_0/f_socket/c/socket/common.h +++ b/level_0/f_socket/c/socket/common.h @@ -733,18 +733,19 @@ extern "C" { /** * Commonly used socket related properties, loosely based off of f_file_t. * - * id: File descriptor, with a value of -1 represents a closed file. - * domain: The socket domain (protocol family, such as f_socket_protocol_family_local_e). - * protocol: The socket protocol (such as f_socket_protocol_tcp_e). - * type: The socket type (address family, such as f_socket_address_family_local_e). + * Properties: + * - id: File descriptor, with a value of -1 represents a closed file. + * - domain: The socket domain (protocol family, such as f_socket_protocol_family_local_e). + * - protocol: The socket protocol (such as f_socket_protocol_tcp_e). + * - type: The socket type (address family, such as f_socket_address_family_local_e). * - * size_read: The default number of 1-byte characters to read at a time and is often used for the read buffer size. - * size_write: The default number of 1-byte characters to read at a time and is often used for the write buffer size. + * - size_read: The default number of 1-byte characters to read at a time and is often used for the read buffer size. + * - size_write: The default number of 1-byte characters to read at a time and is often used for the write buffer size. * - * address: The socket address. - * length: The length of the socket. + * - address: The socket address. + * - length: The length of the socket. * - * name: The name of the socket, if a name is given (for UNIX sockets this represents the path) (Must be a NULL terminated string). + * - name: The name of the socket, if a name is given (for UNIX sockets this represents the path) (Must be a NULL terminated string). * * The clear and reset macros do not clear or reset the address (type f_socket_address_t) because the struct sockaddr is defined outside of the FLL project. */ @@ -838,9 +839,10 @@ extern "C" { /** * An array of f_socket_t. * - * array: The array of f_socket_t. - * size: Total amount of allocated space. - * used: Total number of allocated spaces used. + * Properties: + * - array: The array of f_socket_t. + * - size: Total amount of allocated space. + * - used: Total number of allocated spaces used. */ #ifndef _di_f_sockets_t_ typedef struct { @@ -859,9 +861,10 @@ extern "C" { /** * This holds an array of f_sockets_t. * - * array: The array of f_socket_t arrays. - * size: Total amount of allocated space. - * used: Total number of allocated spaces used. + * Properties: + * - array: The array of f_socket_t arrays. + * - size: Total amount of allocated space. + * - used: Total number of allocated spaces used. */ #ifndef _di_f_socketss_t_ typedef struct { diff --git a/level_0/f_string/c/string/map.h b/level_0/f_string/c/string/map.h index 14c1f8e..dbc0502 100644 --- a/level_0/f_string/c/string/map.h +++ b/level_0/f_string/c/string/map.h @@ -19,8 +19,9 @@ extern "C" { /** * A string map consisting of a name and value. * - * name: A string representing the map name. - * value: A string representing the map value. + * Properties: + * - name: A string representing the map name. + * - value: A string representing the map value. */ #ifndef _di_f_string_map_t_ typedef struct { diff --git a/level_0/f_string/c/string/map_multi.h b/level_0/f_string/c/string/map_multi.h index acc660c..4876c58 100644 --- a/level_0/f_string/c/string/map_multi.h +++ b/level_0/f_string/c/string/map_multi.h @@ -19,8 +19,9 @@ extern "C" { /** * A string map consisting of a name and multiple values. * - * name: A string representing the map name. - * value: An array of strings representing the map value. + * Properties: + * - name: A string representing the map name. + * - value: An array of strings representing the map value. */ #ifndef _di_f_string_map_multi_t_ typedef struct { diff --git a/level_0/f_string/c/string/map_multis.h b/level_0/f_string/c/string/map_multis.h index 1a1decc..bd99ea8 100644 --- a/level_0/f_string/c/string/map_multis.h +++ b/level_0/f_string/c/string/map_multis.h @@ -19,9 +19,10 @@ extern "C" { /** * An array of string maps. * - * array: the array of string maps. - * size: total amount of allocated space. - * used: total number of allocated spaces used. + * Properties: + * - array: The array of string maps. + * - size: Total amount of allocated space. + * - used: Total number of allocated spaces used. */ #ifndef _di_f_string_map_multis_t_ typedef struct { diff --git a/level_0/f_string/c/string/map_multiss.h b/level_0/f_string/c/string/map_multiss.h index 4ae297f..de2b733 100644 --- a/level_0/f_string/c/string/map_multiss.h +++ b/level_0/f_string/c/string/map_multiss.h @@ -19,9 +19,10 @@ extern "C" { /** * An array of string maps arrays. * - * array: the array of an array of string maps. - * size: total amount of allocated space. - * used: total number of allocated spaces used. + * Properties: + * - array: The array of an array of string maps. + * - size: Total amount of allocated space. + * - used: Total number of allocated spaces used. */ #ifndef _di_f_string_map_multiss_t_ typedef struct { diff --git a/level_0/f_string/c/string/maps.h b/level_0/f_string/c/string/maps.h index 0609b7c..36f7c13 100644 --- a/level_0/f_string/c/string/maps.h +++ b/level_0/f_string/c/string/maps.h @@ -19,9 +19,10 @@ extern "C" { /** * An array of string maps. * - * array: the array of string maps. - * size: total amount of allocated space. - * used: total number of allocated spaces used. + * Properties: + * - array: The array of string maps. + * - size: Total amount of allocated space. + * - used: Total number of allocated spaces used. */ #ifndef _di_f_string_maps_t_ typedef struct { diff --git a/level_0/f_string/c/string/mapss.h b/level_0/f_string/c/string/mapss.h index 3b84554..45378e1 100644 --- a/level_0/f_string/c/string/mapss.h +++ b/level_0/f_string/c/string/mapss.h @@ -19,9 +19,10 @@ extern "C" { /** * An array of string maps. * - * array: the array of an array of string maps. - * size: total amount of allocated space. - * used: total number of allocated spaces used. + * Properties: + * - array: The array of an array of string maps. + * - size: Total amount of allocated space. + * - used: Total number of allocated spaces used. */ #ifndef _di_f_string_mapss_t_ typedef struct { diff --git a/level_0/f_string/c/string/quantity.h b/level_0/f_string/c/string/quantity.h index 5231c52..bf793f0 100644 --- a/level_0/f_string/c/string/quantity.h +++ b/level_0/f_string/c/string/quantity.h @@ -25,8 +25,9 @@ extern "C" { * 1) Exactly that, process a total of 0 strings bytes. * 2) Process with no limit, aka infinite. * - * start: The position where the string starts (based on some string/buffer). - * total: The total number of elements within that string/buffer the quantity represents. + * Properties: + * - start: The position where the string starts (based on some string/buffer). + * - total: The total number of elements within that string/buffer the quantity represents. */ #ifndef _di_f_string_quantity_t_ typedef struct { diff --git a/level_0/f_string/c/string/quantitys.h b/level_0/f_string/c/string/quantitys.h index 379dc5e..b7fe955 100644 --- a/level_0/f_string/c/string/quantitys.h +++ b/level_0/f_string/c/string/quantitys.h @@ -19,9 +19,10 @@ extern "C" { /** * An array of string quantitys. * - * array: the array of string quantitys. - * size: total amount of allocated space. - * used: total number of allocated spaces used. + * Properties: + * - array: The array of string quantitys. + * - size: Total amount of allocated space. + * - used: Total number of allocated spaces used. */ #ifndef _di_f_string_quantitys_t_ typedef struct { diff --git a/level_0/f_string/c/string/quantityss.h b/level_0/f_string/c/string/quantityss.h index a8225cb..bbac71a 100644 --- a/level_0/f_string/c/string/quantityss.h +++ b/level_0/f_string/c/string/quantityss.h @@ -19,9 +19,10 @@ extern "C" { /** * This holds an array of f_string_quantitys_t. * - * array: The array of quantitys arrays. - * size: Total amount of allocated space. - * used: Total number of allocated spaces used. + * Properties: + * - array: The array of quantitys arrays. + * - size: Total amount of allocated space. + * - used: Total number of allocated spaces used. */ #ifndef _di_f_string_quantityss_t_ typedef struct { diff --git a/level_0/f_string/c/string/range.h b/level_0/f_string/c/string/range.h index 2f3ee5b..555358d 100644 --- a/level_0/f_string/c/string/range.h +++ b/level_0/f_string/c/string/range.h @@ -23,8 +23,9 @@ extern "C" { * Therefore, a range from 0 to 0 would be include position 0. * Set start to some value larger than stop to designate that there is no range (such as start = 1, stop = 0). * - * start: the start position. - * stop: the stop position. + * Properties: + * - start: The start position. + * - stop: The stop position. */ #ifndef _di_f_string_range_t_ typedef struct { diff --git a/level_0/f_string/c/string/ranges.h b/level_0/f_string/c/string/ranges.h index c2886f5..de3c0e9 100644 --- a/level_0/f_string/c/string/ranges.h +++ b/level_0/f_string/c/string/ranges.h @@ -19,9 +19,10 @@ extern "C" { /** * An array of string ranges. * - * array: the array of string ranges. - * size: total amount of allocated space. - * used: total number of allocated spaces used. + * Properties: + * - array: The array of string ranges. + * - size: Total amount of allocated space. + * - used: Total number of allocated spaces used. */ #ifndef _di_f_string_ranges_t_ typedef struct { diff --git a/level_0/f_string/c/string/rangess.h b/level_0/f_string/c/string/rangess.h index 68d6205..e5dd470 100644 --- a/level_0/f_string/c/string/rangess.h +++ b/level_0/f_string/c/string/rangess.h @@ -19,9 +19,10 @@ extern "C" { /** * This holds an array of f_string_ranges_t. * - * array: The array of ranges arrays. - * size: Total amount of allocated space. - * used: Total number of allocated spaces used. + * Properties: + * - array: The array of ranges arrays. + * - size: Total amount of allocated space. + * - used: Total number of allocated spaces used. */ #ifndef _di_f_string_rangess_t_ typedef struct { diff --git a/level_0/f_string/c/string/static.h b/level_0/f_string/c/string/static.h index 7b1f720..7624fc1 100644 --- a/level_0/f_string/c/string/static.h +++ b/level_0/f_string/c/string/static.h @@ -27,9 +27,10 @@ extern "C" { * A special macro_f_string_static_t_initialize_1() is provided to easily initialize a static string. * A special macro_f_string_static_t_initialize_2() is provided to easily initialize a static string with an identical used and size. * - * string: The string. - * size: Total amount of space available. - * used: Total number of space used. + * Properties: + * - string: The string. + * - size: Total amount of space available. + * - used: Total number of space used. */ #ifndef _di_f_string_static_t_ typedef struct { diff --git a/level_0/f_string/c/string/statics.h b/level_0/f_string/c/string/statics.h index e80b6e9..b44e816 100644 --- a/level_0/f_string/c/string/statics.h +++ b/level_0/f_string/c/string/statics.h @@ -19,9 +19,10 @@ extern "C" { /** * An array of static strings. * - * array: The array of static strings. - * size: Total amount of space available. - * used: Total number of space used. + * Properties: + * - array: The array of static strings. + * - size: Total amount of space available. + * - used: Total number of space used. */ #ifndef _di_f_string_statics_t_ typedef struct { diff --git a/level_0/f_string/c/string/staticss.h b/level_0/f_string/c/string/staticss.h index 1d92a22..2ecfabd 100644 --- a/level_0/f_string/c/string/staticss.h +++ b/level_0/f_string/c/string/staticss.h @@ -19,9 +19,10 @@ extern "C" { /** * An array of static strings. * - * array: The array of static strings. - * size: Total amount of space available. - * used: Total number of space used. + * Properties: + * - array: The array of static strings. + * - size: Total amount of space available. + * - used: Total number of space used. */ #ifndef _di_f_string_staticss_t_ typedef struct { diff --git a/level_0/f_string/c/string/triple.h b/level_0/f_string/c/string/triple.h index d8d5f61..7df335a 100644 --- a/level_0/f_string/c/string/triple.h +++ b/level_0/f_string/c/string/triple.h @@ -19,9 +19,10 @@ extern "C" { /** * A string triple consisting of a set of three strings. * - * a: A string representing the first string in the triple. - * b: A string representing the second string in the triple. - * c: A string representing the third string in the triple. + * Properties: + * - a: A string representing the first string in the triple. + * - b: A string representing the second string in the triple. + * - c: A string representing the third string in the triple. */ #ifndef _di_f_string_triple_t_ typedef struct { diff --git a/level_0/f_string/c/string/triples.h b/level_0/f_string/c/string/triples.h index 3c7adae..9cfb7af 100644 --- a/level_0/f_string/c/string/triples.h +++ b/level_0/f_string/c/string/triples.h @@ -19,9 +19,10 @@ extern "C" { /** * An array of string triples. * - * array: The array of string triples. - * size: Total amount of allocated space. - * used: Total number of allocated spaces used. + * Properties: + * - array: The array of string triples. + * - size: Total amount of allocated space. + * - used: Total number of allocated spaces used. */ #ifndef _di_f_string_triples_t_ typedef struct { diff --git a/level_0/f_string/c/string/tripless.h b/level_0/f_string/c/string/tripless.h index 63d6b78..4f5ca5d 100644 --- a/level_0/f_string/c/string/tripless.h +++ b/level_0/f_string/c/string/tripless.h @@ -19,9 +19,10 @@ extern "C" { /** * An array of string tripless. * - * array: The array of string triples. - * size: Total amount of allocated space. - * used: Total number of allocated spaces used. + * Properties: + * - array: The array of string triples. + * - size: Total amount of allocated space. + * - used: Total number of allocated spaces used. */ #ifndef _di_f_string_tripless_t_ typedef struct { diff --git a/level_0/f_thread/c/thread/attribute.h b/level_0/f_thread/c/thread/attribute.h index b3a0b2c..f1b3586 100644 --- a/level_0/f_thread/c/thread/attribute.h +++ b/level_0/f_thread/c/thread/attribute.h @@ -35,9 +35,10 @@ extern "C" { /** * An array of f_thread_attribute_t. * - * array: The array of f_thread_attribute_t. - * size: Total amount of allocated space. - * used: Total number of allocated spaces used. + * Properties: + * - array: The array of f_thread_attribute_t. + * - size: Total amount of allocated space. + * - used: Total number of allocated spaces used. */ #ifndef _di_f_thread_attributes_t_ typedef struct { diff --git a/level_0/f_thread/c/thread/barrier.h b/level_0/f_thread/c/thread/barrier.h index c2411f2..af2e66c 100644 --- a/level_0/f_thread/c/thread/barrier.h +++ b/level_0/f_thread/c/thread/barrier.h @@ -34,9 +34,10 @@ extern "C" { /** * An array of f_thread_barrier_t. * - * array: The array of f_thread_barrier_t. - * size: Total amount of allocated space. - * used: Total number of allocated spaces used. + * Properties: + * - array: The array of f_thread_barrier_t. + * - size: Total amount of allocated space. + * - used: Total number of allocated spaces used. */ #ifndef _di_f_thread_barriers_t_ typedef struct { diff --git a/level_0/f_thread/c/thread/barrier_attribute.h b/level_0/f_thread/c/thread/barrier_attribute.h index c4f56c9..faecf6f 100644 --- a/level_0/f_thread/c/thread/barrier_attribute.h +++ b/level_0/f_thread/c/thread/barrier_attribute.h @@ -35,9 +35,10 @@ extern "C" { /** * An array of f_thread_barrier_attribute_t. * - * array: The array of f_thread_barrier_attribute_t. - * size: Total amount of allocated space. - * used: Total number of allocated spaces used. + * Properties: + * - array: The array of f_thread_barrier_attribute_t. + * - size: Total amount of allocated space. + * - used: Total number of allocated spaces used. */ #ifndef _di_f_thread_barrier_attributes_t_ typedef struct { diff --git a/level_0/f_thread/c/thread/condition.h b/level_0/f_thread/c/thread/condition.h index 35ecc01..457f9e6 100644 --- a/level_0/f_thread/c/thread/condition.h +++ b/level_0/f_thread/c/thread/condition.h @@ -35,9 +35,10 @@ extern "C" { /** * An array of thread conditions. * - * array: The array of f_thread_condition_t. - * size: Total amount of allocated space. - * used: Total number of allocated spaces used. + * Properties: + * - array: The array of f_thread_condition_t. + * - size: Total amount of allocated space. + * - used: Total number of allocated spaces used. */ #ifndef _di_f_thread_conditions_t_ typedef struct { diff --git a/level_0/f_thread/c/thread/condition_attribute.h b/level_0/f_thread/c/thread/condition_attribute.h index a95a44f..79e7b04 100644 --- a/level_0/f_thread/c/thread/condition_attribute.h +++ b/level_0/f_thread/c/thread/condition_attribute.h @@ -35,9 +35,10 @@ extern "C" { /** * An array of thread condition attributes. * - * array: The array of f_thread_condition_attribute_t. - * size: Total amount of allocated space. - * used: Total number of allocated spaces used. + * Properties: + * - array: The array of f_thread_condition_attribute_t. + * - size: Total amount of allocated space. + * - used: Total number of allocated spaces used. */ #ifndef _di_f_thread_condition_attributes_t_ typedef struct { diff --git a/level_0/f_thread/c/thread/id.h b/level_0/f_thread/c/thread/id.h index 3fba7ac..14dfc51 100644 --- a/level_0/f_thread/c/thread/id.h +++ b/level_0/f_thread/c/thread/id.h @@ -30,9 +30,10 @@ extern "C" { /** * An array of thread IDs. * - * array: The array of f_thread_id_t. - * size: Total amount of allocated space. - * used: Total number of allocated spaces used. + * Properties: + * - array: The array of f_thread_id_t. + * - size: Total amount of allocated space. + * - used: Total number of allocated spaces used. */ #ifndef _di_f_thread_ids_t_ typedef struct { diff --git a/level_0/f_thread/c/thread/key.h b/level_0/f_thread/c/thread/key.h index 32d7d1f..8619869 100644 --- a/level_0/f_thread/c/thread/key.h +++ b/level_0/f_thread/c/thread/key.h @@ -34,9 +34,10 @@ extern "C" { /** * An array of thread keys. * - * array: The array of f_thread_key_t. - * size: Total amount of allocated space. - * used: Total number of allocated spaces used. + * Properties: + * - array: The array of f_thread_key_t. + * - size: Total amount of allocated space. + * - used: Total number of allocated spaces used. */ #ifndef _di_f_thread_keys_t_ typedef struct { diff --git a/level_0/f_thread/c/thread/lock.h b/level_0/f_thread/c/thread/lock.h index 16037aa..da4d5ce 100644 --- a/level_0/f_thread/c/thread/lock.h +++ b/level_0/f_thread/c/thread/lock.h @@ -35,9 +35,10 @@ extern "C" { /** * An array of thread locks. * - * array: The array of f_thread_lock_t. - * size: Total amount of allocated space. - * used: Total number of allocated spaces used. + * Properties: + * - array: The array of f_thread_lock_t. + * - size: Total amount of allocated space. + * - used: Total number of allocated spaces used. */ #ifndef _di_f_thread_locks_t_ typedef struct { diff --git a/level_0/f_thread/c/thread/lock_attribute.h b/level_0/f_thread/c/thread/lock_attribute.h index 872c9c7..87c5796 100644 --- a/level_0/f_thread/c/thread/lock_attribute.h +++ b/level_0/f_thread/c/thread/lock_attribute.h @@ -35,9 +35,10 @@ extern "C" { /** * An array of read/write lock attributees. * - * array: The array of f_thread_lock_attribute_t. - * size: Total amount of allocated space. - * used: Total number of allocated spaces used. + * Properties: + * - array: The array of f_thread_lock_attribute_t. + * - size: Total amount of allocated space. + * - used: Total number of allocated spaces used. */ #ifndef _di_f_thread_lock_attributes_t_ typedef struct { diff --git a/level_0/f_thread/c/thread/mutex.h b/level_0/f_thread/c/thread/mutex.h index 1b12168..3dfd807 100644 --- a/level_0/f_thread/c/thread/mutex.h +++ b/level_0/f_thread/c/thread/mutex.h @@ -37,9 +37,10 @@ extern "C" { /** * An array of thread mutexes. * - * array: The array of f_thread_mutex_t. - * size: Total amount of allocated space. - * used: Total number of allocated spaces used. + * Properties: + * - array: The array of f_thread_mutex_t. + * - size: Total amount of allocated space. + * - used: Total number of allocated spaces used. */ #ifndef _di_f_thread_mutexs_t_ typedef struct { diff --git a/level_0/f_thread/c/thread/mutex_attribute.h b/level_0/f_thread/c/thread/mutex_attribute.h index 5f346a9..8f97d75 100644 --- a/level_0/f_thread/c/thread/mutex_attribute.h +++ b/level_0/f_thread/c/thread/mutex_attribute.h @@ -35,9 +35,10 @@ extern "C" { /** * An array of thread mutex_attributees. * - * array: The array of f_thread_mutex_attribute_t. - * size: Total amount of allocated space. - * used: Total number of allocated spaces used. + * Properties: + * - array: The array of f_thread_mutex_attribute_t. + * - size: Total amount of allocated space. + * - used: Total number of allocated spaces used. */ #ifndef _di_f_thread_mutex_attributes_t_ typedef struct { diff --git a/level_0/f_thread/c/thread/once.h b/level_0/f_thread/c/thread/once.h index 5edc07d..0747313 100644 --- a/level_0/f_thread/c/thread/once.h +++ b/level_0/f_thread/c/thread/once.h @@ -32,9 +32,10 @@ extern "C" { /** * An array of thread onces. * - * array: The array of f_thread_once_t. - * size: Total amount of allocated space. - * used: Total number of allocated spaces used. + * Properties: + * - array: The array of f_thread_once_t. + * - size: Total amount of allocated space. + * - used: Total number of allocated spaces used. */ #ifndef _di_f_thread_onces_t_ typedef struct { diff --git a/level_0/f_thread/c/thread/semaphore.h b/level_0/f_thread/c/thread/semaphore.h index 5ed869a..9722acf 100644 --- a/level_0/f_thread/c/thread/semaphore.h +++ b/level_0/f_thread/c/thread/semaphore.h @@ -36,9 +36,10 @@ extern "C" { /** * An array of thread semaphorees. * - * array: The array of f_thread_semaphore_t. - * size: Total amount of allocated space. - * used: Total number of allocated spaces used. + * Properties: + * - array: The array of f_thread_semaphore_t. + * - size: Total amount of allocated space. + * - used: Total number of allocated spaces used. */ #ifndef _di_f_thread_semaphores_t_ typedef struct { diff --git a/level_0/f_thread/c/thread/set.h b/level_0/f_thread/c/thread/set.h index 4f9721b..5406faa 100644 --- a/level_0/f_thread/c/thread/set.h +++ b/level_0/f_thread/c/thread/set.h @@ -19,9 +19,10 @@ extern "C" { /** * A structure containing basic thread information. * - * attribute: The thread attributes (which is a union). - * id: The thread identifier. - * result: The result of the thread on exit. + * Properties: + * - attribute: The thread attributes (which is a union). + * - id: The thread identifier. + * - result: The result of the thread on exit. */ #ifndef _di_f_thread_set_t_ typedef struct { @@ -45,9 +46,10 @@ extern "C" { /** * An array of f_thread_set_t. * - * array: The array of f_thread_set_t. - * size: Total amount of allocated space. - * used: Total number of allocated spaces used. + * Properties: + * - array: The array of f_thread_set_t. + * - size: Total amount of allocated space. + * - used: Total number of allocated spaces used. */ #ifndef _di_f_thread_sets_t_ typedef struct { diff --git a/level_0/f_thread/c/thread/spin.h b/level_0/f_thread/c/thread/spin.h index 0d920a3..61f0c82 100644 --- a/level_0/f_thread/c/thread/spin.h +++ b/level_0/f_thread/c/thread/spin.h @@ -34,9 +34,10 @@ extern "C" { /** * An array of thread spins. * - * array: The array of f_thread_spin_t. - * size: Total amount of allocated space. - * used: Total number of allocated spaces used. + * Properties: + * - array: The array of f_thread_spin_t. + * - size: Total amount of allocated space. + * - used: Total number of allocated spaces used. */ #ifndef _di_f_thread_spins_t_ typedef struct { diff --git a/level_0/f_type/c/type.h b/level_0/f_type/c/type.h index d8ad80b..2a79dc4 100644 --- a/level_0/f_type/c/type.h +++ b/level_0/f_type/c/type.h @@ -93,16 +93,17 @@ extern "C" { * This response is handled within f_talk(). * The f_talk() function will then set the state.status when done and might immediately set state.status to F_interrupt (with error bit) if bob_interrupts() returns F_interrupt (with/without error bit). * - * step_large: The allocation step to use for large buffers. - * step_small: The allocation step to use for small buffers. - * flag: A 64-bit digit intended for provided flags that are defined by the function. - * code: A 64-bit digit intended for provided flags that are defined by the caller. - * status: The status used while processing (This should hold the error passed to the handle callback and should be updated as necessary). - * handle: A function to call on a specific error (allowing for the error to be handled before function returns). May be NULL. - * interrupt: A function to call for checking to see if an interrupt is to be called. May be NULL. - * callbacks: A structure (defined by function/project using this) of additional functions to call. May be NULL. - * custom: A structure (defined by caller/parent) for holding custom data to be passed along to the interrupt() or one of the functions. May be NULL. - * data: A structure (defined by function) for holding data relevant to the function. May be NULL. May be required. + * Properties: + * - step_large: The allocation step to use for large buffers. + * - step_small: The allocation step to use for small buffers. + * - flag: A 64-bit digit intended for provided flags that are defined by the function. + * - code: A 64-bit digit intended for provided flags that are defined by the caller. + * - status: The status used while processing (This should hold the error passed to the handle callback and should be updated as necessary). + * - handle: A function to call on a specific error (allowing for the error to be handled before function returns). May be NULL. + * - interrupt: A function to call for checking to see if an interrupt is to be called. May be NULL. + * - callbacks: A structure (defined by function/project using this) of additional functions to call. May be NULL. + * - custom: A structure (defined by caller/parent) for holding custom data to be passed along to the interrupt() or one of the functions. May be NULL. + * - data: A structure (defined by function) for holding data relevant to the function. May be NULL. May be required. */ #ifndef _di_f_state_t_ typedef struct { @@ -323,8 +324,9 @@ extern "C" { /** * A structure designating a row and column, just like a cell in a table. * - * row: The row position. - * column: The column position. + * Properties: + * - row: The row position. + * - column: The column position. */ #ifndef _di_f_cell_t_ typedef struct { @@ -346,9 +348,10 @@ extern "C" { * * The macros are defined in type_array.h or type_array-common.h. * - * array: The array of f_cell_t. - * size: Total amount of allocated space. - * used: Total number of allocated spaces used. + * Properties: + * - array: The array of f_cell_t. + * - size: Total amount of allocated space. + * - used: Total number of allocated spaces used. */ #ifndef _di_f_cells_t_ typedef struct { @@ -369,9 +372,10 @@ extern "C" { * * The macros are defined in type_array.h or type_array-common.h. * - * array: The array of f_cell_t arrays. - * size: Total amount of allocated space. - * used: Total number of allocated spaces used. + * Properties: + * - array: The array of f_cell_t arrays. + * - size: Total amount of allocated space. + * - used: Total number of allocated spaces used. */ #ifndef _di_f_cellss_t_ typedef struct { @@ -389,6 +393,16 @@ extern "C" { /** * A structure representing a set of modes intended to be used by file or directory operations. + * + * Properties: + * - block: The mode for a block. + * - character: The mode for a character. + * - directory: The mode for a directory. + * - fifo: The mode for a FIFO. + * - regular: The mode for a regular file. + * - link: The mode for a link. + * - socket: The mode for a socket. + * - unknown: The mode for unknown types. */ #ifndef _di_f_mode_t_ typedef struct { @@ -563,9 +577,10 @@ extern "C" { * * The macros are defined in type_array.h or type_array-common.h. * - * array: An array of array lengths. - * size: Total amount of allocated space. - * used: Total number of allocated spaces used. + * Properties: + * - array: An array of array lengths. + * - size: Total amount of allocated space. + * - used: Total number of allocated spaces used. */ #ifndef _di_f_number_unsigneds_t_ typedef struct { @@ -586,9 +601,10 @@ extern "C" { * * The macros are defined in type_array.h or type_array-common.h. * - * array: The array of an array of array lengths. - * size: Total amount of allocated space. - * used: Total number of allocated spaces used. + * Properties: + * - array: The array of an array of array lengths. + * - size: Total amount of allocated space. + * - used: Total number of allocated spaces used. */ #ifndef _di_f_number_unsignedss_t_ typedef struct { @@ -609,9 +625,10 @@ extern "C" { * * The macros are defined in type_array.h or type_array-common.h. * - * array: An array of int8_t. - * size: Total amount of allocated space. - * used: Total number of allocated spaces used. + * Properties: + * - array: An array of int8_t. + * - size: Total amount of allocated space. + * - used: Total number of allocated spaces used. */ #ifndef _di_f_int8s_t_ typedef struct { @@ -632,9 +649,10 @@ extern "C" { * * The macros are defined in type_array.h or type_array-common.h. * - * array: The array of an array of array int8_t. - * size: Total amount of allocated space. - * used: Total number of allocated spaces used. + * Properties: + * - array: The array of an array of array int8_t. + * - size: Total amount of allocated space. + * - used: Total number of allocated spaces used. */ #ifndef _di_f_int8ss_t_ typedef struct { @@ -655,9 +673,10 @@ extern "C" { * * The macros are defined in type_array.h or type_array-common.h. * - * array: An array of uint8_t. - * size: Total amount of allocated space. - * used: Total number of allocated spaces used. + * Properties: + * - array: An array of uint8_t. + * - size: Total amount of allocated space. + * - used: Total number of allocated spaces used. */ #ifndef _di_f_uint8s_t_ typedef struct { @@ -678,9 +697,10 @@ extern "C" { * * The macros are defined in type_array.h or type_array-common.h. * - * array: The array of an array of array uint8_t. - * size: Total amount of allocated space. - * used: Total number of allocated spaces used. + * Properties: + * - array: The array of an array of array uint8_t. + * - size: Total amount of allocated space. + * - used: Total number of allocated spaces used. */ #ifndef _di_f_uint8ss_t_ typedef struct { @@ -701,9 +721,10 @@ extern "C" { * * The macros are defined in type_array.h or type_array-common.h. * - * array: An array of int16_t. - * size: Total amount of allocated space. - * used: Total number of allocated spaces used. + * Properties: + * - array: An array of int16_t. + * - size: Total amount of allocated space. + * - used: Total number of allocated spaces used. */ #ifndef _di_f_int16s_t_ typedef struct { @@ -724,9 +745,10 @@ extern "C" { * * The macros are defined in type_array.h or type_array-common.h. * - * array: The array of an array of array int16_t. - * size: Total amount of allocated space. - * used: Total number of allocated spaces used. + * Properties: + * - array: The array of an array of array int16_t. + * - size: Total amount of allocated space. + * - used: Total number of allocated spaces used. */ #ifndef _di_f_int16ss_t_ typedef struct { @@ -747,9 +769,10 @@ extern "C" { * * The macros are defined in type_array.h or type_array-common.h. * - * array: An array of uint16_t. - * size: Total amount of allocated space. - * used: Total number of allocated spaces used. + * Properties: + * - array: An array of uint16_t. + * - size: Total amount of allocated space. + * - used: Total number of allocated spaces used. */ #ifndef _di_f_uint16s_t_ typedef struct { @@ -770,9 +793,10 @@ extern "C" { * * The macros are defined in type_array.h or type_array-common.h. * - * array: The array of an array of array uint16_t. - * size: Total amount of allocated space. - * used: Total number of allocated spaces used. + * Properties: + * - array: The array of an array of array uint16_t. + * - size: Total amount of allocated space. + * - used: Total number of allocated spaces used. */ #ifndef _di_f_uint16ss_t_ typedef struct { @@ -793,9 +817,10 @@ extern "C" { * * The macros are defined in type_array.h or type_array-common.h. * - * array: An array of int32_t. - * size: Total amount of allocated space. - * used: Total number of allocated spaces used. + * Properties: + * - array: An array of int32_t. + * - size: Total amount of allocated space. + * - used: Total number of allocated spaces used. */ #ifndef _di_f_int32s_t_ typedef struct { @@ -816,9 +841,10 @@ extern "C" { * * The macros are defined in type_array.h or type_array-common.h. * - * array: The array of an array of array int32_t. - * size: Total amount of allocated space. - * used: Total number of allocated spaces used. + * Properties: + * - array: The array of an array of array int32_t. + * - size: Total amount of allocated space. + * - used: Total number of allocated spaces used. */ #ifndef _di_f_int32ss_t_ typedef struct { @@ -839,9 +865,10 @@ extern "C" { * * The macros are defined in type_array.h or type_array-common.h. * - * array: An array of uint32_t. - * size: Total amount of allocated space. - * used: Total number of allocated spaces used. + * Properties: + * - array: An array of uint32_t. + * - size: Total amount of allocated space. + * - used: Total number of allocated spaces used. */ #ifndef _di_f_uint32s_t_ typedef struct { @@ -862,9 +889,10 @@ extern "C" { * * The macros are defined in type_array.h or type_array-common.h. * - * array: The array of an array of array uint32_t. - * size: Total amount of allocated space. - * used: Total number of allocated spaces used. + * Properties: + * - array: The array of an array of array uint32_t. + * - size: Total amount of allocated space. + * - used: Total number of allocated spaces used. */ #ifndef _di_f_uint32ss_t_ typedef struct { @@ -885,9 +913,10 @@ extern "C" { * * The macros are defined in type_array.h or type_array-common.h. * - * array: An array of int64_t. - * size: Total amount of allocated space. - * used: Total number of allocated spaces used. + * Properties: + * - array: An array of int64_t. + * - size: Total amount of allocated space. + * - used: Total number of allocated spaces used. */ #ifndef _di_f_int64s_t_ typedef struct { @@ -908,9 +937,10 @@ extern "C" { * * The macros are defined in type_array.h or type_array-common.h. * - * array: The array of an array of array int64_t. - * size: Total amount of allocated space. - * used: Total number of allocated spaces used. + * Properties: + * - array: The array of an array of array int64_t. + * - size: Total amount of allocated space. + * - used: Total number of allocated spaces used. */ #ifndef _di_f_int64ss_t_ typedef struct { @@ -931,9 +961,10 @@ extern "C" { * * The macros are defined in type_array.h or type_array-common.h. * - * array: An array of uint64_t. - * size: Total amount of allocated space. - * used: Total number of allocated spaces used. + * Properties: + * - array: An array of uint64_t. + * - size: Total amount of allocated space. + * - used: Total number of allocated spaces used. */ #ifndef _di_f_uint64s_t_ typedef struct { @@ -954,9 +985,10 @@ extern "C" { * * The macros are defined in type_array.h or type_array-common.h. * - * array: The array of an array of array uint64_t. - * size: Total amount of allocated space. - * used: Total number of allocated spaces used. + * Properties: + * - array: The array of an array of array uint64_t. + * - size: Total amount of allocated space. + * - used: Total number of allocated spaces used. */ #ifndef _di_f_uint64ss_t_ typedef struct { @@ -1002,9 +1034,10 @@ extern "C" { * * The macros are defined in type_array.h or type_array-common.h. * - * array: The array of int128_t. - * size: Total amount of allocated space. - * used: Total number of allocated spaces used. + * Properties: + * - array: The array of int128_t. + * - size: Total amount of allocated space. + * - used: Total number of allocated spaces used. */ #ifndef _di_f_int128s_t_ typedef struct { @@ -1025,9 +1058,10 @@ extern "C" { * * The macros are defined in type_array.h or type_array-common.h. * - * array: The array of and array of int128_t. - * size: Total amount of allocated space. - * used: Total number of allocated spaces used. + * Properties: + * - array: The array of and array of int128_t. + * - size: Total amount of allocated space. + * - used: Total number of allocated spaces used. */ #ifndef _di_f_int128ss_t_ typedef struct { @@ -1048,9 +1082,10 @@ extern "C" { * * The macros are defined in type_array.h or type_array-common.h. * - * array: The array of uint128_t. - * size: Total amount of allocated space. - * used: Total number of allocated spaces used. + * Properties: + * - array: The array of uint128_t. + * - size: Total amount of allocated space. + * - used: Total number of allocated spaces used. */ #ifndef _di_f_uint128s_t_ typedef struct { @@ -1071,9 +1106,10 @@ extern "C" { * * The macros are defined in type_array.h or type_array-common.h. * - * array: The array of and array of uint128_t. - * size: Total amount of allocated space. - * used: Total number of allocated spaces used. + * Properties: + * - array: The array of and array of uint128_t. + * - size: Total amount of allocated space. + * - used: Total number of allocated spaces used. */ #ifndef _di_f_uint128ss_t_ typedef struct { @@ -1094,9 +1130,10 @@ extern "C" { * * The macros are defined in type_array.h or type_array-common.h. * - * array: The array of f_status_t arrays. - * size: Total amount of allocated space. - * used: Total number of allocated spaces used. + * Properties: + * - array: The array of f_status_t arrays. + * - size: Total amount of allocated space. + * - used: Total number of allocated spaces used. */ #ifndef _di_f_statuss_t_ typedef struct { @@ -1117,9 +1154,10 @@ extern "C" { * * The macros are defined in type_array.h or type_array-common.h. * - * array: The array of f_status_t arrays. - * size: Total amount of allocated space. - * used: Total number of allocated spaces used. + * Properties: + * - array: The array of f_status_t arrays. + * - size: Total amount of allocated space. + * - used: Total number of allocated spaces used. */ #ifndef _di_f_statusss_t_ typedef struct { @@ -1140,9 +1178,10 @@ extern "C" { * * The macros are defined in type_array.h or type_array-common.h. * - * array: The array of f_state_t arrays. - * size: Total amount of allocated space. - * used: Total number of allocated spaces used. + * Properties: + * - array: The array of f_state_t arrays. + * - size: Total amount of allocated space. + * - used: Total number of allocated spaces used. */ #ifndef _di_f_states_t_ typedef struct { @@ -1163,9 +1202,10 @@ extern "C" { * * The macros are defined in type_array.h or type_array-common.h. * - * array: The array of f_state_t arrays. - * size: Total amount of allocated space. - * used: Total number of allocated spaces used. + * Properties: + * - array: The array of f_state_t arrays. + * - size: Total amount of allocated space. + * - used: Total number of allocated spaces used. */ #ifndef _di_f_statess_t_ typedef struct { @@ -1205,9 +1245,10 @@ extern "C" { * * The name must only be "word" characters (therefore "-" is not allowed). * - * name: The string representing the name of the FLL Identifier (This is not a NULL terminated string). - * type: The code representing the type of the Identifier. - * used: A representation of how many bytes in name are in used (if 0, then there is no name, thus this can be seen as not a valid identifier). + * Properties: + * - name: The string representing the name of the FLL Identifier (This is not a NULL terminated string). + * - type: The code representing the type of the Identifier. + * - used: A representation of how many bytes in name are in used (if 0, then there is no name, thus this can be seen as not a valid identifier). */ #ifndef _di_f_fll_id_t_ #define f_fll_id_name_length_d 64 @@ -1238,9 +1279,10 @@ extern "C" { * * The macros are defined in type_array.h or type_array-common.h. * - * array: The array of f_fll_id_t. - * size: Total amount of allocated space. - * used: Total number of allocated spaces used. + * Properties: + * - array: The array of f_fll_id_t. + * - size: Total amount of allocated space. + * - used: Total number of allocated spaces used. */ #ifndef _di_f_fll_ids_t_ typedef struct { @@ -1261,9 +1303,10 @@ extern "C" { * * The macros are defined in type_array.h or type_array-common.h. * - * array: The array of f_fll_id_t arrays. - * size: Total amount of allocated space. - * used: Total number of allocated spaces used. + * Properties: + * - array: The array of f_fll_id_t arrays. + * - size: Total amount of allocated space. + * - used: Total number of allocated spaces used. */ #ifndef _di_f_fll_idss_t_ typedef struct { diff --git a/level_0/f_type/c/type_file.h b/level_0/f_type/c/type_file.h index 52cd3e5..f82c34b 100644 --- a/level_0/f_type/c/type_file.h +++ b/level_0/f_type/c/type_file.h @@ -149,11 +149,12 @@ extern "C" { /** * Commonly used file related properties. * - * stream: File stream. - * id: File descriptor, with a value of -1 represents a closed file. - * flag: Flags used for opening the file. - * size_read: The default number of 1-byte characters to read at a time and is often used for the read buffer size. - * size_write: The default number of 1-byte characters to read at a time and is often used for the write buffer size. + * Properties: + * - stream: File stream. + * - id: File descriptor, with a value of -1 represents a closed file. + * - flag: Flags used for opening the file. + * - size_read: The default number of 1-byte characters to read at a time and is often used for the read buffer size. + * - size_write: The default number of 1-byte characters to read at a time and is often used for the write buffer size. */ #ifndef _di_f_file_t_ typedef struct { @@ -191,9 +192,10 @@ extern "C" { * * The macros are defined in type_array.h or type_array_file.h. * - * array: The array of f_file_t. - * size: Total amount of allocated space. - * used: Total number of allocated spaces used. + * Properties: + * - array: The array of f_file_t. + * - size: Total amount of allocated space. + * - used: Total number of allocated spaces used. */ #ifndef _di_f_files_t_ typedef struct { @@ -214,9 +216,10 @@ extern "C" { * * The macros are defined in type_array.h or type_array_file.h. * - * array: The array of f_file_t arrays. - * size: Total amount of allocated space. - * used: Total number of allocated spaces used. + * Properties: + * - array: The array of f_file_t arrays. + * - size: Total amount of allocated space. + * - used: Total number of allocated spaces used. */ #ifndef _di_f_filess_t_ typedef struct { @@ -299,9 +302,10 @@ extern "C" { * The nfds_t is often either uint32_t or an uint64_t. * The f_number_unsigned_t is often an uint64_t. * - * array: An array of f_poll_t. - * size: Total amount of allocated space. - * used: Total number of allocated spaces used. + * Properties: + * - array: An array of f_poll_t. + * - size: Total amount of allocated space. + * - used: Total number of allocated spaces used. */ #ifndef _di_f_polls_t_ typedef struct { @@ -322,9 +326,10 @@ extern "C" { * * The macros are defined in type_array.h or type_array_file.h. * - * array: The array of f_polls_t. - * size: Total amount of allocated space. - * used: Total number of allocated spaces used. + * Properties: + * - array: The array of f_polls_t. + * - size: Total amount of allocated space. + * - used: Total number of allocated spaces used. */ #ifndef _di_f_pollss_t_ typedef struct { diff --git a/level_0/f_utf/c/utf/map.h b/level_0/f_utf/c/utf/map.h index 11b0244..e7fd4b2 100644 --- a/level_0/f_utf/c/utf/map.h +++ b/level_0/f_utf/c/utf/map.h @@ -19,8 +19,9 @@ extern "C" { /** * A string map consisting of a name and value. * - * name: A string representing the map name. - * value: A string representing the map value. + * Properties: + * - name: A string representing the map name. + * - value: A string representing the map value. */ #ifndef _di_f_utf_string_map_t_ typedef struct { diff --git a/level_0/f_utf/c/utf/map_multi.h b/level_0/f_utf/c/utf/map_multi.h index b702c4d..68e6ad4 100644 --- a/level_0/f_utf/c/utf/map_multi.h +++ b/level_0/f_utf/c/utf/map_multi.h @@ -19,8 +19,9 @@ extern "C" { /** * A string map consisting of a name and multiple values. * - * name: A string representing the map name. - * value: An array of strings representing the map value. + * Properties: + * - name: A string representing the map name. + * - value: An array of strings representing the map value. */ #ifndef _di_f_utf_string_map_multi_t_ typedef struct { diff --git a/level_0/f_utf/c/utf/map_multis.h b/level_0/f_utf/c/utf/map_multis.h index 5ec9fdd..3c01df3 100644 --- a/level_0/f_utf/c/utf/map_multis.h +++ b/level_0/f_utf/c/utf/map_multis.h @@ -19,9 +19,10 @@ extern "C" { /** * An array of string maps. * - * array: the array of string maps. - * size: total amount of allocated space. - * used: total number of allocated spaces used. + * Properties: + * - array: The array of string maps. + * - size: Total amount of allocated space. + * - used: Total number of allocated spaces used. */ #ifndef _di_f_utf_string_map_multis_t_ typedef struct { diff --git a/level_0/f_utf/c/utf/map_multiss.h b/level_0/f_utf/c/utf/map_multiss.h index f64a397..13bb564 100644 --- a/level_0/f_utf/c/utf/map_multiss.h +++ b/level_0/f_utf/c/utf/map_multiss.h @@ -19,9 +19,10 @@ extern "C" { /** * An array of string maps. * - * array: the array of an array of string maps. - * size: total amount of allocated space. - * used: total number of allocated spaces used. + * Properties: + * - array: The array of an array of string maps. + * - size: Total amount of allocated space. + * - used: Total number of allocated spaces used. */ #ifndef _di_f_utf_string_map_multiss_t_ typedef struct { diff --git a/level_0/f_utf/c/utf/maps.h b/level_0/f_utf/c/utf/maps.h index 693a53a..16edf57 100644 --- a/level_0/f_utf/c/utf/maps.h +++ b/level_0/f_utf/c/utf/maps.h @@ -19,9 +19,10 @@ extern "C" { /** * An array of string maps. * - * array: the array of string maps. - * size: total amount of allocated space. - * used: total number of allocated spaces used. + * Properties: + * - array: The array of string maps. + * - size: Total amount of allocated space. + * - used: Total number of allocated spaces used. */ #ifndef _di_f_utf_string_maps_t_ typedef struct { diff --git a/level_0/f_utf/c/utf/mapss.h b/level_0/f_utf/c/utf/mapss.h index f34ecec..38f7511 100644 --- a/level_0/f_utf/c/utf/mapss.h +++ b/level_0/f_utf/c/utf/mapss.h @@ -19,9 +19,10 @@ extern "C" { /** * An array of string maps. * - * array: the array of an array of string maps. - * size: total amount of allocated space. - * used: total number of allocated spaces used. + * Properties: + * - array: The array of an array of string maps. + * - size: Total amount of allocated space. + * - used: Total number of allocated spaces used. */ #ifndef _di_f_utf_string_mapss_t_ typedef struct { diff --git a/level_0/f_utf/c/utf/static.h b/level_0/f_utf/c/utf/static.h index d616a7c..9ce7632 100644 --- a/level_0/f_utf/c/utf/static.h +++ b/level_0/f_utf/c/utf/static.h @@ -24,9 +24,10 @@ extern "C" { * 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. * - * string: The string. - * size: Total amount of space available. - * used: Total number of space used. + * Properties: + * - string: The string. + * - size: Total amount of space available. + * - used: Total number of space used. */ #ifndef _di_f_utf_string_static_t_ typedef struct { diff --git a/level_0/f_utf/c/utf/statics.h b/level_0/f_utf/c/utf/statics.h index e90aee8..ea06898 100644 --- a/level_0/f_utf/c/utf/statics.h +++ b/level_0/f_utf/c/utf/statics.h @@ -19,9 +19,10 @@ extern "C" { /** * An array of static strings. * - * array: The array of static strings. - * size: Total amount of space available. - * used: Total number of space used. + * Properties: + * - array: The array of static strings. + * - size: Total amount of space available. + * - used: Total number of space used. */ #ifndef _di_f_utf_string_statics_t_ typedef struct { diff --git a/level_0/f_utf/c/utf/staticss.h b/level_0/f_utf/c/utf/staticss.h index 51f878f..eeb68e3 100644 --- a/level_0/f_utf/c/utf/staticss.h +++ b/level_0/f_utf/c/utf/staticss.h @@ -19,9 +19,10 @@ extern "C" { /** * An array of static strings. * - * array: The array of static strings. - * size: Total amount of space available. - * used: Total number of space used. + * Properties: + * - array: The array of static strings. + * - size: Total amount of space available. + * - used: Total number of space used. */ #ifndef _di_f_utf_string_staticss_t_ typedef struct { diff --git a/level_0/f_utf/c/utf/triple.h b/level_0/f_utf/c/utf/triple.h index e644b9e..6da73d4 100644 --- a/level_0/f_utf/c/utf/triple.h +++ b/level_0/f_utf/c/utf/triple.h @@ -19,9 +19,10 @@ extern "C" { /** * A string triple consisting of a set of three strings. * - * a: A string representing the first string in the triple. - * b: A string representing the second string in the triple. - * c: A string representing the third string in the triple. + * Properties: + * - a: A string representing the first string in the triple. + * - b: A string representing the second string in the triple. + * - c: A string representing the third string in the triple. */ #ifndef _di_f_utf_string_triple_t_ typedef struct { diff --git a/level_0/f_utf/c/utf/triples.h b/level_0/f_utf/c/utf/triples.h index d50a808..b3b7a22 100644 --- a/level_0/f_utf/c/utf/triples.h +++ b/level_0/f_utf/c/utf/triples.h @@ -19,9 +19,10 @@ extern "C" { /** * An array of string triples. * - * array: The array of string triples. - * size: Total amount of allocated space. - * used: Total number of allocated spaces used. + * Properties: + * - array: The array of string triples. + * - size: Total amount of allocated space. + * - used: Total number of allocated spaces used. */ #ifndef _di_f_utf_string_triples_t_ typedef struct { diff --git a/level_0/f_utf/c/utf/tripless.h b/level_0/f_utf/c/utf/tripless.h index a92615c..339ea38 100644 --- a/level_0/f_utf/c/utf/tripless.h +++ b/level_0/f_utf/c/utf/tripless.h @@ -19,9 +19,10 @@ extern "C" { /** * An array of string tripless. * - * array: The array of string triples. - * size: Total amount of allocated space. - * used: Total number of allocated spaces used. + * Properties: + * - array: The array of string triples. + * - size: Total amount of allocated space. + * - used: Total number of allocated spaces used. */ #ifndef _di_f_utf_string_tripless_t_ typedef struct { diff --git a/level_1/fl_conversion/c/conversion/common.h b/level_1/fl_conversion/c/conversion/common.h index 6a597b9..7e8f078 100644 --- a/level_1/fl_conversion/c/conversion/common.h +++ b/level_1/fl_conversion/c/conversion/common.h @@ -19,8 +19,9 @@ extern "C" { /** * Provide a structure for customizing conversion settings for a conversion function to use. * - * base: The base unit the number is to be represented as, only the numbers 2 through 16 are supported as a base. - * flag: Store flags from fl_conversion_data_flag_*. + * Properties: + * - base: The base unit the number is to be represented as, only the numbers 2 through 16 are supported as a base. + * - flag: Store flags from fl_conversion_data_flag_*. */ #ifndef _di_fl_conversion_data_t_ typedef struct { diff --git a/level_1/fl_execute/c/execute/common.h b/level_1/fl_execute/c/execute/common.h index 4fe68f2..797c987 100644 --- a/level_1/fl_execute/c/execute/common.h +++ b/level_1/fl_execute/c/execute/common.h @@ -19,11 +19,12 @@ extern "C" { /** * A structure for containing additional parameters for the execute functions that call the execv() family of functions. * - * option: Accepts the bitwise options - * wait: Represents options passed to waitpid(), such as WUNTRACED. - * environment: The environment variable name and value pairs, set to 0 to not use. - * signals: The set of signals the child process should or should block, set to 0 to not use. - * data: The data to pipe to the child process, set to 0 to not use. + * Properties: + * - option: Accepts the bitwise options + * - wait: Represents options passed to waitpid(), such as WUNTRACED. + * - environment: The environment variable name and value pairs, set to 0 to not use. + * - signals: The set of signals the child process should or should block, set to 0 to not use. + * - data: The data to pipe to the child process, set to 0 to not use. */ #ifndef _di_fl_execute_parameter_t_ typedef struct { @@ -75,15 +76,16 @@ extern "C" { * Control Groups, or cgroups, exist here as a full file path in which the PID of a child process is to be written to. * This may change as more is learned about using cgroups, but it is not known if there are any functions available like set_cgroup(..). * - * nice: the niceness value to assign the child process to, set to 0 to not use. - * id_user: the id of the user to assign the child process to, set to 0 to not use. - * id_group: the id of the group to assign the child process to, set to 0 to not use. - * affinity: the cpu affinity to assign the child process to, set to 0 to not use (this is an array of CPU ids, starting from 0). - * capability: all of the capabilities to assign the child process to, set to 0 to not use (f_capability_t is a pointer). - * control_group: an array of cgroups (control groups) to assign the child PID to, set to 0 to not use. - * limits: the resource limits to assign the child process to, set to 0 to not use. - * id_groups: the ids of each supplemental group to assign the child process to, set to 0 to not use. - * scheduler: the scheduler to assign the child process to, set to 0 to not use. + * Properties: + * - nice: The niceness value to assign the child process to, set to 0 to not use. + * - id_user: The id of the user to assign the child process to, set to 0 to not use. + * - id_group: The id of the group to assign the child process to, set to 0 to not use. + * - affinity: The cpu affinity to assign the child process to, set to 0 to not use (this is an array of CPU ids, starting from 0). + * - capability: All of the capabilities to assign the child process to, set to 0 to not use (f_capability_t is a pointer). + * - control_group: An array of cgroups (control groups) to assign the child PID to, set to 0 to not use. + * - limits: The resource limits to assign the child process to, set to 0 to not use. + * - id_groups: The ids of each supplemental group to assign the child process to, set to 0 to not use. + * - scheduler: The scheduler to assign the child process to, set to 0 to not use. */ #ifndef _di_fl_execute_as_t_ typedef struct { diff --git a/level_1/fl_print/c/print/common.h b/level_1/fl_print/c/print/common.h index 914a23e..8a317c9 100644 --- a/level_1/fl_print/c/print/common.h +++ b/level_1/fl_print/c/print/common.h @@ -49,18 +49,19 @@ extern "C" { /** * Structure for facilitating colored or other managed printing. * - * to: The file to print to. - * verbosity: The verbosity mode. - * flag: A set of flags, bitwise or otherwise, made available for more advanced manipulation. + * Properties: + * - to: The file to print to. + * - verbosity: The verbosity mode. + * - flag: A set of flags, bitwise or otherwise, made available for more advanced manipulation. * - * prefix: An optional prefix string for displaying before any special messages. - * suffix: An optional suffix string for displaying after any special messages. + * - prefix: An optional prefix string for displaying before any special messages. + * - suffix: An optional suffix string for displaying after any special messages. * - * context: The color codes for the entire error message. - * notable: The color codes for a part of the message to make more visible. - * set: An optional pointer to a set of all available color contexts for explicit use. + * - context: The color codes for the entire error message. + * - notable: The color codes for a part of the message to make more visible. + * - set: An optional pointer to a set of all available color contexts for explicit use. * - * custom: A pointer to a data structure determined by some caller for more advanced manipulation. + * - custom: A pointer to a data structure determined by some caller for more advanced manipulation. */ #ifndef _di_fl_print_t_ typedef struct { diff --git a/level_1/fl_signal/c/signal/common.h b/level_1/fl_signal/c/signal/common.h index 79ee622..da86c49 100644 --- a/level_1/fl_signal/c/signal/common.h +++ b/level_1/fl_signal/c/signal/common.h @@ -19,9 +19,10 @@ extern "C" { /** * A structure intended to be used as the "data" structure for f_state_t for interrupt related functionality. * - * interrupts: An array of signal codes to treat as interrupts. - * signal: The signal structure to use. - * trigger: The signal that triggered the interrupt, if applicable. + * Properties: + * - interrupts: An array of signal codes to treat as interrupts. + * - signal: The signal structure to use. + * - trigger: The signal that triggered the interrupt, if applicable. */ #ifndef _di_fl_signal_interrupt_t_ typedef struct { diff --git a/level_2/fll_program/c/program/common.h b/level_2/fll_program/c/program/common.h index 340b50e..0644b9d 100644 --- a/level_2/fll_program/c/program/common.h +++ b/level_2/fll_program/c/program/common.h @@ -63,24 +63,25 @@ extern "C" { * The macro macro_fll_program_console_parameter_standard_initialize provides the standard program parameters to include when initializing the parameters variable. * The last comma is not provided, the caller should add the comma to macro_fll_program_console_parameter_standard_initialize as necessary. * - * parameters: The state of pre-defined parameters passed to the program. - * environment: Environment variables passed to the program. + * Properties: + * - parameters: The state of pre-defined parameters passed to the program. + * - environment: Environment variables passed to the program. * - * umask: The umask settings, needed for avoiding calls to umask() to read the current umask. - * pid: The PID of the program. - * child: Reserved for a child process, often representing the child return status or the child process ID. - * pipe: Designate that a pipe exists and is available for use. + * - umask: The umask settings, needed for avoiding calls to umask() to read the current umask. + * - pid: The PID of the program. + * - child: Reserved for a child process, often representing the child return status or the child process ID. + * - pipe: Designate that a pipe exists and is available for use. * - * signal_check: A counter used to map to for reducing the amount of actual signal check calls. - * signal_received: The signal received (if 0, then no signal is received). - * signal: The process signal management structure. + * - signal_check: A counter used to map to for reducing the amount of actual signal check calls. + * - signal_received: The signal received (if 0, then no signal is received). + * - signal: The process signal management structure. * - * message: The output file for normal output messages (often stdout). - * 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. + * - message: The output file for normal output messages (often stdout). + * - 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. * - * context: The color context. + * - context: The color context. */ #ifndef _di_fll_program_data_t_ typedef struct { diff --git a/level_3/byte_dump/c/common.h b/level_3/byte_dump/c/common.h index 4b19b10..62c272d 100644 --- a/level_3/byte_dump/c/common.h +++ b/level_3/byte_dump/c/common.h @@ -398,9 +398,9 @@ extern "C" { * This is passed to the program-specific main entry point to designate program settings. * These program settings are often processed from the program arguments (often called the command line arguments). * - * flag: Flags passed to the main function. - * - * state: The state information. + * Properties: + * - flag: Flags passed to the main function. + * - state: The state information. */ #ifndef _di_byte_dump_setting_t_ typedef struct { diff --git a/level_3/byte_dump/c/private-common.h b/level_3/byte_dump/c/private-common.h index 12c01cb..ae6df89 100644 --- a/level_3/byte_dump/c/private-common.h +++ b/level_3/byte_dump/c/private-common.h @@ -15,14 +15,15 @@ extern "C" { /** * The program data. * - * argv: The argument structure in the progam data parameters for simplifying syntax. - * first: The first position. - * last: The last position. - * main: The main program data. - * mode: The digit representation mode. - * options: Additional options. - * presentation: The presentation mode. - * width: The number of columns. + * Properties: + * - argv: The argument structure in the progam data parameters for simplifying syntax. + * - first: The first position. + * - last: The last position. + * - main: The main program data. + * - mode: The digit representation mode. + * - options: Additional options. + * - presentation: The presentation mode. + * - width: The number of columns. */ #ifndef _di_byte_dump_data_t_ typedef struct { @@ -53,8 +54,9 @@ extern "C" { /** * A main structure for character row and column position (cell). * - * column: The column position associated with the character cell. - * row: The row position associated with the character cell. + * Properties: + * - column: The column position associated with the character cell. + * - row: The row position associated with the character cell. */ #ifndef _di_byte_dump_cell_t_ typedef struct { @@ -75,10 +77,11 @@ extern "C" { * UTF-8 Characters bytes may overflow beyond the main.width. * These overflowed bytes should still have placeholders printed in the next text-mode print. * - * bytes: The number of previous bytes that overflowed from the previous line. - * This is used to print the placeholders for the "text" option. - * invalid: The specific invalid value provided representing the overflowed bytes. - * This is used to print the placeholders. + * Properties: + * - bytes: The number of previous bytes that overflowed from the previous line. + * This is used to print the placeholders for the "text" option. + * - invalid: The specific invalid value provided representing the overflowed bytes. + * This is used to print the placeholders. */ #ifndef _di_byte_dump_previous_t_ typedef struct { diff --git a/level_3/fake/c/main/common/type.h b/level_3/fake/c/main/common/type.h index dd2531f..95d86ad 100644 --- a/level_3/fake/c/main/common/type.h +++ b/level_3/fake/c/main/common/type.h @@ -19,14 +19,15 @@ extern "C" { /** * A structure for managing the operation and if-condition states. * - * block: The process block state. - * block_result: The result of the block. - * condition: The current if-condition type. - * condition_result: The result of the currently processed condition. - * operation: The current operation type. - * operation_previous: The previous operation type. - * success: Current state is considered success when F_true and failure when F_false. - * success_block: Current block state is considered success when F_true and failure when F_false. + * Properties: + * - block: The process block state. + * - block_result: The result of the block. + * - condition: The current if-condition type. + * - condition_result: The result of the currently processed condition. + * - operation: The current operation type. + * - operation_previous: The previous operation type. + * - success: Current state is considered success when F_true and failure when F_false. + * - success_block: Current block state is considered success when F_true and failure when F_false. */ #ifndef _di_fake_state_process_t_ typedef struct { @@ -58,23 +59,24 @@ extern "C" { * This is passed to the program-specific main entry point to designate program settings. * These program settings are often processed from the program arguments (often called the command line arguments). * - * flag: Flags passed to the main function. + * Properties: + * - flag: Flags passed to the main function. * - * status_signal: A status used eclusively by the threaded signal handler. - * state: The state data used when processing the FSS data. + * - status_signal: A status used eclusively by the threaded signal handler. + * - state: The state data used when processing the FSS data. * - * build: The build directory. - * data: The data directory. - * fakefile: The fakefile file path. - * process: The process name. - * settings: The settings file path. - * sources: The sources directory. - * work: The work directory. + * - build: The build directory. + * - data: The data directory. + * - fakefile: The fakefile file path. + * - process: The process name. + * - settings: The settings file path. + * - sources: The sources directory. + * - work: The work directory. - * defines: The define data. - * modes: The mode data. + * - defines: The define data. + * - modes: The mode data. * - * operations: The operations, in the order in which they are given. + * - operations: The operations, in the order in which they are given. */ #ifndef _di_fake_setting_t_ typedef struct { @@ -125,15 +127,16 @@ extern "C" { * program: The main program data. * setting: The settings data. * - * buffer: A string buffer cache often used for files and often held longe than other caches. - * cache_1: A string cache. - * cache_2: A string cache. - * cache_argument: A string cache for some argument. - * cache_argument: A string cache for some path. - * cache_arguments: An array of strings cache for arguments. - * cache_map: A string map cache. - * cache_iki: IKI data cache. - * cache_recurse_do: A cache for the directory recursion do function. + * Properties: + * - buffer: A string buffer cache often used for files and often held longe than other caches. + * - cache_1: A string cache. + * - cache_2: A string cache. + * - cache_argument: A string cache for some argument. + * - cache_argument: A string cache for some path. + * - cache_arguments: An array of strings cache for arguments. + * - cache_map: A string map cache. + * - cache_iki: IKI data cache. + * - cache_recurse_do: A cache for the directory recursion do function. */ #ifndef _di_fake_main_t_ typedef struct { @@ -168,55 +171,56 @@ extern "C" { /** * The program data. * - * operation: A code representing the currrent operation. - * - * path_build: The build path. - * path_build_documentation: The build documentation path. - * path_build_documents: The build documents path. - * path_build_includes: The build includes path. - * path_build_libraries: The build libraries path. - * path_build_libraries_script: The build libraries_script path. - * path_build_libraries_shared: The build libraries_shared path. - * path_build_libraries_static: The build libraries_static path. - * path_build_objects: The build objects path. - * path_build_objects_script: The build objects_script path. - * path_build_objects_shared: The build objects_shared path. - * path_build_objects_static: The build objects_static path. - * path_build_programs: The build programs path. - * path_build_programs_script: The build programs_script path. - * path_build_programs_shared: The build programs_shared path. - * path_build_programs_static: The build programs_static path. - * path_build_settings: The build settings path. - * path_build_stage: The build stage path. - * - * path_data_build: The build data path. - * path_data_documentation: The documentation data path. - * path_data_settings: The settings data path. - * - * path_documents: The documents path. - * path_licenses: The licenses path. - * path_sources: The sources path. - * - * path_work_includes: The includes work path. - * path_work_libraries: The libraries work path. - * path_work_libraries_script: The libraries_script work path. - * path_work_libraries_shared: The libraries_shared work path. - * path_work_libraries_static: The libraries_static work path. - * path_work_programs: The programs work path. - * path_work_programs_script: The programs_script work path. - * path_work_programs_shared: The programs_shared work path. - * path_work_programs_static: The programs_static work path. - * - * file_data_build_defines: The defines build file data. - * file_data_build_dependencies: The dependencies build file data. - * file_data_build_fakefile: The fakefile build file data. - * file_data_build_process_post: The process_post_s build file data. - * file_data_build_process_pre: The process_pre_s build file data. - * file_data_build_settings: The settings build file data. - * - * file_documents_readme: The documents readme file data. - * - * main: The program and settings data. + * Properties: + * - operation: A code representing the currrent operation. + * + * - path_build: The build path. + * - path_build_documentation: The build documentation path. + * - path_build_documents: The build documents path. + * - path_build_includes: The build includes path. + * - path_build_libraries: The build libraries path. + * - path_build_libraries_script: The build libraries_script path. + * - path_build_libraries_shared: The build libraries_shared path. + * - path_build_libraries_static: The build libraries_static path. + * - path_build_objects: The build objects path. + * - path_build_objects_script: The build objects_script path. + * - path_build_objects_shared: The build objects_shared path. + * - path_build_objects_static: The build objects_static path. + * - path_build_programs: The build programs path. + * - path_build_programs_script: The build programs_script path. + * - path_build_programs_shared: The build programs_shared path. + * - path_build_programs_static: The build programs_static path. + * - path_build_settings: The build settings path. + * - path_build_stage: The build stage path. + * + * - path_data_build: The build data path. + * - path_data_documentation: The documentation data path. + * - path_data_settings: The settings data path. + * + * - path_documents: The documents path. + * - path_licenses: The licenses path. + * - path_sources: The sources path. + * + * - path_work_includes: The includes work path. + * - path_work_libraries: The libraries work path. + * - path_work_libraries_script: The libraries_script work path. + * - path_work_libraries_shared: The libraries_shared work path. + * - path_work_libraries_static: The libraries_static work path. + * - path_work_programs: The programs work path. + * - path_work_programs_script: The programs_script work path. + * - path_work_programs_shared: The programs_shared work path. + * - path_work_programs_static: The programs_static work path. + * + * - file_data_build_defines: The defines build file data. + * - file_data_build_dependencies: The dependencies build file data. + * - file_data_build_fakefile: The fakefile build file data. + * - file_data_build_process_post: The process_post_s build file data. + * - file_data_build_process_pre: The process_pre_s build file data. + * - file_data_build_settings: The settings build file data. + * + * - file_documents_readme: The documents readme file data. + * + * - main: The program and settings data. */ #ifndef _di_fake_data_t_ typedef struct { @@ -320,9 +324,10 @@ extern "C" { /** * The program data for local operations so that custom data can be passed to functions. * - * main: The program and settings data. - * custom_1: Custom data that both the caller and the called function know to expect. - * custom_2: Custom data that both the caller and the called function know to expect. + * Properties: + * - main: The program and settings data. + * - custom_1: Custom data that both the caller and the called function know to expect. + * - custom_2: Custom data that both the caller and the called function know to expect. */ #ifndef _di_fake_local_t_ typedef struct { @@ -349,103 +354,104 @@ extern "C" { /** * Build settings data. * - * flag: Flags from data_build_setting_* (Not strictly part of the build settings file). - * - * build_language: The build_language setting. - * - * version_file: The version_file setting. - * version_target: The version_target setting. - * - * build_script: The build_script setting. - * build_shared: The build_shared setting. - * build_static: The build_static setting. - * - * has_path_standard: The has_path_standard setting. - * preserve_path_headers: The preserve_path_headers setting. - * - * search_exclusive: The search_exclusive setting. - * search_shared: The search_shared setting. - * search_static: The search_static setting. - * - * build_compiler: The build_compiler setting. - * build_indexer: The build_indexer setting. - * build_name: The build_name setting. - * build_sources_object: The build_sources_object setting. - * build_sources_object_shared: The build_sources_object_shared setting. - * build_sources_object_static: The build_sources_object_static setting. - * path_headers: The path_headers setting. - * path_language: The path_language setting. - * path_library_script: The path_library_script setting. - * path_library_shared: The path_library_shared setting. - * path_library_static: The path_library_static setting. - * path_object_script: The path_object_script setting. - * path_object_shared: The path_object_shared setting. - * path_object_static: The path_object_static setting. - * path_program_script: The path_program_script setting. - * path_program_shared: The path_program_shared setting. - * path_program_static: The path_program_static setting. - * path_sources: The path_sources setting. - * path_sources_object: The path_sources_object setting. - * process_post: The process_post setting. - * process_pre: The process_pre setting. - * version_major: The version_major setting. - * version_major_prefix: The version_major_prefix setting. - * version_micro: The version_micro setting. - * version_micro_prefix: The version_micro_prefix setting. - * version_minor: The version_minor setting. - * version_minor_prefix: The version_minor_prefix setting. - * version_nano: The version_nano setting. - * version_nano_prefix: The version_nano_prefix setting. - * - * build_indexer_arguments: The build_indexer_arguments setting. - * build_libraries: The build_libraries setting. - * build_libraries_shared: The build_libraries_shared setting. - * build_libraries_static: The build_libraries_static setting. - * build_objects_library: The build_objects_library setting. - * build_objects_library_shared: The build_objects_library_shared setting. - * build_objects_library_static: The build_objects_library_static setting. - * build_objects_program: The build_objects_program setting. - * build_objects_program_shared: The build_objects_program_shared setting. - * build_objects_program_static: The build_objects_program_static setting. - * build_sources_documentation: The build_sources_documentation setting. - * build_sources_headers: The build_sources_headers setting. - * build_sources_headers_shared: The build_sources_headers_shared setting. - * build_sources_headers_static: The build_sources_headers_static setting. - * build_sources_library: The build_sources_library setting. - * build_sources_library_shared: The build_sources_library_shared setting. - * build_sources_library_static: The build_sources_library_static setting. - * build_sources_program: The build_sources_program setting. - * build_sources_program_shared: The build_sources_program_shared setting. - * build_sources_program_static: The build_sources_program_static setting. - * build_sources_script: The build_sources_script setting. - * build_sources_setting: The build_sources_setting setting. - * defines: The defines setting. - * defines_library: The defines_library setting. - * defines_library_shared: The defines_library_shared setting. - * defines_library_static: The defines_library_static setting. - * defines_object: The defines_object setting. - * defines_object_shared: The defines_object_shared setting. - * defines_object_static: The defines_object_static setting. - * defines_program: The defines_program setting. - * defines_program_shared: The defines_program_shared setting. - * defines_program_static: The defines_program_static setting. - * defines_shared: The defines_shared setting. - * defines_static: The defines_static setting. - * environment: The environment setting. - * flags: The flags setting. - * flags_library: The flags_library setting. - * flags_library_shared: The flags_library_shared setting. - * flags_library_static: The flags_library_static setting. - * flags_object: The flags_object setting. - * flags_object_shared: The flags_object_shared setting. - * flags_object_static: The flags_object_static setting. - * flags_program: The flags_program setting. - * flags_program_shared: The flags_program_shared setting. - * flags_program_static: The flags_program_static setting. - * flags_shared: The flags_shared setting. - * flags_static: The flags_static setting. - * modes: The modes setting. - * modes_default: The modes_default setting. + * Properties: + * - flag: Flags from data_build_setting_* (Not strictly part of the build settings file). + * + * - build_language: The build_language setting. + * + * - version_file: The version_file setting. + * - version_target: The version_target setting. + * + * - build_script: The build_script setting. + * - build_shared: The build_shared setting. + * - build_static: The build_static setting. + * + * - has_path_standard: The has_path_standard setting. + * - preserve_path_headers: The preserve_path_headers setting. + * + * - search_exclusive: The search_exclusive setting. + * - search_shared: The search_shared setting. + * - search_static: The search_static setting. + * + * - build_compiler: The build_compiler setting. + * - build_indexer: The build_indexer setting. + * - build_name: The build_name setting. + * - build_sources_object: The build_sources_object setting. + * - build_sources_object_shared: The build_sources_object_shared setting. + * - build_sources_object_static: The build_sources_object_static setting. + * - path_headers: The path_headers setting. + * - path_language: The path_language setting. + * - path_library_script: The path_library_script setting. + * - path_library_shared: The path_library_shared setting. + * - path_library_static: The path_library_static setting. + * - path_object_script: The path_object_script setting. + * - path_object_shared: The path_object_shared setting. + * - path_object_static: The path_object_static setting. + * - path_program_script: The path_program_script setting. + * - path_program_shared: The path_program_shared setting. + * - path_program_static: The path_program_static setting. + * - path_sources: The path_sources setting. + * - path_sources_object: The path_sources_object setting. + * - process_post: The process_post setting. + * - process_pre: The process_pre setting. + * - version_major: The version_major setting. + * - version_major_prefix: The version_major_prefix setting. + * - version_micro: The version_micro setting. + * - version_micro_prefix: The version_micro_prefix setting. + * - version_minor: The version_minor setting. + * - version_minor_prefix: The version_minor_prefix setting. + * - version_nano: The version_nano setting. + * - version_nano_prefix: The version_nano_prefix setting. + * + * - build_indexer_arguments: The build_indexer_arguments setting. + * - build_libraries: The build_libraries setting. + * - build_libraries_shared: The build_libraries_shared setting. + * - build_libraries_static: The build_libraries_static setting. + * - build_objects_library: The build_objects_library setting. + * - build_objects_library_shared: The build_objects_library_shared setting. + * - build_objects_library_static: The build_objects_library_static setting. + * - build_objects_program: The build_objects_program setting. + * - build_objects_program_shared: The build_objects_program_shared setting. + * - build_objects_program_static: The build_objects_program_static setting. + * - build_sources_documentation: The build_sources_documentation setting. + * - build_sources_headers: The build_sources_headers setting. + * - build_sources_headers_shared: The build_sources_headers_shared setting. + * - build_sources_headers_static: The build_sources_headers_static setting. + * - build_sources_library: The build_sources_library setting. + * - build_sources_library_shared: The build_sources_library_shared setting. + * - build_sources_library_static: The build_sources_library_static setting. + * - build_sources_program: The build_sources_program setting. + * - build_sources_program_shared: The build_sources_program_shared setting. + * - build_sources_program_static: The build_sources_program_static setting. + * - build_sources_script: The build_sources_script setting. + * - build_sources_setting: The build_sources_setting setting. + * - defines: The defines setting. + * - defines_library: The defines_library setting. + * - defines_library_shared: The defines_library_shared setting. + * - defines_library_static: The defines_library_static setting. + * - defines_object: The defines_object setting. + * - defines_object_shared: The defines_object_shared setting. + * - defines_object_static: The defines_object_static setting. + * - defines_program: The defines_program setting. + * - defines_program_shared: The defines_program_shared setting. + * - defines_program_static: The defines_program_static setting. + * - defines_shared: The defines_shared setting. + * - defines_static: The defines_static setting. + * - environment: The environment setting. + * - flags: The flags setting. + * - flags_library: The flags_library setting. + * - flags_library_shared: The flags_library_shared setting. + * - flags_library_static: The flags_library_static setting. + * - flags_object: The flags_object setting. + * - flags_object_shared: The flags_object_shared setting. + * - flags_object_static: The flags_object_static setting. + * - flags_program: The flags_program setting. + * - flags_program_shared: The flags_program_shared setting. + * - flags_program_static: The flags_program_static setting. + * - flags_shared: The flags_shared setting. + * - flags_static: The flags_static setting. + * - modes: The modes setting. + * - modes_default: The modes_default setting. */ #ifndef _di_fake_build_setting_t_ typedef struct { @@ -644,6 +650,28 @@ extern "C" { #define fake_build_setting_total_d 89 #endif // _di_fake_build_setting_t_ +/** + * The build stage data. + * + * Properties: + * - file_library_script: The script library files. + * - file_library_shared: The shared library files. + * - file_library_static: The static library files. + * - file_object_script: The script object files. + * - file_object_shared: The shared object files. + * - file_object_static: The static object files. + * - file_objects_static: The static objects files. + * - file_process_post: The post-process files. + * - file_process_pre: The pre-process files. + * - file_program_script: The script program files. + * - file_program_shared: The shared program files. + * - file_program_static: The static program files. + * - file_skeleton: The skeleton files. + * - file_sources_documentation: The documentation source files. + * - file_sources_headers: The header source files. + * - file_sources_script: The script source files. + * - file_sources_settings: The setting source files. + */ #ifndef _di_fake_build_stage_t_ typedef struct { f_string_dynamic_t file_library_script; @@ -691,8 +719,9 @@ extern "C" { /** * The build data. * - * setting: The build settings. - * environment: The environment variables. + * Properties: + * - setting: The build settings. + * - environment: The environment variables. */ #ifndef _di_fake_build_data_t_ typedef struct { @@ -706,6 +735,14 @@ extern "C" { } #endif // _di_fake_build_data_t_ +/** + * The make settings. + * + * Properties: + * - load_build: Designate loading the build settings. + * - fail: Holds the fail state. + * - parameter: The parameters array map. + */ #ifndef _di_fake_make_setting_t_ typedef struct { bool load_build; @@ -722,6 +759,24 @@ extern "C" { } #endif // _di_fake_make_setting_t_ +/** + * The make parameters. + * + * Properties: + * - build: The build parameters. + * - color: The color parameters. + * - data: The data parameters. + * - define: The define parameters. + * - documents: The document parameters. + * - fakefile: The fakefile parameters. + * - licenses: The license parameters. + * - mode: The mode parameters. + * - process: The process parameters. + * - settings: The setting parameters. + * - sources: The source parameters. + * - verbosity: The verbosity parameters. + * - work: The work parameters. + */ #ifndef _di_fake_make_parameter_t_ typedef struct { f_string_dynamics_t build; @@ -756,6 +811,13 @@ extern "C" { } #endif // _di_fake_make_parameter_t_ +/** + * The make path. + * + * Properties: + * - top: The top-most directory. + * - stack: The stack representing the directory paths. + */ #ifndef _di_fake_make_path_t_ typedef struct { f_file_t top; @@ -772,23 +834,24 @@ extern "C" { /** * The control data. * - * setting_build: The build settings. - * setting_make: The make settings. - * environment: All environment variables allowed to be exposed to the when processing. - * parameter: A set of parameters available for IKI substitution. - * parameter_option: A set of parameters available for IKI option substitution. - * parameter_value: A set of parameters available for IKI value substitution. - * path: The path to the Fakefile. - * fakefile: The loaded Fakefile. - * buffer: A buffer used during processing. - * cache_1: An additional buffer for caching purposes. - * cache_2: An additional buffer for caching purposes. - * cache_path: A buffer for path-specific caching. - * cache_arguments: A cache for expanded arguments. - * cache_iki: A cache for IKI data. - * id_main: Index of the "main" Section. - * main: The program and settings data. - * data: The Fake make program data. + * Properties: + * - setting_build: The build settings. + * - setting_make: The make settings. + * - environment: All environment variables allowed to be exposed to the when processing. + * - parameter: A set of parameters available for IKI substitution. + * - parameter_option: A set of parameters available for IKI option substitution. + * - parameter_value: A set of parameters available for IKI value substitution. + * - path: The path to the Fakefile. + * - fakefile: The loaded Fakefile. + * - buffer: A buffer used during processing. + * - cache_1: An additional buffer for caching purposes. + * - cache_2: An additional buffer for caching purposes. + * - cache_path: A buffer for path-specific caching. + * - cache_arguments: A cache for expanded arguments. + * - cache_iki: A cache for IKI data. + * - id_main: Index of the "main" Section. + * - main: The program and settings data. + * - data: The Fake make program data. */ #ifndef _di_fake_make_data_t_ typedef struct { diff --git a/level_3/fss_identify/c/main/common/type.h b/level_3/fss_identify/c/main/common/type.h index d936bbd..2865e38 100644 --- a/level_3/fss_identify/c/main/common/type.h +++ b/level_3/fss_identify/c/main/common/type.h @@ -22,21 +22,22 @@ extern "C" { * This is passed to the program-specific main entry point to designate program settings. * These program settings are often processed from the program arguments (often called the command line arguments). * - * flag: Flags passed to the main function. - * - * current: The current position within the ids, used to determine when the line is matched. - * line: The line number to select. - * total: The total ids across all files. - * - * range: A range used for processing as needed. - * - * status_signal: A status used eclusively by the threaded signal handler. - * state: The state information. - * - * buffer:A buffer used for processing files. - * ids: A cache for FLL IDs. - * names: An array of names to select. - * files: The files to process. + * Properties: + * - flag: Flags passed to the main function. + * + * - current: The current position within the ids, used to determine when the line is matched. + * - line: The line number to select. + * - total: The total ids across all files. + * + * - range: A range used for processing as needed. + * - + * - status_signal: A status used eclusively by the threaded signal handler. + * - state: The state information. + * + * - buffer: A buffer used for processing files. + * - ids: A cache for FLL IDs. + * - names: An array of names to select. + * - files: The files to process. */ #ifndef _di_fss_identify_setting_t_ typedef struct { @@ -79,8 +80,9 @@ extern "C" { /** * The main program data as a single structure. * - * program: The main program data. - * setting: The settings data. + * Properties: + * - program: The main program data. + * - setting: The settings data. */ #ifndef _di_fss_identify_main_t_ typedef struct { diff --git a/level_3/iki_read/c/main/common/type.h b/level_3/iki_read/c/main/common/type.h index 97322bf..f5855cf 100644 --- a/level_3/iki_read/c/main/common/type.h +++ b/level_3/iki_read/c/main/common/type.h @@ -22,27 +22,28 @@ extern "C" { * This is passed to the program-specific main entry point to designate program settings. * These program settings are often processed from the program arguments (often called the command line arguments). * - * flag: Flags passed to the main function. + * Properties: + * - flag: Flags passed to the main function. * - * status_signal: A status used eclusively by the threaded signal handler. - * state: The state data used when processing the FSS data. + * - status_signal: A status used eclusively by the threaded signal handler. + * - state: The state data used when processing the FSS data. * - * at: The position representing the "at" index. - * line: The position representing the "line" index. + * - at: The position representing the "at" index. + * - line: The position representing the "line" index. * - * buffer: A buffer used for loading the files and other miscellaneous tasks. - * name: A string representing the IKI vocabulary name being selected. - * files: An array of all files to process (except for the input pipe). + * - buffer: A buffer used for loading the files and other miscellaneous tasks. + * - name: A string representing the IKI vocabulary name being selected. + * - files: An array of all files to process (except for the input pipe). * - * replace: A map containing the Vocabulary name and its replacement as the value. - * reassign: A triple containing the Vocabulary name (a), Content to match (b), and the string used as the reassign (c). - * substitute: A triple containing the Vocabulary name (a), Content to match (b), and the string used as the substitute (c). - * wrap: A triple containing the Vocabulary name (a), the string to prepend (b), and the string to append (c). + * - replace: A map containing the Vocabulary name and its replacement as the value. + * - reassign: A triple containing the Vocabulary name (a), Content to match (b), and the string used as the reassign (c). + * - substitute: A triple containing the Vocabulary name (a), Content to match (b), and the string used as the substitute (c). + * - wrap: A triple containing the Vocabulary name (a), the string to prepend (b), and the string to append (c). * - * map_replaces: A pointer representing an array with length of setting->data.vocabulary.used mapping the vocabulary location to a replace array location. - * map_wraps: A pointer representing an array with length of setting->data.vocabulary.used mapping the vocabulary location to a wrap array location. + * - map_replaces: A pointer representing an array with length of setting->data.vocabulary.used mapping the vocabulary location to a replace array location. + * - map_wraps: A pointer representing an array with length of setting->data.vocabulary.used mapping the vocabulary location to a wrap array location. * - * data: The loaded IKI data. + * - data: The loaded IKI data. */ #ifndef _di_iki_read_setting_t_ typedef struct { @@ -92,8 +93,9 @@ extern "C" { /** * The main program data as a single structure. * - * program: The main program data. - * setting: The settings data. + * Properties: + * - program: The main program data. + * - setting: The settings data. */ #ifndef _di_iki_read_main_t_ typedef struct { diff --git a/level_3/utf8/c/main/common/type.h b/level_3/utf8/c/main/common/type.h index e4c08e4..c553569 100644 --- a/level_3/utf8/c/main/common/type.h +++ b/level_3/utf8/c/main/common/type.h @@ -22,24 +22,25 @@ extern "C" { * This is passed to the program-specific main entry point to designate program settings. * These program settings are often processed from the program arguments (often called the command line arguments). * - * mode: The input/output mode (see utf8_modes_e). - * flag: Flags passed to the main function. + * Properties: + * - mode: The input/output mode (see utf8_modes_e). + * - flag: Flags passed to the main function. * - * status_signal: A status used eclusively by the threaded signal handler. - * state: The state data used when processing the FSS data. + * - status_signal: A status used eclusively by the threaded signal handler. + * - state: The state data used when processing the FSS data. * - * valid: Designate the output context set for valid characters. - * valid_not: Designate the output context set for invalid characters. + * - valid: Designate the output context set for valid characters. + * - valid_not: Designate the output context set for invalid characters. * - * append: A string to append. A value of NULL results in not appending. - * prepend: A string to prepend. A value of NULL results in not prepending. + * - append: A string to append. A value of NULL results in not appending. + * - prepend: A string to prepend. A value of NULL results in not prepending. * - * buffer: A buffer to use for printing output (generally for storing a block of input from an input file). - * text: A buffer for storing a series of characters for processing (generally for code point processing). + * - buffer: A buffer to use for printing output (generally for storing a block of input from an input file). + * - text: A buffer for storing a series of characters for processing (generally for code point processing). * - * path_files_from: An array of all "from" file paths for when the flag utf8_main_flag_file_from_e is set. - * path_files_to: An array of all "to" file paths for when the flag utf8_main_flag_file_to_e is set. - * remaining: An array containing all remaining arguments passed to the program. + * - path_files_from: An array of all "from" file paths for when the flag utf8_main_flag_file_from_e is set. + * - path_files_to: An array of all "to" file paths for when the flag utf8_main_flag_file_to_e is set. + * - remaining: An array containing all remaining arguments passed to the program. */ #ifndef _di_utf8_setting_t_ typedef struct { @@ -84,8 +85,9 @@ extern "C" { /** * The main program data as a single structure. * - * program: The main program data. - * setting: The settings data. + * Properties: + * - program: The main program data. + * - setting: The settings data. */ #ifndef _di_utf8_main_t_ typedef struct {