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,4 +1,8 @@
//! High level OBD-II interface
//!
//! Retrieves data from the vehicle, over the OBD-II link. The interface is defined by SAE J1979,
//! and a list of services and PIDs is available [on
//! Wikipedia](https://en.wikipedia.org/wiki/OBD-II_PIDs). This module mostly uses service 1.
mod implementation;
use implementation::GetObd2Values;

View file

@ -24,9 +24,13 @@ pub struct DtcsInfo {
/// An individual trouble code from an ECU
#[derive(Debug)]
pub enum Dtc {
/// Powertrain, represented with `'P'`
Powertrain(u16),
/// Chassis, represented with `'C'`
Chassis(u16),
/// Chassis, represented with `'B'`
Body(u16),
/// Network, represented with `'U'` likely due to previously being the "unknown" category
Network(u16),
}