From 01299d7d1a05515fb6f73d3583f4328c180e87b7 Mon Sep 17 00:00:00 2001
From: AkiyukiOkayasu <akiyuki.okayasu@gmail.com>
Date: Wed, 21 Aug 2024 21:58:19 +0900
Subject: [PATCH] Add doc comment

---
 src/lib.rs | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/src/lib.rs b/src/lib.rs
index d4b7b53..f772621 100644
--- 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 {