diff scripts/audio/@audiorecorder/getaudiodata.m @ 19539:ce02743b6f2a

Fix texinfo docstring syntax for all audio functions * libinterp/dldfcn/audiodevinfo.cc, libinterp/dldfcn/audioinfo.cc, libinterp/dldfcn/audioread.cc, libinterp/dldfcn/audiowrite.cc, scripts/audio/@audioplayer/__get_properties__.m, scripts/audio/@audioplayer/audioplayer.m, scripts/audio/@audioplayer/display.m, scripts/audio/@audioplayer/get.m, scripts/audio/@audioplayer/isplaying.m, scripts/audio/@audioplayer/pause.m, scripts/audio/@audioplayer/play.m, scripts/audio/@audioplayer/playblocking.m, scripts/audio/@audioplayer/resume.m, scripts/audio/@audioplayer/set.m, scripts/audio/@audioplayer/stop.m, scripts/audio/@audiorecorder/audiorecorder.m, scripts/audio/@audiorecorder/display.m, scripts/audio/@audiorecorder/get.m, scripts/audio/@audiorecorder/getaudiodata.m, scripts/audio/@audiorecorder/getplayer.m, scripts/audio/@audiorecorder/isrecording.m, scripts/audio/@audiorecorder/pause.m, scripts/audio/@audiorecorder/play.m, scripts/audio/@audiorecorder/record.m, scripts/audio/@audiorecorder/recordblocking.m, scripts/audio/@audiorecorder/resume.m, scripts/audio/@audiorecorder/set.m, scripts/audio/@audiorecorder/stop.m: Fix texinfo docstring formatting, wrap long lines, and use consistent lowercase variable names.
author Mike Miller <mtmiller@ieee.org>
date Thu, 03 Oct 2013 09:50:01 -0400
parents 36a26a131209
children fdb8a62ef17a
line wrap: on
line diff
--- a/scripts/audio/@audiorecorder/getaudiodata.m	Thu Oct 03 08:33:46 2013 -0400
+++ b/scripts/audio/@audiorecorder/getaudiodata.m	Thu Oct 03 09:50:01 2013 -0400
@@ -17,12 +17,14 @@
 ## <http://www.gnu.org/licenses/>.
 
 ## -*- texinfo -*-
-## @deftypefn{Function File} getaudiodata (@var{recorderObj})
-## Returns recorder audio data as a Matrix with values between -1.0 and 1.0 and with as many columns as there are channels in the recorder.
+## @deftypefn {Function File} {@var{data} =} getaudiodata (@var{recorder})
+## Returns recorder audio data as a matrix with values between -1.0 and 1.0
+## and with as many columns as there are channels in the recorder.
 ## @end deftypefn
-## @deftypefn{Function File} getaudiodata (@var{recorderObj}, @var{dataType})
-## Converts recorded data to specified @var{dataType}. It can be set to 'double',
-## 'single', 'int16', 'int8' or 'uint8'.
+## @deftypefn {Function File} {@var{data} =} getaudiodata (@var{recorder}, @var{datatype})
+## Converts recorded data to specified @var{datatype}.  It can be set to
+## @qcode{"double"}, @qcode{"single"}, @qcode{"int16"}, @qcode{"int8"} or
+## @qcode{"uint8"}.
 ## @end deftypefn
 
 function data = getaudiodata (varargin)