From ab6cc0be8748d025ed571fc70e9f9bf30aecd443 Mon Sep 17 00:00:00 2001
From: "Gary E. Miller" <gem@rellim.com>
Date: Tue, 29 Mar 2016 15:28:44 -0700
Subject: Comment what gpsd_packetdump() does

---
 hex.c | 12 ++++++++++++
 1 file changed, 12 insertions(+)

(limited to 'hex.c')

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)
 {
-- 
cgit v1.2.1