Cleanup: FSS Program documentation.

diff --git a/level_3/fss_basic_list_read/c/private-fss_basic_list_read.h b/level_3/fss_basic_list_read/c/private-fss_basic_list_read.h
index 439b6c9420db5c3f8ac6cb78606c74c654021e72..610391c33264b68fdf2118941329ee65758d020d 100644 (file)
--- a/level_3/fss_basic_list_read/c/private-fss_basic_list_read.h
+++ b/level_3/fss_basic_list_read/c/private-fss_basic_list_read.h
@@ -171,6 +171,8 @@ extern "C" {
  *
  * @return
  *   F_none on success.
+ *
+ *   Status codes (with error bit) are returned on any problem.
  */
 #ifndef _di_fss_basic_list_read_main_preprocess_depth_
   extern f_return_status fss_basic_list_read_main_preprocess_depth(const f_console_arguments_t arguments, const fss_basic_list_read_data_t data, fss_basic_list_read_depths_t *depths) f_gcc_attribute_visibility_internal;

diff --git a/level_3/fss_basic_list_write/c/private-fss_basic_list_write.h b/level_3/fss_basic_list_write/c/private-fss_basic_list_write.h
index 8a3a5cbff5745f69c61a307526194c430f556581..e408a316a28b784c562b426e189d184c9841f8d4 100644 (file)
--- a/level_3/fss_basic_list_write/c/private-fss_basic_list_write.h
+++ b/level_3/fss_basic_list_write/c/private-fss_basic_list_write.h
@@ -17,10 +17,6 @@ extern "C" {
  *
  * @param data
  *   The program data.
- *
- * @return
- *   F_none on success.
- *   F_failure (with error bit) for any othe failure.
  */
 #ifndef _di_fss_basic_list_write_error_parameter_same_times_print_
   void fss_basic_list_write_error_parameter_same_times_print(const fss_basic_list_write_data_t data) f_gcc_attribute_visibility_internal;
@@ -31,10 +27,6 @@ extern "C" {
  *
  * @param data
  *   The program data.
- *
- * @return
- *   F_none on success.
- *   F_failure (with error bit) for any othe failure.
  */
 #ifndef _di_fss_basic_list_write_error_parameter_unsupported_eol_print_
   void fss_basic_list_write_error_parameter_unsupported_eol_print(const fss_basic_list_write_data_t data) f_gcc_attribute_visibility_internal;
@@ -49,10 +41,6 @@ extern "C" {
  *   The console symbol, such as "--" in "--help".
  * @param parameter
  *   The parameter name, such as "help" in "--help".
- *
- * @return
- *   F_none on success.
- *   F_failure (with error bit) for any othe failure.
  */
 #ifndef _di_fss_basic_list_write_error_parameter_value_missing_print_
   void fss_basic_list_write_error_parameter_value_missing_print(const fss_basic_list_write_data_t data, const f_string_t symbol, const f_string_t parameter) f_gcc_attribute_visibility_internal;

diff --git a/level_3/fss_basic_read/c/private-fss_basic_read.h b/level_3/fss_basic_read/c/private-fss_basic_read.h
index bf24b885b320db784355c49caa2313d8babf5ba2..c03d8d0fa8071c94d6cd0c949378e327c7dea111 100644 (file)
--- a/level_3/fss_basic_read/c/private-fss_basic_read.h
+++ b/level_3/fss_basic_read/c/private-fss_basic_read.h
@@ -171,7 +171,8 @@ extern "C" {
  *
  * @return
  *   F_none on success.
- *   F_parameter (with error bit) if a parameter is invalid.
+ *
+ *   Status codes (with error bit) are returned on any problem.
  */
 #ifndef _di_fss_basic_read_main_preprocess_depth_
   extern f_return_status fss_basic_read_main_preprocess_depth(const f_console_arguments_t arguments, const fss_basic_read_data_t data, fss_basic_read_depths_t *depths) f_gcc_attribute_visibility_internal;
@@ -191,6 +192,11 @@ extern "C" {
  * @param delimits
  *   An array of delimits detected during processing.
  *
+ * @return
+ *   F_none on success.
+ *
+ *   Status codes (with error bit) are returned on any problem.
+ *
  * @see fss_basic_read_main_preprocess_depth()
  */
 #ifndef _di_fss_basic_read_main_process_file_

diff --git a/level_3/fss_basic_write/c/private-fss_basic_write.h b/level_3/fss_basic_write/c/private-fss_basic_write.h
index 7e4ebca761f7dbd658d0d513a7f91cdf3e04257f..8263e6c5b1634d28cba7ec179b9fa798c222ab4c 100644 (file)
--- a/level_3/fss_basic_write/c/private-fss_basic_write.h
+++ b/level_3/fss_basic_write/c/private-fss_basic_write.h
@@ -17,10 +17,6 @@ extern "C" {
  *
  * @param data
  *   The program data.
- *
- * @return
- *   F_none on success.
- *   F_failure (with error bit) for any othe failure.
  */
 #ifndef _di_fss_basic_write_error_parameter_same_times_print_
   void fss_basic_write_error_parameter_same_times_print(const fss_basic_write_data_t data) f_gcc_attribute_visibility_internal;
@@ -35,10 +31,6 @@ extern "C" {
  *   The console symbol, such as "--" in "--help".
  * @param parameter
  *   The parameter name, such as "help" in "--help".
- *
- * @return
- *   F_none on success.
- *   F_failure (with error bit) for any othe failure.
  */
 #ifndef _di_fss_basic_write_error_parameter_value_missing_print_
   void fss_basic_write_error_parameter_value_missing_print(const fss_basic_write_data_t data, const f_string_t symbol, const f_string_t parameter) f_gcc_attribute_visibility_internal;
@@ -49,10 +41,6 @@ extern "C" {
  *
  * @param data
  *   The program data.
- *
- * @return
- *   F_none on success.
- *   F_failure (with error bit) for any othe failure.
  */
 #ifndef _di_fss_basic_write_error_parameter_unsupported_eol_print_
   void fss_basic_write_error_parameter_unsupported_eol_print(const fss_basic_write_data_t data) f_gcc_attribute_visibility_internal;

diff --git a/level_3/fss_extended_list_write/c/private-fss_extended_list_write.h b/level_3/fss_extended_list_write/c/private-fss_extended_list_write.h
index 5f567732e7d83538869e9fb3cd1082e32a039893..0e1f5547cc08f94dc256d03735cec5f87878681c 100644 (file)
--- a/level_3/fss_extended_list_write/c/private-fss_extended_list_write.h
+++ b/level_3/fss_extended_list_write/c/private-fss_extended_list_write.h
@@ -17,10 +17,6 @@ extern "C" {
  *
  * @param data
  *   The program data.
- *
- * @return
- *   F_none on success.
- *   F_failure (with error bit) for any othe failure.
  */
 #ifndef _di_fss_extended_list_write_error_parameter_same_times_print_
   void fss_extended_list_write_error_parameter_same_times_print(const fss_extended_list_write_data_t data) f_gcc_attribute_visibility_internal;
@@ -31,10 +27,6 @@ extern "C" {
  *
  * @param data
  *   The program data.
- *
- * @return
- *   F_none on success.
- *   F_failure (with error bit) for any othe failure.
  */
 #ifndef _di_fss_extended_list_write_error_parameter_unsupported_eol_print_
   void fss_extended_list_write_error_parameter_unsupported_eol_print(const fss_extended_list_write_data_t data) f_gcc_attribute_visibility_internal;
@@ -49,10 +41,6 @@ extern "C" {
  *   The console symbol, such as "--" in "--help".
  * @param parameter
  *   The parameter name, such as "help" in "--help".
- *
- * @return
- *   F_none on success.
- *   F_failure (with error bit) for any othe failure.
  */
 #ifndef _di_fss_extended_list_write_error_parameter_value_missing_print_
   void fss_extended_list_write_error_parameter_value_missing_print(const fss_extended_list_write_data_t data, const f_string_t symbol, const f_string_t parameter) f_gcc_attribute_visibility_internal;

diff --git a/level_3/fss_extended_read/c/private-fss_extended_read.h b/level_3/fss_extended_read/c/private-fss_extended_read.h
index a006257f12847bf49eac4deedb9cad9acc6c3a66..1c50929f811a71b6fbab7885efc003a8a9ac0d05 100644 (file)
--- a/level_3/fss_extended_read/c/private-fss_extended_read.h
+++ b/level_3/fss_extended_read/c/private-fss_extended_read.h
@@ -187,7 +187,8 @@ extern "C" {
  *
  * @return
  *   F_none on success.
- *   F_parameter (with error bit) if a parameter is invalid.
+ *
+ *   Status codes (with error bit) are returned on any problem.
  */
 #ifndef _di_fss_extended_read_main_preprocess_depth_
   extern f_return_status fss_extended_read_main_preprocess_depth(const f_console_arguments_t arguments, const fss_extended_read_data_t data, fss_extended_read_depths_t *depths) f_gcc_attribute_visibility_internal;
@@ -209,6 +210,11 @@ extern "C" {
  * @param contents_delimits
  *   An array of delimits detected during processing, for contents.
  *
+ * @return
+ *   F_none on success.
+ *
+ *   Status codes (with error bit) are returned on any problem.
+ *
  * @see fss_extended_read_main_preprocess_depth()
  */
 #ifndef _di_fss_extended_read_main_process_file_