add doc comments

Author: Dzuchun

espflash/src/command.rs

@@ -215,6 +215,10 @@ impl CommandType {
         }
     }
 
+    /// Return an assumed maximum response length for the [`CommandType`]
+    /// variant.
+    ///
+    /// Default length is assumed 5MiB.
     pub fn max_respose_len(&self) -> u64 {
         match self {
             CommandType::Sync => SYNC_MAX_LEN,

espflash/src/connection/mod.rs

@@ -542,7 +542,7 @@ impl Connection {
         Ok(Some(header))
     }
 
-    /// Reads the response from a serial port.
+    /// Reads the response from a serial port, bounded by `max_len` bytes.
     pub fn read_response(&mut self, max_len: u64) -> Result<Option<CommandResponse>, Error> {
         match self.read_bounded(10, max_len)? {
             None => Ok(None),
@@ -598,7 +598,7 @@ impl Connection {
         }
     }
 
-    /// Reads the response from a serial port.
+    /// Reads the response from a serial port for a given [`CommandType`].
     pub fn read_response_for_command(
         &mut self,
         ty: CommandType,