Documentation

Author: mlund

src/lib/filehost.rs

@@ -12,7 +12,7 @@
 // see the license for the specific language governing permissions and
 // limitations under the license.
 
-/// Routines for access the FileHost
+//! Routines for access the MEGA65 FileHost
 
 use anyhow::Result;
 use serde::{Deserialize, Serialize};

src/lib/io.rs

@@ -12,7 +12,7 @@
 // see the license for the specific language governing permissions and
 // limitations under the license.
 
-/// Routines related to file/url/terminal I/O
+//! Routines related to file/url/terminal I/O
 
 use cbm::disk;
 use cbm::disk::file::FileOps;
@@ -91,7 +91,7 @@ pub fn cbm_open(diskimage: &str) -> Result<Box<dyn cbm::disk::Disk>> {
     }
 }
 
-/// Load n'th file ffrom CBM disk image and return load address and bytes
+/// Load n'th file from CBM disk image and return load address and bytes
 pub fn cbm_load_file(disk: &dyn cbm::disk::Disk, index: usize) -> Result<(u16, Vec<u8>)> {
     let dir = disk.directory()?;
     let entry = dir.get(index)

src/lib/lib.rs

@@ -12,12 +12,13 @@
 // see the license for the specific language governing permissions and
 // limitations under the license.
 
-/// Matrix65 serial communicator library
-/// 
-/// This contains basic features for serial communication with the
-/// MEGA65. Auxiliary functions for IO and access the filehost are
-/// also included.
+//! Matrix65 serial communicator library
+//! 
+//! This contains basic features for serial communication with the
+//! MEGA65. Auxiliary functions for IO and access the filehost are
+//! also included.
 
 pub mod serial;
+
 pub mod io;
 pub mod filehost;

src/lib/serial.rs

@@ -12,6 +12,8 @@
 // see the license for the specific language governing permissions and
 // limitations under the license.
 
+//! Serial routines for comminicating with MEGA65
+
 use super::io;
 use hex::FromHex;
 use log::{debug, info};