From dfe90fba4adc00688c973a07dd7502f2a6f43fb5 Mon Sep 17 00:00:00 2001 From: Jamie Hardt Date: Fri, 4 Dec 2020 22:11:25 -0800 Subject: [PATCH] Documentation --- src/wavereader.rs | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/src/wavereader.rs b/src/wavereader.rs index 7ee8366..6da8afd 100644 --- a/src/wavereader.rs +++ b/src/wavereader.rs @@ -165,6 +165,7 @@ impl WaveReader { /// Read iXML data. /// + /// The iXML data will be appended to `buffer`. /// If there are no iXML metadata present in the file, /// Ok(0) will be returned. pub fn read_ixml(&mut self, buffer: &mut Vec) -> Result { @@ -174,7 +175,8 @@ impl WaveReader { /// Read AXML data. /// - /// By convention this will generally be ADM metadata. + /// The axml data will be appended to `buffer`. By convention this will + /// generally be ADM metadata. /// /// If there are no axml metadata present in the file, /// Ok(0) will be returned