From: Kostya Shishkov <kostya.shishkov@gmail.com>
Date: Fri, 29 Oct 2021 13:03:45 +0000 (+0200)
Subject: add some description to crates providing (de)coders and (de)muxers
X-Git-Url: https://git.nihav.org/?a=commitdiff_plain;h=b9995c2ca73cb50f1e9f2ad7a08c49b20135b041;p=nihav.git

add some description to crates providing (de)coders and (de)muxers
---

diff --git a/nihav-commonfmt/src/lib.rs b/nihav-commonfmt/src/lib.rs
index b02cd81..54fff4b 100644
--- a/nihav-commonfmt/src/lib.rs
+++ b/nihav-commonfmt/src/lib.rs
@@ -1,3 +1,4 @@
+//! Crate for providing support for various common formats.
 extern crate nihav_core;
 extern crate nihav_codec_support;
 extern crate nihav_registry;
diff --git a/nihav-duck/src/lib.rs b/nihav-duck/src/lib.rs
index 0885514..bb290cd 100644
--- a/nihav-duck/src/lib.rs
+++ b/nihav-duck/src/lib.rs
@@ -1,3 +1,4 @@
+//! Crate for providing support for various Duck/On2 formats.
 extern crate nihav_core;
 extern crate nihav_codec_support;
 
diff --git a/nihav-game/src/lib.rs b/nihav-game/src/lib.rs
index 310e3f7..5682ef0 100644
--- a/nihav-game/src/lib.rs
+++ b/nihav-game/src/lib.rs
@@ -1,3 +1,4 @@
+//! Crate for providing support for various game-related formats.
 extern crate nihav_core;
 extern crate nihav_codec_support;
 
diff --git a/nihav-indeo/src/lib.rs b/nihav-indeo/src/lib.rs
index c920ea4..6c7056f 100644
--- a/nihav-indeo/src/lib.rs
+++ b/nihav-indeo/src/lib.rs
@@ -1,3 +1,4 @@
+//! Crate for providing support for Intel multimedia formats.
 extern crate nihav_core;
 extern crate nihav_codec_support;
 
diff --git a/nihav-itu/src/lib.rs b/nihav-itu/src/lib.rs
index 2cd300f..0bf247a 100644
--- a/nihav-itu/src/lib.rs
+++ b/nihav-itu/src/lib.rs
@@ -1,3 +1,4 @@
+//! Crate for providing support for ITU codecs.
 extern crate nihav_core;
 extern crate nihav_codec_support;
 
diff --git a/nihav-llaudio/src/lib.rs b/nihav-llaudio/src/lib.rs
index cbbe12b..710a22e 100644
--- a/nihav-llaudio/src/lib.rs
+++ b/nihav-llaudio/src/lib.rs
@@ -1,3 +1,4 @@
+//! Crate for providing support for various lossless audio formats.
 extern crate nihav_core;
 extern crate nihav_codec_support;
 
diff --git a/nihav-ms/src/lib.rs b/nihav-ms/src/lib.rs
index ebc84f5..2274a20 100644
--- a/nihav-ms/src/lib.rs
+++ b/nihav-ms/src/lib.rs
@@ -1,3 +1,4 @@
+//! Crate for providing support for various Microsoft multimedia formats.
 extern crate nihav_core;
 extern crate nihav_codec_support;
 
diff --git a/nihav-qt/src/lib.rs b/nihav-qt/src/lib.rs
index c434016..2c2e792 100644
--- a/nihav-qt/src/lib.rs
+++ b/nihav-qt/src/lib.rs
@@ -1,3 +1,4 @@
+//! Crate for providing support for various QuickTime formats.
 extern crate nihav_core;
 extern crate nihav_codec_support;
 
diff --git a/nihav-rad/src/lib.rs b/nihav-rad/src/lib.rs
index 16a622c..d407fa7 100644
--- a/nihav-rad/src/lib.rs
+++ b/nihav-rad/src/lib.rs
@@ -1,3 +1,4 @@
+//! Crate for providing support for Bink and Smacker formats.
 extern crate nihav_core;
 extern crate nihav_codec_support;
 
diff --git a/nihav-realmedia/src/lib.rs b/nihav-realmedia/src/lib.rs
index 06efd96..bcc66fd 100644
--- a/nihav-realmedia/src/lib.rs
+++ b/nihav-realmedia/src/lib.rs
@@ -1,3 +1,4 @@
+//! Crate for providing support for RealMedia formats.
 extern crate nihav_core;
 extern crate nihav_codec_support;
 
diff --git a/nihav-vivo/src/lib.rs b/nihav-vivo/src/lib.rs
index 97a238b..b5fdfad 100644
--- a/nihav-vivo/src/lib.rs
+++ b/nihav-vivo/src/lib.rs
@@ -1,3 +1,4 @@
+//! Crate for providing support for VivoActive formats.
 extern crate nihav_core;
 extern crate nihav_codec_support;