docs: add documentation comments to crate

Also, make it an error for a public symbol to not be documented.

Sponsored-by: author

1 files changed, 4 insertions, 0 deletions

diff --git a/src/cmd/list.rs b/src/cmd/list.rs
index 691f2bf..6c58e30 100644
--- a/src/cmd/list.rs
+++ b/src/cmd/list.rs
@@ -1,13 +1,17 @@
+//! The `list` subcommand.
+
 use crate::client::AsyncBackupClient;
 use crate::config::ClientConfig;
 use crate::error::ObnamError;
 use structopt::StructOpt;
 use tokio::runtime::Runtime;
 
+/// List generations on the server.
 #[derive(Debug, StructOpt)]
 pub struct List {}
 
 impl List {
+    /// Run the command.
     pub fn run(&self, config: &ClientConfig) -> Result<(), ObnamError> {
         let rt = Runtime::new()?;
         rt.block_on(self.run_async(config))