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, 5 insertions, 0 deletions

diff --git a/src/cmd/show_gen.rs b/src/cmd/show_gen.rs
index fb7e1bd..6ec1203 100644
--- a/src/cmd/show_gen.rs
+++ b/src/cmd/show_gen.rs
@@ -1,3 +1,5 @@
+//! The `show-generation` subcommand.
+
 use crate::client::AsyncBackupClient;
 use crate::config::ClientConfig;
 use crate::error::ObnamError;
@@ -7,13 +9,16 @@ use structopt::StructOpt;
 use tempfile::NamedTempFile;
 use tokio::runtime::Runtime;
 
+/// Show information about a generation.
 #[derive(Debug, StructOpt)]
 pub struct ShowGeneration {
+    /// Reference to the generation. Defaults to latest.
     #[structopt(default_value = "latest")]
     gen_id: String,
 }
 
 impl ShowGeneration {
+    /// Run the command.
     pub fn run(&self, config: &ClientConfig) -> Result<(), ObnamError> {
         let rt = Runtime::new()?;
         rt.block_on(self.run_async(config))