Add doc comment

AkiyukiOkayasu · Aug 21, 2024 · 01299d7 · 01299d7
1 parent ca98b74
commit 01299d7
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/src/lib.rs b/src/lib.rs
@@ -103,6 +103,8 @@ pub struct PcmReader<'a> {
 }
 
 impl<'a> PcmReader<'a> {
+    /// Create a new PcmReader instance.
+    /// * 'input' - PCM data byte array
     pub fn new(input: &'a [u8]) -> Result<Self, LinearPcmError> {
         let file_length = input.len();
         let mut reader = PcmReader {