From: Kostya Shishkov <kostya.shishkov@gmail.com>
Date: Mon, 17 Feb 2020 15:31:42 +0000 (+0100)
Subject: allstuff: document the module
X-Git-Url: https://git.nihav.org/?a=commitdiff_plain;h=5ed804aef554ce737c766c6a66830ca3ed9d140d;p=nihav.git

allstuff: document the module
---

diff --git a/nihav-allstuff/src/lib.rs b/nihav-allstuff/src/lib.rs
index eb8e9a3..2438f89 100644
--- a/nihav-allstuff/src/lib.rs
+++ b/nihav-allstuff/src/lib.rs
@@ -1,3 +1,4 @@
+//! Umbrella crate to register decoders and demuxers from all known NihAV crates.
 extern crate nihav_core;
 extern crate nihav_commonfmt;
 extern crate nihav_duck;
@@ -25,6 +26,7 @@ use nihav_rad::rad_register_all_demuxers;
 use nihav_realmedia::realmedia_register_all_codecs;
 use nihav_realmedia::realmedia_register_all_demuxers;
 
+/// Registers all known decoders.
 pub fn nihav_register_all_codecs(rd: &mut RegisteredDecoders) {
     generic_register_all_codecs(rd);
     duck_register_all_codecs(rd);
@@ -34,6 +36,7 @@ pub fn nihav_register_all_codecs(rd: &mut RegisteredDecoders) {
     realmedia_register_all_codecs(rd);
 }
 
+/// Registers all known demuxers.
 pub fn nihav_register_all_demuxers(rd: &mut RegisteredDemuxers) {
     generic_register_all_demuxers(rd);
     game_register_all_demuxers(rd);