add docs

Author: tzilist

swiftnav/src/nmea/checksum.rs

@@ -1,3 +1,13 @@
+// Copyright (c) 2025 Swift Navigation Inc.
+// Contact: Swift Navigation <[email protected]>
+//
+// This source is subject to the license found in the file 'LICENSE' which must
+// be be distributed together with this source. All other rights reserved.
+//
+// THIS CODE AND INFORMATION IS PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND,
+// EITHER EXPRESSED OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE IMPLIED
+// WARRANTIES OF MERCHANTABILITY AND/OR FITNESS FOR A PARTICULAR PURPOSE.
+
 fn u8_to_nibbles(byte: u8) -> (u8, u8) {
     // The high nibble is obtained by shifting the byte 4 bits to the right.
     // This discards the lower 4 bits and moves the upper 4 bits into the lower 4 bit positions.

swiftnav/src/nmea/gga.rs

@@ -1,3 +1,13 @@
+// Copyright (c) 2025 Swift Navigation Inc.
+// Contact: Swift Navigation <[email protected]>
+//
+// This source is subject to the license found in the file 'LICENSE' which must
+// be be distributed together with this source. All other rights reserved.
+//
+// THIS CODE AND INFORMATION IS PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND,
+// EITHER EXPRESSED OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE IMPLIED
+// WARRANTIES OF MERCHANTABILITY AND/OR FITNESS FOR A PARTICULAR PURPOSE.
+
 use std::{
     fmt::{self},
     time::Duration,
@@ -51,7 +61,8 @@ impl fmt::Display for GPSQuality {
     }
 }
 
-/// Geographic coordinates including altitude, GPS solution quality, DGPS usage information.
+/// Global Positioning System Fix Data including time, position and fix related data for a GNSS
+/// receiver
 #[derive(Debug, PartialEq, Clone, Builder)]
 pub struct GGA {
     /// Time of fix in UTC.

swiftnav/src/nmea/mod.rs

@@ -1,3 +1,17 @@
+// Copyright (c) 2025 Swift Navigation Inc.
+// Contact: Swift Navigation <[email protected]>
+//
+// This source is subject to the license found in the file 'LICENSE' which must
+// be be distributed together with this source. All other rights reserved.
+//
+// THIS CODE AND INFORMATION IS PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND,
+// EITHER EXPRESSED OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE IMPLIED
+// WARRANTIES OF MERCHANTABILITY AND/OR FITNESS FOR A PARTICULAR PURPOSE.
+
+//! This module contains National Marine Electronics Association (NMEA) related structures and
+//! formatting utilities. Notably, it contains (or eventually will contain) structures related to
+//! NMEA sentences and parsing/serialization of those sentences.
+
 mod checksum;
 mod gga;