Skip to content

Commit 951f2e2

Browse files
committed
docs: Improve docstrings
1 parent b2a0998 commit 951f2e2

File tree

1 file changed

+5
-3
lines changed

1 file changed

+5
-3
lines changed

espflash/src/cli/config.rs

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -72,14 +72,16 @@ impl UsbDevice {
7272
}
7373
}
7474

75-
/// Deserialized contents of a configuration file
75+
/// Configuration for the project and the port
7676
#[derive(Debug, Deserialize, Serialize, Default, Clone)]
7777
pub struct Config {
78+
/// Project configuration
7879
pub project_config: ProjectConfig,
80+
/// Port configuration
7981
pub port_config: PortConfig,
8082
}
8183

82-
/// Deserialized contents of a configuration file
84+
/// Project configuration
8385
#[derive(Debug, Deserialize, Serialize, Default, Clone)]
8486
pub struct ProjectConfig {
8587
/// Baudrate
@@ -99,7 +101,7 @@ pub struct ProjectConfig {
99101
pub flash: FlashSettings,
100102
}
101103

102-
/// Deserialized contents of a serial port configuration file
104+
/// Serial port configuration
103105
#[derive(Debug, Deserialize, Serialize, Default, Clone)]
104106
pub struct PortConfig {
105107
/// Preferred serial port connection information

0 commit comments

Comments
 (0)