make all codec crates export just register_all functions and document them

[nihav.git] / nihav-game / src / codecs / mod.rs

diff --git a/nihav-game/src/codecs/mod.rs b/nihav-game/src/codecs/mod.rs
index 6f707e98bd1578046bbca36640f827ef28af1617..a3d5555276d73f8eb79f66a2e11de01dc88e527a 100644 (file)
--- a/nihav-game/src/codecs/mod.rs
+++ b/nihav-game/src/codecs/mod.rs
@@ -36,6 +36,7 @@ const GAME_CODECS: &[DecoderInfo] = &[
     DecoderInfo { name: "midivid", get_decoder: midivid::get_decoder_video },
 ];
 
+/// Registers all available codecs provided by this crate.
 pub fn game_register_all_codecs(rd: &mut RegisteredDecoders) {
     for decoder in GAME_CODECS.iter() {
         rd.add_decoder(decoder.clone());