Mercurial > octave-nkf
diff scripts/audio/@audioplayer/play.m @ 19540: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 | 5802ea7037d4 |
line wrap: on
line diff
--- a/scripts/audio/@audioplayer/play.m Thu Oct 03 09:50:01 2013 -0400 +++ b/scripts/audio/@audioplayer/play.m Wed Dec 31 13:45:45 2014 -0500 @@ -18,16 +18,13 @@ ## -*- texinfo -*- ## @deftypefn {Function File} {} play (@var{player}) -## Play back audio stored in an audioplayer object without blocking. -## @end deftypefn -## @deftypefn {Function File} {} play (@var{player}, @var{start}) -## Play back audio stored in an audioplayer object starting at the time in -## seconds specified by @var{start}. -## @end deftypefn -## @deftypefn {Function File} {} play (@var{player}, [@var{start}, @var{end}]) -## Play back audio stored in an audioplayer object starting at the time in -## seconds specified by @var{start} and ending at the time specified by -## @var{end}. +## @deftypefnx {Function File} {} play (@var{player}, @var{start}) +## @deftypefnx {Function File} {} play (@var{player}, @var{limits}) +## Play audio stored in the audioplayer object @var{player} without blocking. +## Given optional argument start, begin playing at @var{start} seconds +## in the recording. Given a two-element vector @var{limits}, begin and +## end playing at the number of seconds specified by the elements of the +## vector. ## @end deftypefn function play (varargin)