Add more doc comments

This commit is contained in:
Robert Sammelson 2023-05-17 22:42:45 -04:00
parent fb35987b28
commit 5b20ac0ab9
No known key found for this signature in database
GPG key ID: 92F1F04EDB06B9E9
6 changed files with 29 additions and 4 deletions

View file

@ -1,6 +1,8 @@
//! Crate for communicating with OBD-II (on-board diagnostics) interfaces on cars
//!
//! The high-level data retrieval functions can be found in [commands::Obd2DataRetrieval].
//! Currently only the ELM327 is supported (many cheap USB to OBD-II devices you can buy online are
//! compatible with the ELM327). The high-level data retrieval functions can be found in
//! [commands::Obd2DataRetrieval].
//!
//! # Usage
//! ```
@ -14,6 +16,7 @@
//! ```
#![forbid(unsafe_code)]
#![warn(missing_docs)]
pub mod commands;