Merge branch 'docs' into 'main'

docs: add documentation comments to crate

Closes #151

See merge request obnam/obnam!200

1 files changed, 5 insertions, 0 deletions

diff --git a/src/cmd/list_files.rs b/src/cmd/list_files.rs
index bdec55b..888943e 100644
--- a/src/cmd/list_files.rs
+++ b/src/cmd/list_files.rs
@@ -1,3 +1,5 @@
+//! The `list-files` subcommand.
+
 use crate::backup_reason::Reason;
 use crate::client::AsyncBackupClient;
 use crate::config::ClientConfig;
@@ -7,13 +9,16 @@ use structopt::StructOpt;
 use tempfile::NamedTempFile;
 use tokio::runtime::Runtime;
 
+/// List files in a backup.
 #[derive(Debug, StructOpt)]
 pub struct ListFiles {
+    /// Reference to backup to list files in.
     #[structopt(default_value = "latest")]
     gen_id: String,
 }
 
 impl ListFiles {
+    /// Run the command.
     pub fn run(&self, config: &ClientConfig) -> Result<(), ObnamError> {
         let rt = Runtime::new()?;
         rt.block_on(self.run_async(config))