Comment what gpsd_packetdump() does

1 files changed, 12 insertions, 0 deletions

diff --git a/hex.c b/hex.c
index 606356af..0326971c 100644
--- a/hex.c
+++ b/hex.c
@@ -8,6 +8,18 @@
 
 #include "gpsd.h"
 
+/*
+ * gpsd_packetdump()
+ *
+ * if binbuf is printable, just return a copy of it
+ * otherwise) convert a binary string to a hex string and return that
+ *
+ * *scbuf   -- the buffer to fill with hex
+ * scbuflen -- sizeof(scbuf)
+ * *binbuf  -- the binary to convert to hex and place in scbuf
+ * binbuflen -- sizeof(binbuf)
+ */
+
 const char *gpsd_packetdump(char *scbuf, size_t scbuflen,
 			    char *binbuf, size_t binbuflen)
 {