summaryrefslogtreecommitdiff
path: root/src/lib.rs
diff options
context:
space:
mode:
authorLibravatar Silas Bartha <[email protected]>2024-05-27 14:20:08 -0400
committerLibravatar Silas Bartha <[email protected]>2024-05-27 14:20:08 -0400
commitccb19be9d0e918070029f31a86c7eb546121bd87 (patch)
tree6192bc514a7ae815a8863a23b4cc59405c18ec37 /src/lib.rs
parentd088553bd19c58543b908936ba8bae2bfa877b50 (diff)
Updated docs
Diffstat (limited to 'src/lib.rs')
-rw-r--r--src/lib.rs14
1 files changed, 11 insertions, 3 deletions
diff --git a/src/lib.rs b/src/lib.rs
index a1ed909..7cbae7c 100644
--- a/src/lib.rs
+++ b/src/lib.rs
@@ -1,7 +1,15 @@
-pub mod codec;
+#![warn(missing_docs)]
-#[cfg(feature = "jpg")]
-pub mod jpg;
+//! Library providing steganography codecs for various carrier and payload types, designed to be
+//! extensible.
+mod codec;
+pub use codec::*;
+
+/// Codecs for carriers in JPEG format.
+#[cfg(feature = "jpeg")]
+pub mod jpeg;
+
+/// Codecs for carriers in lossless image formats (PNG, WebP, etc.).
#[cfg(feature = "lossless")]
pub mod lossless;