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

diff --git a/src/lib.rs b/src/lib.rs
index 3e378f6..957ec13 100644
--- a/src/lib.rs
+++ b/src/lib.rs
@@ -1,3 +1,10 @@
+//! Encrypted backups.
+//!
+//! Obnam is a backup program that encrypts the backups. This crate
+//! provides access to all the functionality of Obnam as a library.
+
+#![deny(missing_docs)]
+
 pub mod backup_progress;
 pub mod backup_reason;
 pub mod backup_run;