core: document crate a bit

[nihav.git] / nihav-core / src / lib.rs

diff --git a/nihav-core/src/lib.rs b/nihav-core/src/lib.rs
index 6ac5cafea80e913c7a09f8598dd8c11c08be5e67..2652c14f0dcb7125431e02100b230972e93a747e 100644 (file)
--- a/nihav-core/src/lib.rs
+++ b/nihav-core/src/lib.rs
@@ -1,3 +1,4 @@
+//! Core functionality of NihAV intended to be used by both crates implementing format support and users.
 #[cfg(feature="decoders")]
 #[allow(clippy::cast_lossless)]
 #[allow(clippy::identity_op)]