Mercurial > octave-nkf

comparison libinterp/dldfcn/audioread.cc @ 19539:ce02743b6f2a

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
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 99522db5b911
comparison
equal deleted inserted replaced
19538:d7b55fc1b37d 19539:ce02743b6f2a
29 #ifdef HAVE_SNDFILE 29 #ifdef HAVE_SNDFILE
30 #include <sndfile.h> 30 #include <sndfile.h>
31 #endif 31 #endif
32 32
33 DEFUN_DLD (audioread, args, , 33 DEFUN_DLD (audioread, args, ,
34 "-*- texinfo -*-\n\ 34 "-*- texinfo -*-\n\
35 @deftypefn{Loadable Function} [@var{y}, @var{Fs}] = audioread (@var{filename})\n\ 35 @deftypefn {Loadable Function} {[@var{y}, @var{fs}] =} audioread (@var{filename})\n\
36 \n\ 36 \n\
37 Load an audio file that is specified by @var{filename}. It will be loaded in to \ 37 Load an audio file that is specified by @var{filename}. It will be loaded\n\
38 a column matrix with as many rows as there are audio frames and as many columns \ 38 in to a column matrix with as many rows as there are audio frames and as many\n\
39 as there are channels in the file. Sampling rate will be stored in @var{Fs}. \ 39 columns as there are channels in the file. Sampling rate will be stored in\n\
40 @var{fs}.\n\
40 \n\ 41 \n\
41 @end deftypefn\n\ 42 @end deftypefn\n\
42 @deftypefn{Loadable Function} [@var{y}, @var{Fs}] = audioread (@var{filename}, @var{samples})\n\ 43 @deftypefn {Loadable Function} {[@var{y}, @var{fs}] =} audioread (@var{filename}, @var{samples})\n\
43 \n\ 44 \n\
44 Read a specified range of samples from a file specified by @var{filename}. \ 45 Read a specified range of samples from a file specified by @var{filename}.\n\
45 Argument @var{samples} is a vector with two values specifying starting frame \ 46 Argument @var{samples} is a vector with two values specifying starting frame\n\
46 and ending frame. \ 47 and ending frame.\n\
47 \n\ 48 \n\
48 @end deftypefn\n\ 49 @end deftypefn\n\
49 @deftypefn{Loadable Function} [@var{y}, @var{Fs}] = audioread (@var{filename}, @var{dataType})\n\ 50 @deftypefn {Loadable Function} {[@var{y}, @var{fs}] =} audioread (@var{filename}, @var{datatype})\n\
50 \n\ 51 \n\
51 Read a file and return an array of specified type. If @var{dataType} is \"native\" then \ 52 Read a file and return an array of specified type. If @var{datatype} is\n\
52 an array of fixed width integer type will be returned depending on how data is stored \ 53 @qcode{\"native\"} then an array of fixed width integer type will be returned\n\
53 in the audio file. If @var{dataType} is \"double\" a double matrix will be returned. \ 54 depending on how data is stored in the audio file. If @var{datatype} is\n\
55 @qcode{\"double\"} a double matrix will be returned.\n\
54 \n\ 56 \n\
55 @end deftypefn\n\ 57 @end deftypefn\n\
56 @deftypefn{Loadable Function} [@var{y}, @var{Fs}] = audioread (@var{filename}, @var{samples}, @var{dataType})\n\ 58 @deftypefn {Loadable Function} {[@var{y}, @var{fs}] =} audioread (@var{filename}, @var{samples}, @var{datatype})\n\
57 \n\ 59 \n\
58 Read a file and return a specified range of frames in an array of specified type. \ 60 Read a file and return a specified range of frames in an array of specified type.\n\
59 \n\ 61 \n\
60 @end deftypefn" 62 @end deftypefn"
61 ) 63 )
62 { 64 {
63 octave_value_list retval; 65 octave_value_list retval;