From 7f40affb59acefe4d8a9c8cb6a85868602c5ac90 Mon Sep 17 00:00:00 2001
From: Russell-S-Harper <russell.s.harper@gmail.com>
Date: Sat, 21 Jun 2025 08:48:41 -0400
Subject: [PATCH] Adding documentation and some minor reformatting to ensure
 consistency

---
 doc/funcref.sgml     | 39 +++++++++++++++++++++++++++++++++++++++
 include/conio.h      |  2 +-
 libsrc/conio/cgets.c |  4 ++--
 3 files changed, 42 insertions(+), 3 deletions(-)

diff --git a/doc/funcref.sgml b/doc/funcref.sgml
index 5eab5adcd..7e632f71f 100644
--- a/doc/funcref.sgml
+++ b/doc/funcref.sgml
@@ -289,6 +289,7 @@ function.
 <item><ref id="cclear" name="cclear">
 <item><ref id="cclearxy" name="cclearxy">
 <item><ref id="cgetc" name="cgetc">
+<item><ref id="cgets" name="cgets">
 <item><ref id="chline" name="chline">
 <item><ref id="chlinexy" name="chlinexy">
 <item><ref id="clrscr" name="clrscr">
@@ -2715,6 +2716,44 @@ see anything that you type.  (See the description of <tt/cbm_k_scnkey()/.)
 </quote>
 
 
+<sect1>cgets<label id="cgets"><p>
+
+<quote>
+<descrip>
+<tag/Function/Input a string directly to the console.
+<tag/Header/<tt/<ref id="conio.h" name="conio.h">/
+<tag/Declaration/<tt/char* __fastcall__ cgets (const char* buffer, int size);/
+<tag/Description/The function inputs a string of at most <tt/size - 1/
+characters from the console into <tt/buffer/. It returns when <tt/size - 1/
+characters or either <tt/CR/ or <tt/LF/ are entered. It also handles both
+multi-line input and backspacing.
+<tag/Notes/<itemize>
+<item>The function echoes <tt/CRLF/ when either <tt/CR/ or <tt/LF/ are read
+but does NOT append either in <tt/buffer/.
+<item>The function is only available as fastcall function, so it may only
+be used in the presence of a prototype.
+</itemize>
+<tag/Availability/cc65
+<tag/See also/
+<ref id="cgetc" name="cgetc">
+<tag/Example/<verb>
+#include &lt;conio.h&gt;
+
+int main ()
+{
+    char buffer[200], *p;
+
+    cputs ("Type a lot and backspace a lot: ");
+    if (p = cgets (buffer, sizeof(buffer)))
+        cputs (p);
+
+    return 0;
+}
+</verb>
+</descrip>
+</quote>
+
+
 <sect1>chline<label id="chline"><p>
 
 <quote>
diff --git a/include/conio.h b/include/conio.h
index 1bd59b052..3e1614cc1 100644
--- a/include/conio.h
+++ b/include/conio.h
@@ -110,7 +110,7 @@ char cgetc (void);
 ** 1 (see below), a blinking cursor is displayed while waiting.
 */
 
-char* __fastcall__ cgets (char *buffer, int size);
+char* __fastcall__ cgets (char* buffer, int size);
 /* Get a string of characters directly from the console. The function returns
 ** when size - 1 characters or either CR/LF are read. Note the parameters are
 ** more aligned with stdio fgets() as opposed to the quirky "standard" conio
diff --git a/libsrc/conio/cgets.c b/libsrc/conio/cgets.c
index 52e2da343..290a6b131 100644
--- a/libsrc/conio/cgets.c
+++ b/libsrc/conio/cgets.c
@@ -2,7 +2,7 @@
 ** Modified: <iso-date> <author>
 **    Notes: <e.g. revisions made to support target, edge cases, bugs, etc.>
 **
-** char* __fastcall__ cgets (char *buffer, int size);
+** char* __fastcall__ cgets (char* buffer, int size);
 */
 
 #include <stddef.h>
@@ -14,7 +14,7 @@
 #define CRLF "\r\n"
 #endif /* CRLF */
 
-char* __fastcall__ cgets (char *buffer, int size)
+char* __fastcall__ cgets (char* buffer, int size)
 /* Get a string of characters directly from the console. The function returns
 ** when size - 1 characters or either CR/LF are read. Note the parameters are
 ** more aligned with stdio fgets() as opposed to the quirky "standard" conio