From 1b13ce3a6973653309cc402858e0c422842ad8ce Mon Sep 17 00:00:00 2001
From: "Gary E. Miller" <gem@rellim.com>
Date: Mon, 4 Feb 2019 17:48:52 -0800
Subject: libgps.3: Update gps_read() prototype.

And some related nits.
---
 libgps_core.c | 8 +++++++-
 1 file changed, 7 insertions(+), 1 deletion(-)

(limited to 'libgps_core.c')

diff --git a/libgps_core.c b/libgps_core.c
index 21012df4..bedfa37e 100644
--- a/libgps_core.c
+++ b/libgps_core.c
@@ -147,9 +147,15 @@ int gps_close(struct gps_data_t *gpsdata CONDITIONALLY_UNUSED)
 	return status;
 }
 
+/* read from a gpsd connection
+ *
+ * parameters:
+ *    gps_data_t *gpsdata   -- structure for GPS data
+ *    char *message         -- NULL, or optional buffer for received JSON
+ *    int message_len       -- zero, or sizeof(message)
+ */
 int gps_read(struct gps_data_t *gpsdata CONDITIONALLY_UNUSED,
              char *message, int message_len)
-/* read from a gpsd connection */
 {
     int status = -1;
 
-- 
cgit v1.2.1