Fix documented return code for clear_iob()
authorFabian Keil <fk@fabiankeil.de>
Tue, 25 Aug 2020 21:43:23 +0000 (23:43 +0200)
committerFabian Keil <fk@fabiankeil.de>
Tue, 1 Sep 2020 10:22:42 +0000 (12:22 +0200)
Sponsored by: Robert Klemme

parsers.c

index f83fa04..ad8e01f 100644 (file)
--- a/parsers.c
+++ b/parsers.c
@@ -381,8 +381,7 @@ jb_err add_to_iob(struct iob *iob, const size_t buffer_limit, char *src, long n)
  * Parameters  :
  *          1  :  iob = I/O buffer to clear.
  *
  * Parameters  :
  *          1  :  iob = I/O buffer to clear.
  *
- * Returns     :  JB_ERR_OK on success, JB_ERR_MEMORY if out-of-memory
- *                or buffer limit reached.
+ * Returns     :  N/A
  *
  *********************************************************************/
 void clear_iob(struct iob *iob)
  *
  *********************************************************************/
 void clear_iob(struct iob *iob)