From: Kevin Day <thekevinday@gmail.com>
Date: Wed, 30 Mar 2022 03:53:42 +0000 (-0500)
Subject: Cleanup: Remove delete function notes from documentation comments.
X-Git-Tag: 0.5.9~42
X-Git-Url: https://git.kevux.org/?a=commitdiff_plain;h=fd0ba249fecaa7f9793866b279e616c7929e9bf1;p=fll

Cleanup: Remove delete function notes from documentation comments.
---

diff --git a/level_3/fss_status_code/c/fss_status_code.h b/level_3/fss_status_code/c/fss_status_code.h
index adb5dc6..8502b54 100644
--- a/level_3/fss_status_code/c/fss_status_code.h
+++ b/level_3/fss_status_code/c/fss_status_code.h
@@ -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);
diff --git a/level_3/iki_read/c/iki_read.h b/level_3/iki_read/c/iki_read.h
index 81fc311..2140402 100644
--- a/level_3/iki_read/c/iki_read.h
+++ b/level_3/iki_read/c/iki_read.h
@@ -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);
diff --git a/level_3/iki_write/c/iki_write.h b/level_3/iki_write/c/iki_write.h
index aefd2e0..6dfa3f5 100644
--- a/level_3/iki_write/c/iki_write.h
+++ b/level_3/iki_write/c/iki_write.h
@@ -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);
diff --git a/level_3/status_code/c/status_code.h b/level_3/status_code/c/status_code.h
index b676f5b..89901b3 100644
--- a/level_3/status_code/c/status_code.h
+++ b/level_3/status_code/c/status_code.h
@@ -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);
diff --git a/level_3/utf8/c/utf8.h b/level_3/utf8/c/utf8.h
index a5ba175..c8fa417 100644
--- a/level_3/utf8/c/utf8.h
+++ b/level_3/utf8/c/utf8.h
@@ -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);