libgps.3: Update gps_read() prototype.

And some related nits.

1 files changed, 7 insertions, 1 deletions

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;