Add module level doc headers

Signed-off-by: Marcel Müller <neikos@neikos.email>

8 files changed, 8 insertions, 1 deletions

diff --git a/mqtt-format/src/v5/bytes.rs b/mqtt-format/src/v5/bytes.rs
index f9a2a01..b1623c2 100644
--- a/mqtt-format/src/v5/bytes.rs
+++ b/mqtt-format/src/v5/bytes.rs
@@ -3,6 +3,7 @@
 //   License, v. 2.0. If a copy of the MPL was not distributed with this
 //   file, You can obtain one at http://mozilla.org/MPL/2.0/.
 //
+//! Ways to parse MQTT byte data
 
 use winnow::binary::length_take;
 use winnow::Bytes;
diff --git a/mqtt-format/src/v5/fixed_header.rs b/mqtt-format/src/v5/fixed_header.rs
index eb90204..ed0ba85 100644
--- a/mqtt-format/src/v5/fixed_header.rs
+++ b/mqtt-format/src/v5/fixed_header.rs
@@ -3,6 +3,7 @@
 //   License, v. 2.0. If a copy of the MPL was not distributed with this
 //   file, You can obtain one at http://mozilla.org/MPL/2.0/.
 //
+//! Everything around parsing the fixed MQTT Header
 
 use winnow::binary::bits::bits;
 use winnow::error::ErrMode;
diff --git a/mqtt-format/src/v5/mod.rs b/mqtt-format/src/v5/mod.rs
index b48ccb8..f393810 100644
--- a/mqtt-format/src/v5/mod.rs
+++ b/mqtt-format/src/v5/mod.rs
@@ -43,7 +43,7 @@ pub mod packets;
 pub mod properties;
 pub mod reason_code;
 pub mod strings;
-pub mod util;
+mod util;
 pub mod variable_header;
 
 pub type MResult<O> = winnow::PResult<O>;
diff --git a/mqtt-format/src/v5/packets/mod.rs b/mqtt-format/src/v5/packets/mod.rs
index 6b7737c..5988b11 100644
--- a/mqtt-format/src/v5/packets/mod.rs
+++ b/mqtt-format/src/v5/packets/mod.rs
@@ -3,6 +3,7 @@
 //   License, v. 2.0. If a copy of the MPL was not distributed with this
 //   file, You can obtain one at http://mozilla.org/MPL/2.0/.
 //
+//! Handling of MQTT Control Packets
 
 use winnow::error::ContextError;
 use winnow::error::ErrMode;
diff --git a/mqtt-format/src/v5/properties.rs b/mqtt-format/src/v5/properties.rs
index 3ab5796..506deb5 100644
--- a/mqtt-format/src/v5/properties.rs
+++ b/mqtt-format/src/v5/properties.rs
@@ -3,6 +3,7 @@
 //   License, v. 2.0. If a copy of the MPL was not distributed with this
 //   file, You can obtain one at http://mozilla.org/MPL/2.0/.
 //
+//! Handling of MQTT Properties that are present in some packets
 
 use winnow::error::ErrMode;
 use winnow::error::ParserError;
diff --git a/mqtt-format/src/v5/reason_code.rs b/mqtt-format/src/v5/reason_code.rs
index ea36000..10d88f2 100644
--- a/mqtt-format/src/v5/reason_code.rs
+++ b/mqtt-format/src/v5/reason_code.rs
@@ -3,6 +3,7 @@
 //   License, v. 2.0. If a copy of the MPL was not distributed with this
 //   file, You can obtain one at http://mozilla.org/MPL/2.0/.
 //
+//! Handling reason codes that are present in some packets
 
 macro_rules! make_combined_reason_code {
     (pub enum $name:ident {
diff --git a/mqtt-format/src/v5/strings.rs b/mqtt-format/src/v5/strings.rs
index 8fb2fa5..91c81e1 100644
--- a/mqtt-format/src/v5/strings.rs
+++ b/mqtt-format/src/v5/strings.rs
@@ -3,6 +3,7 @@
 //   License, v. 2.0. If a copy of the MPL was not distributed with this
 //   file, You can obtain one at http://mozilla.org/MPL/2.0/.
 //
+//! Various ways to parse MQTT Strings
 
 use winnow::binary::length_take;
 use winnow::error::ErrMode;
diff --git a/mqtt-format/src/v5/variable_header.rs b/mqtt-format/src/v5/variable_header.rs
index 4d0212d..011efe3 100644
--- a/mqtt-format/src/v5/variable_header.rs
+++ b/mqtt-format/src/v5/variable_header.rs
@@ -3,6 +3,7 @@
 //   License, v. 2.0. If a copy of the MPL was not distributed with this
 //   file, You can obtain one at http://mozilla.org/MPL/2.0/.
 //
+//! Various components present in MQTT variable headers
 
 use winnow::Bytes;
 use winnow::Parser;