From: Kevin Day <kevin@kevux.org>
Date: Sat, 24 Feb 2024 05:36:05 +0000 (-0600)
Subject: Cleanup: The fl_print_format_convert() documentation comments should have the status... 
X-Git-Url: https://git.kevux.org/?a=commitdiff_plain;h=14427d92304c1a24e2867b06f03a882426b61b69;p=fll

Cleanup: The fl_print_format_convert() documentation comments should have the status documentation under the status text.

The status documentation should not be in the "@return" section.
The documentation for the "status" parameter should be describing this (and now is).
---

diff --git a/level_1/fl_print/c/print.h b/level_1/fl_print/c/print.h
index 3f6a6a7..985ce14 100644
--- a/level_1/fl_print/c/print.h
+++ b/level_1/fl_print/c/print.h
@@ -244,15 +244,9 @@ extern "C" {
  * @param ap
  *   The variable arguments list.
  * @param status
- *   The status is stored here rather then via the return.
- *   Set to NULL to not use.
- *
- * @return
- *   This returns a string at either the start position (if nothing done or an error occurred) or at the character last processed.
- *   The caller is expected to increment past this if they wish to continue processing the string.
- *
- *   The status parameter will be set as follows:
+ *   (optional) Set to NULL to not use.
  *
+ *   The status parameter will be set as follows on return:
  *     F_okay on success.
  *     F_data_not on success but there is nothing to print.
  *     F_stream_not if file.stream is NULL.
@@ -276,6 +270,10 @@ extern "C" {
  *     Errors (with error bit) from: f_print_safely().
  *     Errors (with error bit) from: f_print_terminated().
  *
+ * @return
+ *   This returns a string at either the start position (if nothing done or an error occurred) or at the character last processed.
+ *   The caller is expected to increment past this if they wish to continue processing the string.
+ *
  * @see fputc_unlocked()
  *
  * @see f_conversion_number_signed_print()