diff options
| author | Lars Wirzenius <liw@liw.fi> | 2021-12-31 09:00:21 +0200 |
|---|---|---|
| committer | Lars Wirzenius <liw@liw.fi> | 2021-12-31 12:10:10 +0200 |
| commit | acf1ba3f8f1492b961c9a6eb09eb93e882f5eb3f (patch) | |
| tree | 1ce0288f878cac71990bb01f358d6035f1626c92 /src/cmd/backup.rs | |
| parent | 686e87981db210fa443404c8473dfe7a3f39b241 (diff) | |
| download | obnam2-acf1ba3f8f1492b961c9a6eb09eb93e882f5eb3f.tar.gz | |
docs: add documentation comments to crate
Also, make it an error for a public symbol to not be documented.
Sponsored-by: author
Diffstat (limited to 'src/cmd/backup.rs')
| -rw-r--r-- | src/cmd/backup.rs | 4 |
1 files changed, 4 insertions, 0 deletions
diff --git a/src/cmd/backup.rs b/src/cmd/backup.rs index 8f3d6d5..6e09d37 100644 --- a/src/cmd/backup.rs +++ b/src/cmd/backup.rs @@ -1,3 +1,5 @@ +//! The `backup` subcommand. + use crate::backup_run::BackupRun; use crate::client::AsyncBackupClient; use crate::config::ClientConfig; @@ -10,10 +12,12 @@ use structopt::StructOpt; use tempfile::NamedTempFile; use tokio::runtime::Runtime; +/// Make a backup. #[derive(Debug, StructOpt)] pub struct Backup {} impl Backup { + /// Run the command. pub fn run(&self, config: &ClientConfig) -> Result<(), ObnamError> { let rt = Runtime::new()?; rt.block_on(self.run_async(config)) |