Mercurial > octave
diff scripts/audio/@audiorecorder/play.m @ 19506:fdb8a62ef17a
fix docstring style in .m files
* @audioplayer/__get_properties__.m, @audioplayer/audioplayer.m,
@audioplayer/get.m, @audioplayer/isplaying.m, @audioplayer/pause.m,
@audioplayer/play.m, @audioplayer/playblocking.m,
@audioplayer/resume.m, @audioplayer/set.m, @audioplayer/stop.m,
@audiorecorder/audiorecorder.m,@audiorecorder/get.m,
@audiorecorder/getaudiodata.m, @audiorecorder/getplayer.m,
@audiorecorder/isrecording.m, @audiorecorder/pause.m,
@audiorecorder/play.m, @audiorecorder/record.m,
@audiorecorder/recordblocking.m, @audiorecorder/resume.m,
@audiorecorder/set.m, @audiorecorder/stop.m: Fix docstring style.
| author | John W. Eaton <jwe@octave.org> |
|---|---|
| date | Wed, 31 Dec 2014 13:45:45 -0500 |
| parents | ce02743b6f2a |
| children | dac3191a5301 |
line wrap: on
line diff
--- a/scripts/audio/@audiorecorder/play.m Thu Oct 03 09:50:01 2013 -0400 +++ b/scripts/audio/@audiorecorder/play.m Wed Dec 31 13:45:45 2014 -0500 @@ -18,17 +18,13 @@ ## -*- texinfo -*- ## @deftypefn {Function File} {@var{player} =} play (@var{recorder}) +## @deftypefnx {Function File} {@var{player} =} play (@var{recorder}, @var{start}) +## @deftypefnx {Function File} {@var{player} =} play (@var{recorder}, [@var{start}, @var{end}]) ## Play the audio recorded in @var{recorder} and return a corresponding -## audioplayer object. -## @end deftypefn -## @deftypefn {Function File} {@var{player} =} play (@var{recorder}, @var{start}) -## Play the audio recorded in @var{recorder} starting from @var{start} -## seconds in to the recording. Returns a corresponding audioplayer object. -## @end deftypefn -## @deftypefn {Function File} {@var{player} =} play (@var{recorder}, [@var{start}, @var{end}]) -## Play the audio recorded in @var{recorder} starting from @var{start} -## seconds and ending at @var{end} seconds in the recording. Returns a -## corresponding audioplayer object. +## audioplayer object. If the optional argument @var{start} is +## provided, begin playing @var{start} seconds in to the recording. +## If the optional argument @var{end} is provided, stop playing at +## @var{end} seconds in the recording. ## @end deftypefn function player = play (varargin)