]> Kevux Git Server - fll/commitdiff
Cleanup: Remove delete function notes from documentation comments.
authorKevin Day <thekevinday@gmail.com>
Wed, 30 Mar 2022 03:53:42 +0000 (22:53 -0500)
committerKevin Day <thekevinday@gmail.com>
Wed, 30 Mar 2022 03:53:42 +0000 (22:53 -0500)
level_3/fss_status_code/c/fss_status_code.h
level_3/iki_read/c/iki_read.h
level_3/iki_write/c/iki_write.h
level_3/status_code/c/status_code.h
level_3/utf8/c/utf8.h

index adb5dc6287db258a1c7d4473af2d083a7bda50b4..8502b54dc6ddf7e4128e57c78c8de8171405842c 100644 (file)
@@ -67,8 +67,6 @@ extern "C" {
 /**
  * Execute main program.
  *
- * Be sure to call fss_status_code_main_delete() after executing this.
- *
  * If main.signal is non-zero, then this blocks and handles the following signals:
  *   - F_signal_abort
  *   - F_signal_broken_pipe
@@ -86,8 +84,6 @@ extern "C" {
  *   F_none on success.
  *
  *   Status codes (with error bit) are returned on any problem.
- *
- * @see fss_status_code_main_delete()
  */
 #ifndef _di_fss_status_code_main_
   extern f_status_t fss_status_code_main(fll_program_data_t * const main, const f_console_arguments_t *arguments);
index 81fc3111c5b78bb7c3405b6b11a3879c7ed947be..21404026b486acaa5e341a4c904882e9fb5dd65f 100644 (file)
@@ -75,8 +75,6 @@ extern "C" {
 /**
  * Execute main program.
  *
- * Be sure to call iki_read_main_delete() after executing this.
- *
  * If main.signal is non-zero, then this blocks and handles the following signals:
  *   - F_signal_abort
  *   - F_signal_broken_pipe
@@ -94,8 +92,6 @@ extern "C" {
  *   F_none on success.
  *
  *   Status codes (with error bit) are returned on any problem.
- *
- * @see iki_read_main_delete()
  */
 #ifndef _di_iki_read_main_
   extern f_status_t iki_read_main(fll_program_data_t * const main, const f_console_arguments_t *arguments);
index aefd2e0bd1a526f8875ab17c7347d4ead8a854b0..6dfa3f588dad37242c9b3affa1587e921234dc49 100644 (file)
@@ -75,8 +75,6 @@ extern "C" {
 /**
  * Execute main program.
  *
- * Be sure to call iki_write_main_delete() after executing this.
- *
  * If main.signal is non-zero, then this blocks and handles the following signals:
  *   - F_signal_abort
  *   - F_signal_broken_pipe
@@ -94,8 +92,6 @@ extern "C" {
  *   F_none on success.
  *
  *   Status codes (with error bit) are returned on any problem.
- *
- * @see iki_write_main_delete()
  */
 #ifndef _di_iki_write_main_
   extern f_status_t iki_write_main(fll_program_data_t * const main, const f_console_arguments_t *arguments);
index b676f5b5e7912f712f41e2ebca7cc53ffa5d36c3..89901b3f9a8ba654f7b2fe8038b1071f354fa27d 100644 (file)
@@ -66,8 +66,6 @@ extern "C" {
 /**
  * Execute main program.
  *
- * Be sure to call status_code_main_delete() after executing this.
- *
  * If main.signal is non-zero, then this blocks and handles the following signals:
  *   - F_signal_abort
  *   - F_signal_broken_pipe
@@ -85,8 +83,6 @@ extern "C" {
  *   F_none on success.
  *
  *   Status codes (with error bit) are returned on any problem.
- *
- * @see status_code_main_delete()
  */
 #ifndef _di_status_code_main_
   extern f_status_t status_code_main(fll_program_data_t * const main, const f_console_arguments_t *arguments);
index a5ba1755470986c0b541aa51c430fc233af0a359..c8fa4177274ea72a7d6655206f64b4aabea7521b 100644 (file)
@@ -79,8 +79,6 @@ extern "C" {
 /**
  * Execute main program.
  *
- * Be sure to call utf8_main_delete() after executing this.
- *
  * If main.signal is non-zero, then this blocks and handles the following signals:
  *   - F_signal_abort
  *   - F_signal_broken_pipe
@@ -101,8 +99,6 @@ extern "C" {
  *   F_signal on (exit) signal received.
  *
  *   Status codes (with error bit) are returned on any problem.
- *
- * @see utf8_main_delete()
  */
 #ifndef _di_utf8_main_
   extern f_status_t utf8_main(fll_program_data_t * const main, const f_console_arguments_t *arguments);