summaryrefslogtreecommitdiff
path: root/src/workqueue.rs
diff options
context:
space:
mode:
authorLars Wirzenius <liw@liw.fi>2021-12-31 09:00:21 +0200
committerLars Wirzenius <liw@liw.fi>2021-12-31 12:10:10 +0200
commitacf1ba3f8f1492b961c9a6eb09eb93e882f5eb3f (patch)
tree1ce0288f878cac71990bb01f358d6035f1626c92 /src/workqueue.rs
parent686e87981db210fa443404c8473dfe7a3f39b241 (diff)
downloadobnam2-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/workqueue.rs')
-rw-r--r--src/workqueue.rs2
1 files changed, 2 insertions, 0 deletions
diff --git a/src/workqueue.rs b/src/workqueue.rs
index 44ba5e4..6b3ce80 100644
--- a/src/workqueue.rs
+++ b/src/workqueue.rs
@@ -1,3 +1,5 @@
+//! A queue of work for [`crate::engine::Engine`].
+
use tokio::sync::mpsc;
/// A queue of work items.