]> git.nihav.org Git - nihav.git/commitdiff
nihav_codec_support: fix documentation
authorKostya Shishkov <kostya.shishkov@gmail.com>
Mon, 16 Nov 2026 19:34:56 +0000 (20:34 +0100)
committerKostya Shishkov <kostya.shishkov@gmail.com>
Mon, 16 Nov 2026 19:34:56 +0000 (20:34 +0100)
nihav-codec-support/src/codecs/mod.rs
nihav-codec-support/src/dsp/qmf.rs

index 3f98be4b6988abbda5e3feab3aea9fbada065a0f..00aaf377257edc4e4d9d159c616bfeafe425aa7f 100644 (file)
@@ -125,6 +125,7 @@ impl IPShuffler {
 ///         },
 ///         // handle the rest of cases
 ///     };
+/// }
 /// if is_random_access_frame {
 ///     shuffler.clear(); // remove all saved references
 /// }
index 90cedc4c2c836266727f724f853f8f5e7b2eeac5..2d110026f7f621ad6f798659d0a41b27a8e7909d 100644 (file)
@@ -1,6 +1,6 @@
 //! Quadrature Mirror Filter used in various audio codecs like MPEG Audio.
 
-///! 32-band QMF.
+/// 32-band QMF.
 pub struct QMF {
     hist:       [f32; 1024],
     pos:        usize,
@@ -180,14 +180,14 @@ fn dct32(src: &[f32; 32], dst: &mut [f32]) {
 }
 
 impl QMF {
-    ///! Constructs a new `QMF` context.
+    /// Constructs a new `QMF` context.
     pub fn new() -> Self {
         Self {
             hist:   [0.0; 1024],
             pos:    0,
         }
     }
-    ///! Performs reconstruction of audio from provided sub-band samples.
+    /// Performs reconstruction of audio from provided sub-band samples.
     pub fn synth(&mut self, src: &[f32; 32], dst: &mut [f32]) {
         self.pos = self.pos.wrapping_sub(32) & 0x1FF;
         dct32(src, &mut self.hist[self.pos..][..32]);
@@ -214,7 +214,7 @@ impl QMF {
             dst[i] = acc;
         }
     }
-    ///! Resets internal filter state.
+    /// Resets internal filter state.
     pub fn reset(&mut self) {
         self.hist = [0.0; 1024];
         self.pos  = 0;