docs: added documentation, enforced documentation

src/lib.rs

@@ -1,10 +1,27 @@
+//! pkh: Debian packaging helper
+//!
+//! pkh allows working with Debian packages, with multiple actions/submodules
+#![deny(missing_docs)]
+
+/// Build a Debian source package (into a .dsc)
 pub mod build;
+/// Parse or edit a Debian changelog of a source package
 pub mod changelog;
-pub mod context;
+/// Build a Debian package into a binary (.deb)
 pub mod deb;
+/// Obtain information about one or multiple packages
 pub mod package_info;
+/// Download a source package locally
 pub mod pull;
 
+/// Handle context for .deb building: locally, over ssh, in a chroot...
+pub mod context;
+
+/// Optional callback function (taking 4 arguments)
+/// - Name of the current main operation (e.g. pulling package)
+/// - Name of the current nested operation (e.g. cloning git repo)
+/// - Progress, position, index of current operation (e.g. amount of data downloaded)
+/// - Total amount for current operation (e.g. size of the file to download)
 pub type ProgressCallback<'a> = Option<&'a dyn Fn(&str, &str, usize, usize)>;
 
 /// Returns the architecture of current CPU, debian-compatible