Document errors and warnings in help text.

marcecj · Oct 30, 2012 · 9babfba · 9babfba
1 parent 7b06f0d
commit 9babfba
Show file tree

Hide file tree

Showing 2 changed files with 55 additions and 0 deletions.
diff --git a/src/+msndfile/blockread.m b/src/+msndfile/blockread.m
@@ -134,6 +134,31 @@
 %           LITTLE       Force little endian-ness.
 %           BIG          Force big endian-ness.
 %           CPU          Force CPU endian-ness.
+%
+% Errors and warnings
+% -------------------
+%
+% Under certain conditions, MSNDFILE.BLOCKREAD() will raise a warning or error.
+%
+% The errors specific to MSNDFILE.BLOCKREAD() are:
+%
+% - msndfile:blockread:filenotopen
+%
+%   An operation on an unopened file was attempted.  Open the file first.
+%
+% - msndfile:blockread:fileopen
+%
+%   An attempt was made to open an already opened file.
+%
+% Generic errors used throughout msndfile:
+%
+% - msndfile:argerror   Too few or incorrect arguments were passed.
+% - msndfile:sndfile    A call to libsndfile failed fatally.
+% - msndfile:system     A system error (e.g., a failed memory allocation).
+%
+% Generic warnings used throughout msndfile:
+%
+% - msndfile:sndfile    A call to libsndfile failed non-fatally.
 
 % (c) Marc Joliet <marcec@gmx.de>
 %

diff --git a/src/+msndfile/read.m b/src/+msndfile/read.m
@@ -131,6 +131,36 @@
 %           LITTLE       Force little endian-ness.
 %           BIG          Force big endian-ness.
 %           CPU          Force CPU endian-ness.
+%
+% Errors and warnings
+% -------------------
+%
+% Under certain conditions, MSNDFILE.READ() will raise a warning or error.
+%
+% The errors specific to MSNDFILE.READ() are:
+%
+% - msndfile:read:ambiguousname
+%
+%   The file name (sans suffix) is ambiguous and no WAV file was found among the
+%   files found.  You should pass the full file name.
+%
+% The warnings specific to MSNDFILE.READ() are:
+%
+% - msndfile:read:ambiguousname
+%
+%   The file name (sans suffix) is ambiguous, but there was a WAV file among the
+%   files found.
+%
+% Generic errors used throughout msndfile:
+%
+% - msndfile:argerror   Too few or incorrect arguments were passed.
+% - msndfile:sndfile    A call to libsndfile failed fatally.
+% - msndfile:system     A system error (e.g., a failed memory allocation).
+%
+% Generic warnings used throughout msndfile:
+%
+% - msndfile:sndfile    A call to libsndfile failed non-fatally.
+
 
 % (c) Marc Joliet <marcec@gmx.de>
 %