Mercurial > octave-nkf
comparison scripts/audio/@audioplayer/playblocking.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 |
comparison
equal
deleted
inserted
replaced
19538:d7b55fc1b37d | 19539:ce02743b6f2a |
---|---|
15 ## You should have received a copy of the GNU General Public License | 15 ## You should have received a copy of the GNU General Public License |
16 ## along with Octave; see the file COPYING. If not, see | 16 ## along with Octave; see the file COPYING. If not, see |
17 ## <http://www.gnu.org/licenses/>. | 17 ## <http://www.gnu.org/licenses/>. |
18 | 18 |
19 ## -*- texinfo -*- | 19 ## -*- texinfo -*- |
20 ## @deftypefn{Function File} playblocking (@var{playerObj}) | 20 ## @deftypefn {Function File} {} playblocking (@var{player}) |
21 ## Play back audio stored in the audioplayer object with blocking. | 21 ## Play back audio stored in the audioplayer object with blocking. |
22 ## @end deftypefn | 22 ## @end deftypefn |
23 ## @deftypefn{Function File} playblocking (@var{playerObj}, @var{start}) | 23 ## @deftypefn {Function File} {} playblocking (@var{player}, @var{start}) |
24 ## Play back audio stored in the audioplayer object starting at the time in seconds specified by @var{start}. | 24 ## Play back audio stored in the audioplayer object starting at the time in |
25 ## seconds specified by @var{start}. | |
25 ## @end deftypefn | 26 ## @end deftypefn |
26 ## @deftypefn{Function File} playblocking (@var{playerObj}, [@var{start}, @var{end}]) | 27 ## @deftypefn {Function File} {} playblocking (@var{player}, [@var{start}, @var{end}]) |
27 ## Play back audio stored in the audioplayer object starting at the time in seconds specified by @var{start} and ending at the time specified by @var{end}. | 28 ## Play back audio stored in the audioplayer object starting at the time in |
29 ## seconds specified by @var{start} and ending at the time specified by | |
30 ## @var{end}. | |
28 ## @end deftypefn | 31 ## @end deftypefn |
29 | 32 |
30 function playblocking (varargin) | 33 function playblocking (varargin) |
31 if (nargin < 1 || nargin > 2) | 34 if (nargin < 1 || nargin > 2) |
32 print_usage (); | 35 print_usage (); |