adding docs

dnstp/src/byte/mod.rs

@@ -1,4 +1,4 @@
-//! Utility functions for operating on bytes
+//! Utility functions for operating on bytes including splitting multi-byte integers into bytes and vice versa
 
 #[cfg(test)]
 mod tests;

dnstp/src/config.rs

@@ -1,3 +1,4 @@
+//! Bundling config for the server and client
 
 #[derive(Clone)]
 pub struct DomainConfig {

dnstp/src/crypto/mod.rs

@@ -1,3 +1,5 @@
+//! Method for handling cryptography including ECDH shared secret derivation and symmetric key encryption
+
 #[cfg(test)]
 mod tests;
 

dnstp/src/message/mod.rs

@@ -1,4 +1,4 @@
-//! Structures making up the DNS workflow including requests, responses and headers
+//! Structures making up the DNS workflow including messages and headers
 pub mod header;
 pub mod question;
 pub mod message;

dnstp/src/message_parser.rs

@@ -1,3 +1,5 @@
+//! Functions for constructing internal DNS structures from network message bytes
+
 use crate::byte;
 use crate::message::{DNSMessage, Direction, DNSHeader, Opcode, ResponseCode, QuestionParseError, questions_from_bytes, records_from_bytes, RecordParseError};
 use crate::net::NetworkMessage;

dnstp/src/net/mod.rs

@@ -1,3 +1,5 @@
+//! Network layer for binding and processing UDP traffic
+
 pub mod socket;
 pub mod raw_request;
 

dnstp/src/processor/mod.rs

@@ -1,3 +1,4 @@
+//! Business-logic-like structures for processing parsed messages
 
 pub mod request;
 pub mod response;

dnstp/src/string.rs

@@ -1,3 +1,5 @@
+//! Utility functions for manipulating strings
+
 use urlencoding::encode;
 
 pub fn encode_domain_name(name: &String) -> Vec<u8>