Move the top level module documentation summaries into each respective source file instead of being in lib.rs

Author: jhodapp

esp32-wroom-rp/src/gpio.rs

@@ -1,4 +1,4 @@
-//! GPIO pin control interface of a connected ESP32-WROOM target Wifi board.
+//! GPIO pin control interface of a connected ESP32-WROOM target WiFi board.
 //!
 //! ## Usage
 //!

esp32-wroom-rp/src/lib.rs

@@ -149,16 +149,10 @@
 #![warn(missing_docs)]
 #![cfg_attr(not(test), no_std)]
 
-/// Fundamental interface for creating and send/receiving data to/from a TCP server.
 pub mod tcp_client;
-
 pub mod gpio;
-/// Fundamental interface for controlling a connected ESP32-WROOM NINA firmware-based Wifi board.
 pub mod wifi;
-
-/// Responsible for interactions over a WiFi network and also contains related types.
 pub mod network;
-/// Responsible for interactions with NINA firmware over a data bus.
 pub mod protocol;
 
 mod spi;

esp32-wroom-rp/src/network.rs

@@ -1,3 +1,11 @@
+//! Defines common network functions, types and error definitions.
+//!
+//! ## Usage
+//!
+//! ```no_run
+//! ```
+//!
+
 use defmt::{write, Format, Formatter};
 
 /// A four byte array type alias representing an IP address.

esp32-wroom-rp/src/protocol.rs

@@ -1,3 +1,11 @@
+//! Defines functions, types and error definitions related to the WiFiNINA protocol communication specification.
+//!
+//! ## Usage
+//!
+//! ```no_run
+//! ```
+//!
+
 pub(crate) mod operation;
 
 use embedded_hal::blocking::delay::DelayMs;

esp32-wroom-rp/src/tcp_client.rs

@@ -1,3 +1,11 @@
+//! Send/receive data to/from a TCP server.
+//!
+//! ## Usage
+//!
+//! ```no_run
+//! ```
+//! 
+
 use super::{Error, ARRAY_LENGTH_PLACEHOLDER};
 use crate::{network::NetworkError, wifi::Wifi};
 

esp32-wroom-rp/src/wifi.rs

@@ -1,3 +1,11 @@
+//! Perform common core WiFi functions such as join a network, resolve a DNS hostname, etc.
+//!
+//! ## Usage
+//!
+//! ```no_run
+//! ```
+//!
+
 use embedded_hal::blocking::delay::DelayMs;
 use embedded_hal::blocking::spi::Transfer;