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/engine.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/engine.rs')
-rw-r--r-- | src/engine.rs | 2 |
1 files changed, 2 insertions, 0 deletions
diff --git a/src/engine.rs b/src/engine.rs index 252d3c9..384f591 100644 --- a/src/engine.rs +++ b/src/engine.rs @@ -1,3 +1,5 @@ +//! Engine for doing CPU heavy work in the background. + use crate::workqueue::WorkQueue; use futures::stream::{FuturesOrdered, StreamExt}; use tokio::select; |