From 784554c1e9eb077ab16b367c662da6274f0cc1df Mon Sep 17 00:00:00 2001 From: Kevin Day Date: Thu, 25 Jul 2019 22:00:43 -0500 Subject: [PATCH] Cleanup: Use new comment structure at the tops of files Just put the comments in the header files. Simplify the comment stucture. The git repository provides the authors/credits, no need to explicitly do so in the files anymore. Do not provide the micro version, instead provide the major and minor versions in the files (which effectively represent the API version). --- level_0/f_colors/c/colors.h | 14 +++++++------- level_0/f_console/c/console.c | 6 ------ level_0/f_console/c/console.h | 14 +++++++------- level_0/f_conversion/c/conversion.c | 6 ------ level_0/f_conversion/c/conversion.h | 18 +++++++++--------- level_0/f_errors/c/errors.h | 12 ++++++------ level_0/f_file/c/file.c | 16 ++++++++-------- level_0/f_file/c/file.h | 16 ++++++++-------- level_0/f_fss/c/fss.h | 18 +++++++++--------- level_0/f_memory/c/memory.c | 9 --------- level_0/f_memory/c/memory.h | 12 ++++++------ level_0/f_paths/c/filesystem_paths.h | 14 +++++++------- level_0/f_paths/c/fll_paths.h | 14 +++++++------- level_0/f_pipe/c/pipe.c | 9 --------- level_0/f_pipe/c/pipe.h | 13 ++++++------- level_0/f_print/c/print.c | 6 ------ level_0/f_print/c/print.h | 14 +++++++------- level_0/f_serialized/c/serialized.h | 14 +++++++------- level_0/f_socket/c/socket.c | 9 --------- level_0/f_socket/c/socket.h | 12 ++++++------ level_0/f_strings/c/strings.h | 14 +++++++------- level_0/f_types/c/types.h | 14 ++++++-------- level_0/f_types/c/types_array.h | 12 ++++++------ level_1/fl_colors/c/colors.c | 6 ------ level_1/fl_colors/c/colors.h | 14 +++++++------- level_1/fl_console/c/console.c | 6 ------ level_1/fl_console/c/console.h | 14 +++++++------- level_1/fl_directory/c/directory.c | 7 ------- level_1/fl_directory/c/directory.h | 14 +++++++------- level_1/fl_errors/c/errors.c | 9 --------- level_1/fl_errors/c/errors.h | 12 ++++++------ level_1/fl_file/c/file.c | 6 ------ level_1/fl_file/c/file.h | 15 ++++++++------- level_1/fl_fss/c/fss.c | 7 ------- level_1/fl_fss/c/fss.h | 11 ++++++----- level_1/fl_fss/c/fss_basic.c | 6 ------ level_1/fl_fss/c/fss_basic.h | 14 +++++++------- level_1/fl_fss/c/fss_basic_list.c | 6 ------ level_1/fl_fss/c/fss_basic_list.h | 14 +++++++------- level_1/fl_fss/c/fss_errors.h | 11 ++++++----- level_1/fl_fss/c/fss_extended.c | 6 ------ level_1/fl_fss/c/fss_extended.h | 14 +++++++------- level_1/fl_fss/c/fss_macro.h | 14 +++++++------- level_1/fl_serialized/c/serialized.c | 6 ------ level_1/fl_serialized/c/serialized.h | 14 +++++++------- level_1/fl_socket/c/socket.c | 9 --------- level_1/fl_socket/c/socket.h | 12 ++++++------ level_1/fl_strings/c/strings.c | 6 ------ level_1/fl_strings/c/strings.h | 14 +++++++------- level_2/fll_colors/c/colors.c | 6 ------ level_2/fll_colors/c/colors.h | 14 +++++++------- level_2/fll_execute/c/execute.c | 9 --------- level_2/fll_execute/c/execute.h | 14 +++++++------- level_2/fll_fss/c/fss_basic.c | 6 ------ level_2/fll_fss/c/fss_basic.h | 14 +++++++------- level_2/fll_fss/c/fss_basic_list.c | 6 ------ level_2/fll_fss/c/fss_basic_list.h | 14 +++++++------- level_2/fll_fss/c/fss_errors.c | 6 ------ level_2/fll_fss/c/fss_errors.h | 12 ++++++------ level_2/fll_fss/c/fss_extended.c | 6 ------ level_2/fll_fss/c/fss_extended.h | 14 +++++++------- level_3/firewall/c/firewall.c | 10 +++++----- level_3/firewall/c/firewall.h | 14 +++++++------- level_3/firewall/c/private-firewall.c | 3 --- level_3/firewall/c/private-firewall.h | 7 +++++-- level_3/fss_basic_list_read/c/fss_basic_list_read.c | 6 ------ level_3/fss_basic_list_read/c/fss_basic_list_read.h | 14 +++++++------- level_3/fss_basic_list_write/c/fss_basic_list_write.c | 6 ------ level_3/fss_basic_list_write/c/fss_basic_list_write.h | 12 ++++++------ level_3/fss_basic_read/c/fss_basic_read.c | 6 ------ level_3/fss_basic_read/c/fss_basic_read.h | 14 +++++++------- level_3/fss_basic_write/c/fss_basic_write.c | 6 ------ level_3/fss_basic_write/c/fss_basic_write.h | 12 ++++++------ level_3/fss_extended_read/c/fss_extended_read.c | 6 ------ level_3/fss_extended_read/c/fss_extended_read.h | 14 +++++++------- level_3/fss_extended_write/c/fss_extended_write.c | 6 ------ level_3/fss_extended_write/c/fss_extended_write.h | 12 ++++++------ level_3/fss_return_code/c/fss_return_code.c | 6 ------ level_3/fss_return_code/c/fss_return_code.h | 12 ++++++------ level_3/return_code/c/return_code.c | 6 ------ level_3/return_code/c/return_code.h | 12 +++++------- 81 files changed, 322 insertions(+), 536 deletions(-) diff --git a/level_0/f_colors/c/colors.h b/level_0/f_colors/c/colors.h index 08f6bb6..ac14d88 100644 --- a/level_0/f_colors/c/colors.h +++ b/level_0/f_colors/c/colors.h @@ -1,11 +1,11 @@ -/* FLL - Level 0 - * Project: Colors - * Version: 0.5.0 - * Licenses: lgplv2.1 - * Programmers: Kevin Day - * Documentation: +/** + * FLL - Level 0 * - * Provide basic color output support (linux & xterm) + * Project: Colors + * API Version: 0.5 + * Licenses: lgplv2.1 + * + * Provide basic color output support (linux & xterm). * This is the Featureless LINUX Library, so there is no support for non-linux colors at this time. */ #ifndef _F_colors_h diff --git a/level_0/f_console/c/console.c b/level_0/f_console/c/console.c index 1d110ac..fef3d26 100644 --- a/level_0/f_console/c/console.c +++ b/level_0/f_console/c/console.c @@ -1,9 +1,3 @@ -/* FLL - Level 0 - * Project: Console - * Version: 0.5.0 - * Licenses: lgplv2.1 - * Programmers: Kevin Day - */ #include #ifdef __cplusplus diff --git a/level_0/f_console/c/console.h b/level_0/f_console/c/console.h index d81175e..4e5e3cc 100644 --- a/level_0/f_console/c/console.h +++ b/level_0/f_console/c/console.h @@ -1,11 +1,11 @@ -/* FLL - Level 0 - * Project: Console - * Version: 0.5.0 - * Licenses: lgplv2.1 - * Programmers: Kevin Day - * Documentation: +/** + * FLL - Level 0 * - * Some console input/output commands + * Project: Console + * API Version: 0.5 + * Licenses: lgplv2.1 + * + * Some console input/output commands. */ #ifndef _F_console_h #define _F_console_h diff --git a/level_0/f_conversion/c/conversion.c b/level_0/f_conversion/c/conversion.c index f5c7ffc..1e9efa5 100644 --- a/level_0/f_conversion/c/conversion.c +++ b/level_0/f_conversion/c/conversion.c @@ -1,9 +1,3 @@ -/* FLL - Level 0 - * Project: Conversion - * Version: 0.5.0 - * Licenses: lgplv2.1 - * Programmers: Kevin Day - */ #include #ifdef __cplusplus diff --git a/level_0/f_conversion/c/conversion.h b/level_0/f_conversion/c/conversion.h index 161a045..45effac 100644 --- a/level_0/f_conversion/c/conversion.h +++ b/level_0/f_conversion/c/conversion.h @@ -1,13 +1,13 @@ -/* FLL - Level 0 - * Project: Conversion - * Version: 0.5.0 - * Licenses: lgplv2.1 - * Programmers: Kevin Day - * Documentation: +/** + * FLL - Level 0 * - * Provide means to convert one data type to another, such as a string to an integer - * Provide means to identify a digit or a hexadecimal digit (hexdigit) - * In the future this will have to link to locale support, due to interpeting strings + * Project: Conversion + * API Version: 0.5 + * Licenses: lgplv2.1 + * + * Provide means to convert one data type to another, such as a string to an integer. + * Provide means to identify a digit or a hexadecimal digit (hexdigit). + * In the future this will have to link to locale support, due to interpeting strings. * * Possible error values on return: * f_warn - a possible problem, but not an error (warning) diff --git a/level_0/f_errors/c/errors.h b/level_0/f_errors/c/errors.h index f732b5a..d4a809b 100644 --- a/level_0/f_errors/c/errors.h +++ b/level_0/f_errors/c/errors.h @@ -1,9 +1,9 @@ -/* FLL - Level 0 - * Project: Errors - * Version: 0.5.0 - * Licenses: lgplv2.1 - * Programmers: Kevin Day - * Documentation: +/** + * FLL - Level 0 + * + * Project: Errors + * API Version: 0.5 + * Licenses: lgplv2.1 * * Provides error definitions. * diff --git a/level_0/f_file/c/file.c b/level_0/f_file/c/file.c index 0a53153..2a16a79 100644 --- a/level_0/f_file/c/file.c +++ b/level_0/f_file/c/file.c @@ -1,12 +1,12 @@ -/* FLL - Level 0 - * Project: File - * Version: 0.5.0 - * Licenses: lgplv2.1 - * Programmers: Kevin Day - * Documentation: +/** + * FLL - Level 0 * - * Provides structures and data types for a file I/O. - * Provides operations for opening/closing files + * Project: File + * API Version: 0.5 + * Licenses: lgplv2.1 + * + * Provides structures and data types for a file I/O. + * Provides operations for opening/closing files. */ #include diff --git a/level_0/f_file/c/file.h b/level_0/f_file/c/file.h index 1d0985f..d8fc2c2 100644 --- a/level_0/f_file/c/file.h +++ b/level_0/f_file/c/file.h @@ -1,12 +1,12 @@ -/* FLL - Level 0 - * Project: File - * Version: 0.5.0 - * Licenses: lgplv2.1 - * Programmers: Kevin Day - * Documentation: +/** + * FLL - Level 0 * - * Provides structures and data types for a file I/O. - * Provides operations for opening/closing files + * Project: File + * API Version: 0.5 + * Licenses: lgplv2.1 + * + * Provides structures and data types for a file I/O. + * Provides operations for opening/closing files. */ #ifndef _F_file_h #define _F_file_h diff --git a/level_0/f_fss/c/fss.h b/level_0/f_fss/c/fss.h index 0f0634c..07933ab 100644 --- a/level_0/f_fss/c/fss.h +++ b/level_0/f_fss/c/fss.h @@ -1,14 +1,14 @@ -/* FLL - Level 0 - * Project: FSS - * Version: 0.5.0 - * Licenses: lgplv2.1 - * Programmers: Kevin Day - * Documentation: +/** + * FLL - Level 0 * - * Defines all datatypes to be used for/by project fss + * Project: FSS + * API Version: 0.5 + * Licenses: lgplv2.1 * - * The purpose of compression is not to compression the entire file's contents but only and individual objects content, so the file is still partially readable - * NOTE: all start/stop locations must be defined as a (start < stop) and not (start <= stop), therefore if (start == stop) then stop + * Defines all datatypes to be used for/by project fss. + * + * The purpose of compression is not to compression the entire file's contents but only and individual objects content, so the file is still partially readable. + * NOTE: all start/stop locations must be defined as a (start < stop) and not (start <= stop), therefore if (start == stop) then stop. */ #ifndef _F_fss_h #define _F_fss_h diff --git a/level_0/f_memory/c/memory.c b/level_0/f_memory/c/memory.c index 2dacf27..c460fc5 100644 --- a/level_0/f_memory/c/memory.c +++ b/level_0/f_memory/c/memory.c @@ -1,12 +1,3 @@ -/* FLL - Level 0 - * Project: Memory - * Version: 0.5.0 - * Licenses: lgplv2.1 - * Programmers: Kevin Day - * Documentation: - * - * Provide means to use memory routines, with error checking. - */ #include #ifdef __cplusplus diff --git a/level_0/f_memory/c/memory.h b/level_0/f_memory/c/memory.h index fe3146e..65d2d5b 100644 --- a/level_0/f_memory/c/memory.h +++ b/level_0/f_memory/c/memory.h @@ -1,9 +1,9 @@ -/* FLL - Level 0 - * Project: Memory - * Version: 0.5.0 - * Licenses: lgplv2.1 - * Programmers: Kevin Day - * Documentation: +/** + * FLL - Level 0 + * + * Project: Memory + * API Version: 0.5 + * Licenses: lgplv2.1 * * Provide means to use memory routines, with error checking. * diff --git a/level_0/f_paths/c/filesystem_paths.h b/level_0/f_paths/c/filesystem_paths.h index 8e6701e..dad5c92 100644 --- a/level_0/f_paths/c/filesystem_paths.h +++ b/level_0/f_paths/c/filesystem_paths.h @@ -1,13 +1,13 @@ -/* FLL - Level 0 - * Project: Paths - * Version: 0.5.0 - * Licenses: lgplv2.1 - * Programmers: Kevin Day - * Documentation: +/** + * FLL - Level 0 + * + * Project: Paths + * API Version: 0.5 + * Licenses: lgplv2.1 * * Provide locations to all filesystem paths, for low level hardcoding * - * FIXME: this is very outdated due to numerous structural changes while I was developing turtle kevux + * FIXME: this is very outdated due to numerous structural changes while I was developing turtle kevux. */ #ifndef _F_filesystem_paths_h #define _F_filesystem_paths_h diff --git a/level_0/f_paths/c/fll_paths.h b/level_0/f_paths/c/fll_paths.h index 8abbb61..7ac452c 100644 --- a/level_0/f_paths/c/fll_paths.h +++ b/level_0/f_paths/c/fll_paths.h @@ -1,14 +1,14 @@ -/* FLL - Level 0 - * Project: Paths - * Version: 0.5.0 - * Licenses: lgplv2.1 - * Programmers: Kevin Day - * Documentation: +/** + * FLL - Level 0 + * + * Project: Paths + * API Version: 0.5 + * Licenses: lgplv2.1 * * Provide locations to all fll-specific paths * It is planned to have this file auto-generated from a single /etc/fll file such that one file can be used for all supported languages. * - * FIXME: this is very outdated due to numerous structural changes while I was developing turtle kevux + * FIXME: this is very outdated due to numerous structural changes while I was developing turtle kevux. */ #ifndef _F_fll_paths_h #define _F_fll_paths_h diff --git a/level_0/f_pipe/c/pipe.c b/level_0/f_pipe/c/pipe.c index 38f8129..36b6019 100644 --- a/level_0/f_pipe/c/pipe.c +++ b/level_0/f_pipe/c/pipe.c @@ -1,12 +1,3 @@ -/* FLL - Level 0 - * Project: Pipe - * Version: 0.5.0 - * Licenses: lgplv2.1 - * Programmers: Kevin Day - * Documentation: - * - * Provides pipe functionality. - */ #include #ifdef __cplusplus diff --git a/level_0/f_pipe/c/pipe.h b/level_0/f_pipe/c/pipe.h index 2fee9f0..7235102 100644 --- a/level_0/f_pipe/c/pipe.h +++ b/level_0/f_pipe/c/pipe.h @@ -1,12 +1,11 @@ -/* FLL - Level 0 - * Project: Pipe - * Version: 0.5.0 - * Licenses: lgplv2.1 - * Programmers: Kevin Day - * Documentation: +/** + * FLL - Level 0 * - * Provides pipe functionality. + * Project: Pipe + * API Version: 0.5 + * Licenses: lgplv2.1 * + * Provides pipe functionality. */ #ifndef _F_pipe_h #define _F_pipe_h diff --git a/level_0/f_print/c/print.c b/level_0/f_print/c/print.c index af26b2c..60ab93a 100644 --- a/level_0/f_print/c/print.c +++ b/level_0/f_print/c/print.c @@ -1,9 +1,3 @@ -/* FLL - Level 0 - * Project: Output - * Version: 0.5.0 - * Licenses: lgplv2.1 - * Programmers: Kevin Day - */ #include #ifdef __cplusplus diff --git a/level_0/f_print/c/print.h b/level_0/f_print/c/print.h index 73bdf9c..7bee5d9 100644 --- a/level_0/f_print/c/print.h +++ b/level_0/f_print/c/print.h @@ -1,11 +1,11 @@ -/* FLL - Level 0 - * Project: Output - * Version: 0.5.0 - * Licenses: lgplv2.1 - * Programmers: Kevin Day - * Documentation: +/** + * FLL - Level 0 * - * Provides some standard printing functions not available in a libc + * Project: Output + * API Version: 0.5 + * Licenses: lgplv2.1 + * + * Provides some standard printing functions not available in a libc. */ #ifndef _F_print_h #define _F_print_h diff --git a/level_0/f_serialized/c/serialized.h b/level_0/f_serialized/c/serialized.h index d25f287..9e16c09 100644 --- a/level_0/f_serialized/c/serialized.h +++ b/level_0/f_serialized/c/serialized.h @@ -1,13 +1,13 @@ -/* FLL - Level 0 - * Project: Serialized - * Version: 0.5.0 - * Licenses: lgplv2.1 - * Programmers: Kevin Day - * Documentation: +/** + * FLL - Level 0 + * + * Project: Serialized + * API Version: 0.5 + * Licenses: lgplv2.1 * * Provides string processing functionality for what is to be defined as a serialized string. * Serialized strings are strings that can hold multiple values in a single variable. - * An example of serialized content is the PATH environment variable where ':" separates data." + * An example of serialized content is the PATH environment variable where ":" separates data.. */ #ifndef _F_serialized_h #define _F_serialized_h diff --git a/level_0/f_socket/c/socket.c b/level_0/f_socket/c/socket.c index 0e6889c..e220305 100644 --- a/level_0/f_socket/c/socket.c +++ b/level_0/f_socket/c/socket.c @@ -1,12 +1,3 @@ -/* FLL - Level 0 - * Project: Socket - * Version: 0.4.2 - * Licenses: lgplv2.1 - * Programmers: Kevin Day - * Documentation: - * - * Provide means to connect to and use sockets. - */ #include #ifdef __cplusplus diff --git a/level_0/f_socket/c/socket.h b/level_0/f_socket/c/socket.h index d5ec7ab..8709d78 100644 --- a/level_0/f_socket/c/socket.h +++ b/level_0/f_socket/c/socket.h @@ -1,9 +1,9 @@ -/* FLL - Level 0 - * Project: Socket - * Version: 0.4.2 - * Licenses: lgplv2.1 - * Programmers: Kevin Day - * Documentation: +/** + * FLL - Level 0 + * + * Project: Socket + * API Version: 0.5 + * Licenses: lgplv2.1 * * Provide means to connect to and use sockets. */ diff --git a/level_0/f_strings/c/strings.h b/level_0/f_strings/c/strings.h index f0adf36..06474c7 100644 --- a/level_0/f_strings/c/strings.h +++ b/level_0/f_strings/c/strings.h @@ -1,11 +1,11 @@ -/* FLL - Level 0 - * Project: Strings - * Version: 0.5.0 - * Licenses: lgplv2.1 - * Programmers: Kevin Day - * Documentation: +/** + * FLL - Level 0 * - * Provides string capabilities + * Project: Strings + * API Version: 0.5 + * Licenses: lgplv2.1 + * + * Provides string capabilities. */ #ifndef _F_strings_h #define _F_strings_h diff --git a/level_0/f_types/c/types.h b/level_0/f_types/c/types.h index 1d1a745..5cb86cc 100644 --- a/level_0/f_types/c/types.h +++ b/level_0/f_types/c/types.h @@ -1,9 +1,9 @@ -/* FLL - Level 0 - * Project: Types - * Version: 0.5.0 - * Licenses: lgplv2.1 - * Programmers: Kevin Day - * Documentation: +/** + * FLL - Level 0 + * + * Project: Types + * API Version: 0.5 + * Licenses: lgplv2.1 * * Provides datatype re-definitions * If your compiler lacks the ability to produce such, simply re-define them as needed @@ -23,8 +23,6 @@ * uint32_t: 2^32 (unsigned) * int64_t: 2^64 (signed) * uint64_t: 2^64 (unsigned) - * - * TODO: Should a range type be implemented? (ie: f_range_short_long -> min=short, max=long) */ #ifndef _F_types_h #define _F_types_h diff --git a/level_0/f_types/c/types_array.h b/level_0/f_types/c/types_array.h index f068af9..9da8ca9 100644 --- a/level_0/f_types/c/types_array.h +++ b/level_0/f_types/c/types_array.h @@ -1,9 +1,9 @@ -/* FLL - Level 0 - * Project: Types Array - * Version: 0.5.0 - * Licenses: lgplv2.1 - * Programmers: Kevin Day - * Documentation: +/** + * FLL - Level 0 + * + * Project: Types + * API Version: 0.5 + * Licenses: lgplv2.1 * * Provides datatypes that are arrays of some sort and require memory operations. */ diff --git a/level_1/fl_colors/c/colors.c b/level_1/fl_colors/c/colors.c index 96e30f5..b617f05 100644 --- a/level_1/fl_colors/c/colors.c +++ b/level_1/fl_colors/c/colors.c @@ -1,9 +1,3 @@ -/* FLL - Level 1 - * Project: Colors - * Version: 0.5.0 - * Licenses: lgplv2.1 - * Programmers: Kevin Day - */ #include #ifdef __cplusplus diff --git a/level_1/fl_colors/c/colors.h b/level_1/fl_colors/c/colors.h index 02614e0..8d4f538 100644 --- a/level_1/fl_colors/c/colors.h +++ b/level_1/fl_colors/c/colors.h @@ -1,11 +1,11 @@ -/* FLL - Level 1 - * Project: Colors - * Version: 0.5.0 - * Licenses: lgplv2.1 - * Programmers: Kevin Day - * Documentation: +/** + * FLL - Level 1 * - * Provide basic color output support (linux & xterm) + * Project: Colors + * API Version: 0.5 + * Licenses: lgplv2.1 + * + * Provide basic color output support (linux & xterm). * This is the Featureless LINUX Library, so there is no support for non-linux colors at this time. */ #ifndef _FL_colors_h diff --git a/level_1/fl_console/c/console.c b/level_1/fl_console/c/console.c index 47d3932..b187fc1 100644 --- a/level_1/fl_console/c/console.c +++ b/level_1/fl_console/c/console.c @@ -1,9 +1,3 @@ -/* FLL - Level 1 - * Project: Console - * Version: 0.5.0 - * Licenses: lgplv2.1 - * Programmers: Kevin Day - */ #include #ifdef __cplusplus diff --git a/level_1/fl_console/c/console.h b/level_1/fl_console/c/console.h index df06496..273185a 100644 --- a/level_1/fl_console/c/console.h +++ b/level_1/fl_console/c/console.h @@ -1,11 +1,11 @@ -/* FLL - Level 1 - * Project: Console - * Version: 0.5.0 - * Licenses: lgplv2.1 - * Programmers: Kevin Day - * Documentation: +/** + * FLL - Level 1 * - * Some console input/output commands + * Project: Console + * API Version: 0.5 + * Licenses: lgplv2.1 + * + * Some console input/output commands. */ #ifndef _FL_console_h #define _FL_console_h diff --git a/level_1/fl_directory/c/directory.c b/level_1/fl_directory/c/directory.c index bd89e06..83df1c9 100644 --- a/level_1/fl_directory/c/directory.c +++ b/level_1/fl_directory/c/directory.c @@ -1,10 +1,3 @@ -/* FLL - Level 1 - * Project: Directory - * Version: 0.5.0 - * Licenses: lgplv2.1 - * Programmers: Kevin Day - * Documentation: - */ #include #ifdef __cplusplus diff --git a/level_1/fl_directory/c/directory.h b/level_1/fl_directory/c/directory.h index 7547ea8..5291199 100644 --- a/level_1/fl_directory/c/directory.h +++ b/level_1/fl_directory/c/directory.h @@ -1,11 +1,11 @@ -/* FLL - Level 1 - * Project: Directory - * Version: 0.5.0 - * Licenses: lgplv2.1 - * Programmers: Kevin Day - * Documentation: +/** + * FLL - Level 1 * - * Provides operations for directory handling + * Project: Directory + * API Version: 0.5 + * Licenses: lgplv2.1 + * + * Provides operations for directory handling. */ #ifndef _FL_directory_h #define _FL_directory_h diff --git a/level_1/fl_errors/c/errors.c b/level_1/fl_errors/c/errors.c index 7cc1522..58adcf7 100644 --- a/level_1/fl_errors/c/errors.c +++ b/level_1/fl_errors/c/errors.c @@ -1,12 +1,3 @@ -/* FLL - Level 1 - * Project: Errors - * Version: 0.5.0 - * Licenses: lgplv2.1 - * Programmers: Kevin Day - * Documentation: - * - * Provides error functions, such as those that translate error codes into strings. - */ #include #ifdef __cplusplus diff --git a/level_1/fl_errors/c/errors.h b/level_1/fl_errors/c/errors.h index 22c8419..52e9544 100644 --- a/level_1/fl_errors/c/errors.h +++ b/level_1/fl_errors/c/errors.h @@ -1,9 +1,9 @@ -/* FLL - Level 1 - * Project: Errors - * Version: 0.5.0 - * Licenses: lgplv2.1 - * Programmers: Kevin Day - * Documentation: +/** + * FLL - Level 1 + * + * Project: Errors + * API Version: 0.5 + * Licenses: lgplv2.1 * * Provides error functions, such as those that translate error codes into strings. */ diff --git a/level_1/fl_file/c/file.c b/level_1/fl_file/c/file.c index 187c4dd..f8bcf80 100644 --- a/level_1/fl_file/c/file.c +++ b/level_1/fl_file/c/file.c @@ -1,9 +1,3 @@ -/* FLL - Level 1 - * Project: File - * Version: 0.5.0 - * Licenses: lgplv2.1 - * Programmers: Kevin Day - */ #include #ifdef __cplusplus diff --git a/level_1/fl_file/c/file.h b/level_1/fl_file/c/file.h index 489b425..7b85183 100644 --- a/level_1/fl_file/c/file.h +++ b/level_1/fl_file/c/file.h @@ -1,10 +1,11 @@ -/* FLL - Level 1 - * Project: File - * Version: 0.5.0 - * Licenses: lgplv2.1 - * Programmers: Kevin Day - * Documentation: - * File Operations +/** + * FLL - Level 1 + * + * Project: File + * API Version: 0.5 + * Licenses: lgplv2.1 + * + * File Operations. */ #ifndef _FL_file_h #define _FL_file_h diff --git a/level_1/fl_fss/c/fss.c b/level_1/fl_fss/c/fss.c index 4eda9ed..e97f1cc 100644 --- a/level_1/fl_fss/c/fss.c +++ b/level_1/fl_fss/c/fss.c @@ -1,10 +1,3 @@ -/* FLL - Level 1 - * Project: FSS - * Version: 0.5.0 - * Licenses: lgplv2.1 - * Programmers: Kevin Day - * Documentation: - */ #include #ifdef __cplusplus diff --git a/level_1/fl_fss/c/fss.h b/level_1/fl_fss/c/fss.h index a9b209f..960553d 100644 --- a/level_1/fl_fss/c/fss.h +++ b/level_1/fl_fss/c/fss.h @@ -1,8 +1,9 @@ -/* FLL - Level 1 - * Project: FSS - * Version: 0.5.0 - * Licenses: lgplv2.1 - * Programmers: Kevin Day +/** + * FLL - Level 1 + * + * Project: FSS + * API Version: 0.5 + * Licenses: lgplv2.1 */ #ifndef _FL_fss_h #define _FL_fss_h diff --git a/level_1/fl_fss/c/fss_basic.c b/level_1/fl_fss/c/fss_basic.c index bd51c65..b03c977 100644 --- a/level_1/fl_fss/c/fss_basic.c +++ b/level_1/fl_fss/c/fss_basic.c @@ -1,9 +1,3 @@ -/* FLL - Level 1 - * Project: FSS - * Version: 0.5.0 - * Licenses: lgplv2.1 - * Programmers: Kevin Day - */ #include #ifdef __cplusplus diff --git a/level_1/fl_fss/c/fss_basic.h b/level_1/fl_fss/c/fss_basic.h index d6ab94f..b76e7af 100644 --- a/level_1/fl_fss/c/fss_basic.h +++ b/level_1/fl_fss/c/fss_basic.h @@ -1,11 +1,11 @@ -/* FLL - Level 1 - * Project: FSS - * Version: 0.5.0 - * Licenses: lgplv2.1 - * Programmers: Kevin Day - * Documentation: +/** + * FLL - Level 1 * - * This is the fss-0000 implementation + * Project: FSS + * API Version: 0.5 + * Licenses: lgplv2.1 + * + * This is the fss-0000 implementation. */ #ifndef _FL_fss_basic_h #define _FL_fss_basic_h diff --git a/level_1/fl_fss/c/fss_basic_list.c b/level_1/fl_fss/c/fss_basic_list.c index 21bcfa6..c926f79 100644 --- a/level_1/fl_fss/c/fss_basic_list.c +++ b/level_1/fl_fss/c/fss_basic_list.c @@ -1,9 +1,3 @@ -/* FLL - Level 1 - * Project: FSS - * Version: 0.5.0 - * Licenses: lgplv2.1 - * Programmers: Kevin Day - */ #include #ifdef __cplusplus diff --git a/level_1/fl_fss/c/fss_basic_list.h b/level_1/fl_fss/c/fss_basic_list.h index 1a0adef..f490cb0 100644 --- a/level_1/fl_fss/c/fss_basic_list.h +++ b/level_1/fl_fss/c/fss_basic_list.h @@ -1,11 +1,11 @@ -/* FLL - Level 1 - * Project: FSS - * Version: 0.5.0 - * Licenses: lgplv2.1 - * Programmers: Kevin Day - * Documentation: +/** + * FLL - Level 1 * - * This is the fss-0002 implementation + * Project: FSS + * API Version: 0.5 + * Licenses: lgplv2.1 + * + * This is the fss-0002 implementation. */ #ifndef _FL_fss_basic_list_h #define _FL_fss_basic_list_h diff --git a/level_1/fl_fss/c/fss_errors.h b/level_1/fl_fss/c/fss_errors.h index d5f1a2a..e900280 100644 --- a/level_1/fl_fss/c/fss_errors.h +++ b/level_1/fl_fss/c/fss_errors.h @@ -1,8 +1,9 @@ -/* FLL - Level 1 - * Project: FSS - * Version: 0.5.0 - * Licenses: lgplv2.1 - * Programmers: Kevin Day +/** + * FLL - Level 1 + * + * Project: Strings + * API Version: 0.5 + * Licenses: lgplv2.1 * * Provides fss-specific error definitions. * diff --git a/level_1/fl_fss/c/fss_extended.c b/level_1/fl_fss/c/fss_extended.c index a3e51ec..9ddb638 100644 --- a/level_1/fl_fss/c/fss_extended.c +++ b/level_1/fl_fss/c/fss_extended.c @@ -1,9 +1,3 @@ -/* FLL - Level 1 - * Project: FSS - * Version: 0.5.0 - * Licenses: lgplv2.1 - * Programmers: Kevin Day - */ #include #ifdef __cplusplus diff --git a/level_1/fl_fss/c/fss_extended.h b/level_1/fl_fss/c/fss_extended.h index 2cb7d15..3b5c237 100644 --- a/level_1/fl_fss/c/fss_extended.h +++ b/level_1/fl_fss/c/fss_extended.h @@ -1,11 +1,11 @@ -/* FLL - Level 1 - * Project: FSS - * Version: 0.5.0 - * Licenses: lgplv2.1 - * Programmers: Kevin Day - * Documentation: +/** + * FLL - Level 1 * - * This is the fss-0001 implementation + * Project: FSS + * API Version: 0.5 + * Licenses: lgplv2.1 + * + * This is the fss-0001 implementation. */ #ifndef _FL_fss_extended_h #define _FL_fss_extended_h diff --git a/level_1/fl_fss/c/fss_macro.h b/level_1/fl_fss/c/fss_macro.h index a8f3960..d76abb0 100644 --- a/level_1/fl_fss/c/fss_macro.h +++ b/level_1/fl_fss/c/fss_macro.h @@ -1,11 +1,11 @@ -/* FLL - Level 1 - * Project: FSS - * Version: 0.5.0 - * Licenses: lgplv2.1 - * Programmers: Kevin Day - * Documentation: +/** + * FLL - Level 1 * - * Provides generic functionality shared between and used by different fss processing functions + * Project: FSS + * API Version: 0.5 + * Licenses: lgplv2.1 + * + * Provides generic functionality shared between and used by different fss processing functions. */ #ifndef _FL_fss_macro_h #define _FL_fss_macro_h diff --git a/level_1/fl_serialized/c/serialized.c b/level_1/fl_serialized/c/serialized.c index e3088a8..65bb528 100644 --- a/level_1/fl_serialized/c/serialized.c +++ b/level_1/fl_serialized/c/serialized.c @@ -1,9 +1,3 @@ -/* FLL - Level 1 - * Project: Serialized - * Version: 0.5.0 - * Licenses: lgplv2.1 - * Programmers: Kevin Day - */ #include #ifdef __cplusplus diff --git a/level_1/fl_serialized/c/serialized.h b/level_1/fl_serialized/c/serialized.h index 454fd90..3e54aea 100644 --- a/level_1/fl_serialized/c/serialized.h +++ b/level_1/fl_serialized/c/serialized.h @@ -1,13 +1,13 @@ -/* FLL - Level 1 - * Project: Serialized - * Version: 0.5.0 - * Licenses: lgplv2.1 - * Programmers: Kevin Day - * Documentation: +/** + * FLL - Level 1 + * + * Project: Serialized + * API Version: 0.5 + * Licenses: lgplv2.1 * * Provides string processing functionality for what is to be defined as a serialized string. * Serialized strings are strings that can hold multiple values in a single variable. - * An example of serialized content is the PATH environment variable where ':" separates data." + * An example of serialized content is the PATH environment variable where ":" separates data. */ #ifndef _FL_serialized_h #define _FL_serialized_h diff --git a/level_1/fl_socket/c/socket.c b/level_1/fl_socket/c/socket.c index 5452804..850c68f 100644 --- a/level_1/fl_socket/c/socket.c +++ b/level_1/fl_socket/c/socket.c @@ -1,12 +1,3 @@ -/* FLL - Level 1 - * Project: Socket - * Version: 0.4.2 - * Licenses: lgplv2.1 - * Programmers: Kevin Day - * Documentation: - * - * Provide means to connect to and use sockets. - */ #include #ifdef __cplusplus diff --git a/level_1/fl_socket/c/socket.h b/level_1/fl_socket/c/socket.h index bb2c92f..f312af1 100644 --- a/level_1/fl_socket/c/socket.h +++ b/level_1/fl_socket/c/socket.h @@ -1,9 +1,9 @@ -/* FLL - Level 1 - * Project: Socket - * Version: 0.4.2 - * Licenses: lgplv2.1 - * Programmers: Kevin Day - * Documentation: +/** + * FLL - Level 1 + * + * Project: Socket + * API Version: 0.5 + * Licenses: lgplv2.1 * * Provide means to connect to and use sockets. */ diff --git a/level_1/fl_strings/c/strings.c b/level_1/fl_strings/c/strings.c index bf76eb8..246ac8c 100644 --- a/level_1/fl_strings/c/strings.c +++ b/level_1/fl_strings/c/strings.c @@ -1,9 +1,3 @@ -/* FLL - Level 1 - * Project: Strings - * Version: 0.5.0 - * Licenses: lgplv2.1 - * Programmers: Kevin Day - */ #include #ifdef __cplusplus diff --git a/level_1/fl_strings/c/strings.h b/level_1/fl_strings/c/strings.h index 31b9b5e..a6c6c36 100644 --- a/level_1/fl_strings/c/strings.h +++ b/level_1/fl_strings/c/strings.h @@ -1,11 +1,11 @@ -/* FLL - Level 1 - * Project: Strings - * Version: 0.5.0 - * Licenses: lgplv2.1 - * Programmers: Kevin Day - * Documentation: +/** + * FLL - Level 1 * - * Provides basic string manipulation and processing capabilities + * Project: Strings + * API Version: 0.5 + * Licenses: lgplv2.1 + * + * Provides basic string manipulation and processing capabilities. */ #ifndef _FL_strings_h #define _FL_strings_h diff --git a/level_2/fll_colors/c/colors.c b/level_2/fll_colors/c/colors.c index 0bde1fe..308cabf 100644 --- a/level_2/fll_colors/c/colors.c +++ b/level_2/fll_colors/c/colors.c @@ -1,9 +1,3 @@ -/* FLL - Level 2 - * Project: Colors - * Version: 0.5.0 - * Licenses: lgplv2.1 - * Programmers: Kevin Day - */ #include #ifdef __cplusplus diff --git a/level_2/fll_colors/c/colors.h b/level_2/fll_colors/c/colors.h index 05943f2..79a3b13 100644 --- a/level_2/fll_colors/c/colors.h +++ b/level_2/fll_colors/c/colors.h @@ -1,11 +1,11 @@ -/* FLL - Level 2 - * Project: Colors - * Version: 0.5.0 - * Licenses: lgplv2.1 - * Programmers: Kevin Day - * Documentation: +/** + * FLL - Level 2 * - * Provide standard color handling + * Project: Colors + * API Version: 0.5 + * Licenses: lgplv2.1 + * + * Provide standard color handling. */ #ifndef _FLL_colors_h #define _FLL_colors_h diff --git a/level_2/fll_execute/c/execute.c b/level_2/fll_execute/c/execute.c index 2c31850..789b018 100644 --- a/level_2/fll_execute/c/execute.c +++ b/level_2/fll_execute/c/execute.c @@ -1,12 +1,3 @@ -/* FLL - Level 2 - * Project: Execute - * Version: 0.5.0 - * Licenses: lgplv2.1 - * Programmers: Kevin Day - * Documentation: - * - * Provides program execution operations similart to system(). - */ #include #ifdef __cplusplus diff --git a/level_2/fll_execute/c/execute.h b/level_2/fll_execute/c/execute.h index bbd9492..7d28411 100644 --- a/level_2/fll_execute/c/execute.h +++ b/level_2/fll_execute/c/execute.h @@ -1,11 +1,11 @@ -/* FLL - Level 2 - * Project: Execute - * Version: 0.5.0 - * Licenses: lgplv2.1 - * Programmers: Kevin Day - * Documentation: +/** + * FLL - Level 2 * - * Provides program execution operations similar to system() + * Project: Execute + * API Version: 0.5 + * Licenses: lgplv2.1 + * + * Provides program execution operations similar to system(). */ #ifndef _FLL_execute_h #define _FLL_execute_h diff --git a/level_2/fll_fss/c/fss_basic.c b/level_2/fll_fss/c/fss_basic.c index 6ff0532..b4bd338 100644 --- a/level_2/fll_fss/c/fss_basic.c +++ b/level_2/fll_fss/c/fss_basic.c @@ -1,9 +1,3 @@ -/* FLL - Level 2 - * Project: FSS - * Version: 0.5.0 - * Licenses: lgplv2.1 - * Programmers: Kevin Day - */ #include #ifdef __cplusplus diff --git a/level_2/fll_fss/c/fss_basic.h b/level_2/fll_fss/c/fss_basic.h index 431c912..9257c4d 100644 --- a/level_2/fll_fss/c/fss_basic.h +++ b/level_2/fll_fss/c/fss_basic.h @@ -1,11 +1,11 @@ -/* FLL - Level 2 - * Project: FSS - * Version: 0.5.0 - * Licenses: lgplv2.1 - * Programmers: Kevin Day - * Documentation: +/** + * FLL - Level 2 * - * This is the fss-0000 implementation + * Project: FSS + * API Version: 0.5 + * Licenses: lgplv2.1 + * + * This is the fss-0000 implementation. */ #ifndef _FLL_fss_basic_h #define _FLL_fss_basic_h diff --git a/level_2/fll_fss/c/fss_basic_list.c b/level_2/fll_fss/c/fss_basic_list.c index 5c3aff1..4f38d1c 100644 --- a/level_2/fll_fss/c/fss_basic_list.c +++ b/level_2/fll_fss/c/fss_basic_list.c @@ -1,9 +1,3 @@ -/* FLL - Level 2 - * Project: FSS - * Version: 0.5.0 - * Licenses: lgplv2.1 - * Programmers: Kevin Day - */ #include #ifdef __cplusplus diff --git a/level_2/fll_fss/c/fss_basic_list.h b/level_2/fll_fss/c/fss_basic_list.h index 7494dda..3612083 100644 --- a/level_2/fll_fss/c/fss_basic_list.h +++ b/level_2/fll_fss/c/fss_basic_list.h @@ -1,11 +1,11 @@ -/* FLL - Level 2 - * Project: FSS - * Version: 0.5.0 - * Licenses: lgplv2.1 - * Programmers: Kevin Day - * Documentation: +/** + * FLL - Level 2 * - * This is the fss-0002 implementation + * Project: FSS + * API Version: 0.5 + * Licenses: lgplv2.1 + * + * This is the fss-0002 implementation. */ #ifndef _FLL_fss_basic_list_h #define _FLL_fss_basic_list_h diff --git a/level_2/fll_fss/c/fss_errors.c b/level_2/fll_fss/c/fss_errors.c index 50b591a..e5fad3f 100644 --- a/level_2/fll_fss/c/fss_errors.c +++ b/level_2/fll_fss/c/fss_errors.c @@ -1,9 +1,3 @@ -/* FLL - Level 2 - * Project: FSS - * Version: 0.5.0 - * Licenses: lgplv2.1 - * Programmers: Kevin Day - */ #include #ifdef __cplusplus diff --git a/level_2/fll_fss/c/fss_errors.h b/level_2/fll_fss/c/fss_errors.h index ee30f76..5be69f7 100644 --- a/level_2/fll_fss/c/fss_errors.h +++ b/level_2/fll_fss/c/fss_errors.h @@ -1,9 +1,9 @@ -/* FLL - Level 2 - * Project: FSS - * Version: 0.5.0 - * Licenses: lgplv2.1 - * Programmers: Kevin Day - * Documentation: +/** + * FLL - Level 2 + * + * Project: FSS + * API Version: 0.5 + * Licenses: lgplv2.1 * * This provides fss error code translation. */ diff --git a/level_2/fll_fss/c/fss_extended.c b/level_2/fll_fss/c/fss_extended.c index 6515112..10a24eb 100644 --- a/level_2/fll_fss/c/fss_extended.c +++ b/level_2/fll_fss/c/fss_extended.c @@ -1,9 +1,3 @@ -/* FLL - Level 2 - * Project: FSS - * Version: 0.5.0 - * Licenses: lgplv2.1 - * Programmers: Kevin Day - */ #include #ifdef __cplusplus diff --git a/level_2/fll_fss/c/fss_extended.h b/level_2/fll_fss/c/fss_extended.h index 061c490..9c02b2b 100644 --- a/level_2/fll_fss/c/fss_extended.h +++ b/level_2/fll_fss/c/fss_extended.h @@ -1,11 +1,11 @@ -/* FLL - Level 2 - * Project: FSS - * Version: 0.5.0 - * Licenses: lgplv2.1 - * Programmers: Kevin Day - * Documentation: +/** + * FLL - Level 2 * - * This is the fss-0001 implementation + * Project: FSS + * API Version: 0.5 + * Licenses: lgplv2.1 + * + * This is the fss-0001 implementation. */ #ifndef _FLL_fss_extended_h #define _FLL_fss_extended_h diff --git a/level_3/firewall/c/firewall.c b/level_3/firewall/c/firewall.c index cfbf7d7..978d948 100644 --- a/level_3/firewall/c/firewall.c +++ b/level_3/firewall/c/firewall.c @@ -1,8 +1,8 @@ -/* FLL - Level 3 - * Project: Firewall - * Version: 0.5.0 - * Licenses: lgplv2.1 - * Programmers: Kevin Day +/** + * FLL - Level 3 + * Project: Firewall + * API Version: 0.5 + * Licenses: lgplv2.1 */ #include #include "private-firewall.h" diff --git a/level_3/firewall/c/firewall.h b/level_3/firewall/c/firewall.h index 212ca39..f94a77a 100644 --- a/level_3/firewall/c/firewall.h +++ b/level_3/firewall/c/firewall.h @@ -1,13 +1,13 @@ -/* FLL - Level 3 - * Project: Firewall - * Version: 0.5.0 - * Licenses: lgplv2.1 - * Programmers: Kevin Day - * Documentation: +/** + * FLL - Level 3 + * + * Project: Firewall + * API Version: 0.5 + * Licenses: lgplv2.1 * * This is the Kevux Operating System Firewall program. * This program utilizes the Featureless Linux Library. - * This program processes firewall commands and passes them to iptables from netfiler.org + * This program processes firewall commands and passes them to iptables from netfiler.org. */ #ifndef _firewall_h diff --git a/level_3/firewall/c/private-firewall.c b/level_3/firewall/c/private-firewall.c index d503837..3ec02e9 100644 --- a/level_3/firewall/c/private-firewall.c +++ b/level_3/firewall/c/private-firewall.c @@ -1,6 +1,3 @@ -/** - * Private source file for firewall.c. - */ #include #include "private-firewall.h" diff --git a/level_3/firewall/c/private-firewall.h b/level_3/firewall/c/private-firewall.h index c474385..4ddc620 100644 --- a/level_3/firewall/c/private-firewall.h +++ b/level_3/firewall/c/private-firewall.h @@ -1,7 +1,10 @@ /** - * Private include file for firewall.c. + * FLL - Level 3 + * + * Project: Firewall + * API Version: 0.5 + * Licenses: lgplv2.1 */ - #ifndef _PRIVATE_firewall_h #define _PRIVATE_firewall_h diff --git a/level_3/fss_basic_list_read/c/fss_basic_list_read.c b/level_3/fss_basic_list_read/c/fss_basic_list_read.c index 5b0b1f9..472c83b 100644 --- a/level_3/fss_basic_list_read/c/fss_basic_list_read.c +++ b/level_3/fss_basic_list_read/c/fss_basic_list_read.c @@ -1,9 +1,3 @@ -/* FLL - Level 3 - * Project: FSS - * Version: 0.5.0 - * Licenses: lgplv2.1 - * Programmers: Kevin Day - */ #include #ifdef __cplusplus diff --git a/level_3/fss_basic_list_read/c/fss_basic_list_read.h b/level_3/fss_basic_list_read/c/fss_basic_list_read.h index 00f701e..d5727d5 100644 --- a/level_3/fss_basic_list_read/c/fss_basic_list_read.h +++ b/level_3/fss_basic_list_read/c/fss_basic_list_read.h @@ -1,13 +1,13 @@ -/* FLL - Level 3 - * Project: FSS - * Version: 0.5.0 - * Licenses: lgplv2.1 - * Programmers: Kevin Day - * Documentation: +/** + * FLL - Level 3 + * + * Project: FSS + * API Version: 0.5 + * Licenses: lgplv2.1 * * This is the FSS Basic List Read program * This program utilizes the Featureless Linux Library. - * This program processes files or other input in fss format and stores the results in the fss_basic_list_read_data + * This program processes files or other input in fss format and stores the results in the fss_basic_list_read_data. */ #ifndef _fss_basic_list_read_h diff --git a/level_3/fss_basic_list_write/c/fss_basic_list_write.c b/level_3/fss_basic_list_write/c/fss_basic_list_write.c index 29a4887..3451d37 100644 --- a/level_3/fss_basic_list_write/c/fss_basic_list_write.c +++ b/level_3/fss_basic_list_write/c/fss_basic_list_write.c @@ -1,9 +1,3 @@ -/* FLL - Level 3 - * Project: FSS - * Version: 0.5.0 - * Licenses: lgplv2.1 - * Programmers: Kevin Day - */ #include #ifdef __cplusplus diff --git a/level_3/fss_basic_list_write/c/fss_basic_list_write.h b/level_3/fss_basic_list_write/c/fss_basic_list_write.h index d6ac39b..5765183 100644 --- a/level_3/fss_basic_list_write/c/fss_basic_list_write.h +++ b/level_3/fss_basic_list_write/c/fss_basic_list_write.h @@ -1,9 +1,9 @@ -/* FLL - Level 3 - * Project: FSS - * Version: 0.5.0 - * Licenses: lgplv2.1 - * Programmers: Kevin Day - * Documentation: +/** + * FLL - Level 3 + * + * Project: FSS + * API Version: 0.5 + * Licenses: lgplv2.1 * * This program provides fss basic list write functionality. */ diff --git a/level_3/fss_basic_read/c/fss_basic_read.c b/level_3/fss_basic_read/c/fss_basic_read.c index df46a01..5e1234f 100644 --- a/level_3/fss_basic_read/c/fss_basic_read.c +++ b/level_3/fss_basic_read/c/fss_basic_read.c @@ -1,9 +1,3 @@ -/* FLL - Level 3 - * Project: FSS - * Version: 0.5.0 - * Licenses: lgplv2.1 - * Programmers: Kevin Day - */ #include #ifdef __cplusplus diff --git a/level_3/fss_basic_read/c/fss_basic_read.h b/level_3/fss_basic_read/c/fss_basic_read.h index 8397f93..f548be7 100644 --- a/level_3/fss_basic_read/c/fss_basic_read.h +++ b/level_3/fss_basic_read/c/fss_basic_read.h @@ -1,13 +1,13 @@ -/* FLL - Level 3 - * Project: FSS - * Version: 0.5.0 - * Licenses: lgplv2.1 - * Programmers: Kevin Day - * Documentation: +/** + * FLL - Level 3 + * + * Project: FSS + * API Version: 0.5 + * Licenses: lgplv2.1 * * This is the FSS Basic Read program * This program utilizes the Featureless Linux Library. - * This program processes files or other input in fss format and stores the results in the fss_basic_read_data + * This program processes files or other input in fss format and stores the results in the fss_basic_read_data. */ #ifndef _fss_basic_read_h diff --git a/level_3/fss_basic_write/c/fss_basic_write.c b/level_3/fss_basic_write/c/fss_basic_write.c index 0b10e52..644de3b 100644 --- a/level_3/fss_basic_write/c/fss_basic_write.c +++ b/level_3/fss_basic_write/c/fss_basic_write.c @@ -1,9 +1,3 @@ -/* FLL - Level 3 - * Project: FSS - * Version: 0.5.0 - * Licenses: lgplv2.1 - * Programmers: Kevin Day - */ #include #ifdef __cplusplus diff --git a/level_3/fss_basic_write/c/fss_basic_write.h b/level_3/fss_basic_write/c/fss_basic_write.h index 6411efc..2463429 100644 --- a/level_3/fss_basic_write/c/fss_basic_write.h +++ b/level_3/fss_basic_write/c/fss_basic_write.h @@ -1,9 +1,9 @@ -/* FLL - Level 3 - * Project: FSS - * Version: 0.5.0 - * Licenses: lgplv2.1 - * Programmers: Kevin Day - * Documentation: +/** + * FLL - Level 3 + * + * Project: FSS + * API Version: 0.5 + * Licenses: lgplv2.1 * * This program provides fss basic write functionality. */ diff --git a/level_3/fss_extended_read/c/fss_extended_read.c b/level_3/fss_extended_read/c/fss_extended_read.c index ed15b9c..6fbfd00 100644 --- a/level_3/fss_extended_read/c/fss_extended_read.c +++ b/level_3/fss_extended_read/c/fss_extended_read.c @@ -1,9 +1,3 @@ -/* FLL - Level 3 - * Project: FSS - * Version: 0.5.0 - * Licenses: lgplv2.1 - * Programmers: Kevin Day - */ #include #ifdef __cplusplus diff --git a/level_3/fss_extended_read/c/fss_extended_read.h b/level_3/fss_extended_read/c/fss_extended_read.h index 5bf71d6..ed1499b 100644 --- a/level_3/fss_extended_read/c/fss_extended_read.h +++ b/level_3/fss_extended_read/c/fss_extended_read.h @@ -1,13 +1,13 @@ -/* FLL - Level 3 - * Project: FSS - * Version: 0.5.0 - * Licenses: lgplv2.1 - * Programmers: Kevin Day - * Documentation: +/** + * FLL - Level 3 + * + * Project: FSS + * API Version: 0.5 + * Licenses: lgplv2.1 * * This is the FSS Basic Read program * This program utilizes the Featureless Linux Library. - * This program processes files or other input in fss format and stores the results in the fss_extended_read_data + * This program processes files or other input in fss format and stores the results in the fss_extended_read_data. */ #ifndef _fss_extended_read_h diff --git a/level_3/fss_extended_write/c/fss_extended_write.c b/level_3/fss_extended_write/c/fss_extended_write.c index 90c045f..df4fae2 100644 --- a/level_3/fss_extended_write/c/fss_extended_write.c +++ b/level_3/fss_extended_write/c/fss_extended_write.c @@ -1,9 +1,3 @@ -/* FLL - Level 3 - * Project: FSS - * Version: 0.5.0 - * Licenses: lgplv2.1 - * Programmers: Kevin Day - */ #include #ifdef __cplusplus diff --git a/level_3/fss_extended_write/c/fss_extended_write.h b/level_3/fss_extended_write/c/fss_extended_write.h index 0f5a83f..cb82cac 100644 --- a/level_3/fss_extended_write/c/fss_extended_write.h +++ b/level_3/fss_extended_write/c/fss_extended_write.h @@ -1,9 +1,9 @@ -/* FLL - Level 3 - * Project: FSS - * Version: 0.5.0 - * Licenses: lgplv2.1 - * Programmers: Kevin Day - * Documentation: +/** + * FLL - Level 3 + * + * Project: FSS + * API Version: 0.5 + * Licenses: lgplv2.1 * * This program provides fss basic write functionality. */ diff --git a/level_3/fss_return_code/c/fss_return_code.c b/level_3/fss_return_code/c/fss_return_code.c index fb65f95..fc7fb4b 100644 --- a/level_3/fss_return_code/c/fss_return_code.c +++ b/level_3/fss_return_code/c/fss_return_code.c @@ -1,9 +1,3 @@ -/* FLL - Level 3 - * Project: FSS - * Version: 0.5.0 - * Licenses: lgplv2.1 - * Programmers: Kevin Day - */ #include #ifdef __cplusplus diff --git a/level_3/fss_return_code/c/fss_return_code.h b/level_3/fss_return_code/c/fss_return_code.h index 672cf6f..fb2e886 100644 --- a/level_3/fss_return_code/c/fss_return_code.h +++ b/level_3/fss_return_code/c/fss_return_code.h @@ -1,9 +1,9 @@ -/* FLL - Level 3 - * Project: FSS - * Version: 0.5.0 - * Licenses: lgplv2.1 - * Programmers: Kevin Day - * Documentation: +/** + * FLL - Level 3 + * + * Project: FSS + * API Version: 0.5 + * Licenses: lgplv2.1 * * This program provides error code to string translation. */ diff --git a/level_3/return_code/c/return_code.c b/level_3/return_code/c/return_code.c index aefc3fd..aec79d0 100644 --- a/level_3/return_code/c/return_code.c +++ b/level_3/return_code/c/return_code.c @@ -1,9 +1,3 @@ -/* FLL - Level 3 - * Project: FSS - * Version: 0.5.0 - * Licenses: lgplv2.1 - * Programmers: Kevin Day - */ #include #ifdef __cplusplus diff --git a/level_3/return_code/c/return_code.h b/level_3/return_code/c/return_code.h index ceb9b5d..6752788 100644 --- a/level_3/return_code/c/return_code.h +++ b/level_3/return_code/c/return_code.h @@ -1,11 +1,9 @@ -/* FLL - Level 3 - * Project: FSS - * Version: 0.5.0 - * Licenses: lgplv2.1 - * Programmers: Kevin Day - * Documentation: +/** + * FLL - Level 3 * - * This program provides error code to string translation. + * Project: Return Code + * API Version: 0.5 + * Licenses: lgplv2.1 */ #ifndef _return_code_h -- 1.8.3.1