Mercurial > octave-antonio
comparison libinterp/dldfcn/audioread.cc @ 20163:075a5e2e1ba5 stable
doc: Update more docstrings to have one sentence summary as first line.
Reviewed build-aux, libinterp/dldfcn, libinterp/octave-value,
libinterp/parse-tree directories.
* build-aux/mk-opts.pl, libinterp/dldfcn/__magick_read__.cc,
libinterp/dldfcn/amd.cc, libinterp/dldfcn/audiodevinfo.cc,
libinterp/dldfcn/audioread.cc, libinterp/dldfcn/ccolamd.cc,
libinterp/dldfcn/chol.cc, libinterp/dldfcn/colamd.cc,
libinterp/dldfcn/convhulln.cc, libinterp/dldfcn/dmperm.cc,
libinterp/dldfcn/fftw.cc, libinterp/dldfcn/qr.cc, libinterp/dldfcn/symbfact.cc,
libinterp/dldfcn/symrcm.cc, libinterp/octave-value/ov-base.cc,
libinterp/octave-value/ov-bool-mat.cc, libinterp/octave-value/ov-cell.cc,
libinterp/octave-value/ov-class.cc, libinterp/octave-value/ov-fcn-handle.cc,
libinterp/octave-value/ov-fcn-inline.cc, libinterp/octave-value/ov-java.cc,
libinterp/octave-value/ov-null-mat.cc, libinterp/octave-value/ov-oncleanup.cc,
libinterp/octave-value/ov-range.cc, libinterp/octave-value/ov-struct.cc,
libinterp/octave-value/ov-typeinfo.cc, libinterp/octave-value/ov-usr-fcn.cc,
libinterp/octave-value/ov.cc, libinterp/parse-tree/lex.ll,
libinterp/parse-tree/oct-parse.in.yy, libinterp/parse-tree/pt-binop.cc,
libinterp/parse-tree/pt-eval.cc, libinterp/parse-tree/pt-mat.cc:
doc: Update more docstrings to have one sentence summary as first line.
| author | Rik <rik@octave.org> |
|---|---|
| date | Sun, 03 May 2015 21:52:42 -0700 |
| parents | d575cd1e0da7 |
| children |
comparison
equal
deleted
inserted
replaced
| 20162:2645f9ef8c88 | 20163:075a5e2e1ba5 |
|---|---|
| 54 @deftypefn {Loadable Function} {[@var{y}, @var{fs}] =} audioread (@var{filename})\n\ | 54 @deftypefn {Loadable Function} {[@var{y}, @var{fs}] =} audioread (@var{filename})\n\ |
| 55 @deftypefnx {Loadable Function} {[@var{y}, @var{fs}] =} audioread (@var{filename}, @var{samples})\n\ | 55 @deftypefnx {Loadable Function} {[@var{y}, @var{fs}] =} audioread (@var{filename}, @var{samples})\n\ |
| 56 \n\ | 56 \n\ |
| 57 @deftypefnx {Loadable Function} {[@var{y}, @var{fs}] =} audioread (@var{filename}, @var{datatype})\n\ | 57 @deftypefnx {Loadable Function} {[@var{y}, @var{fs}] =} audioread (@var{filename}, @var{datatype})\n\ |
| 58 @deftypefnx {Loadable Function} {[@var{y}, @var{fs}] =} audioread (@var{filename}, @var{samples}, @var{datatype})\n\ | 58 @deftypefnx {Loadable Function} {[@var{y}, @var{fs}] =} audioread (@var{filename}, @var{samples}, @var{datatype})\n\ |
| 59 Read the audio file @var{filename} and return the audio data and sampling\n\ | 59 Read the audio file @var{filename} and return the audio data @var{y} and\n\ |
| 60 rate. The audio data is stored as matrix with rows corresponding\n\ | 60 sampling rate @var{fs}.\n\ |
| 61 to audio frames and columns corresponding to channels.\n\ | 61 \n\ |
| 62 The audio data is stored as matrix with rows corresponding to audio frames\n\ | |
| 63 and columns corresponding to channels.\n\ | |
| 62 \n\ | 64 \n\ |
| 63 The optional two-element vector argument @var{samples} specifies starting\n\ | 65 The optional two-element vector argument @var{samples} specifies starting\n\ |
| 64 and ending frames.\n\ | 66 and ending frames.\n\ |
| 65 \n\ | 67 \n\ |
| 66 The optional argument @var{datatype} specifies the datatype to return.\n\ | 68 The optional argument @var{datatype} specifies the datatype to return.\n\ |
| 67 If it is @qcode{\"native\"}, then the type of data depends on how the\n\ | 69 If it is @qcode{\"native\"}, then the type of data depends on how the data\n\ |
| 68 data is stored in the audio file.\n\ | 70 is stored in the audio file.\n\ |
| 69 \n\ | |
| 70 Read a file and return a specified range of frames in an array of specified\n\ | |
| 71 type.\n\ | |
| 72 \n\ | |
| 73 @end deftypefn") | 71 @end deftypefn") |
| 74 { | 72 { |
| 75 octave_value_list retval; | 73 octave_value_list retval; |
| 76 | 74 |
| 77 #ifdef HAVE_SNDFILE | 75 #ifdef HAVE_SNDFILE |
| 256 DEFUN_DLD (audiowrite, args, , | 254 DEFUN_DLD (audiowrite, args, , |
| 257 "-*- texinfo -*-\n\ | 255 "-*- texinfo -*-\n\ |
| 258 @deftypefn {Loadable Function} {} audiowrite (@var{filename}, @var{y}, @var{fs})\n\ | 256 @deftypefn {Loadable Function} {} audiowrite (@var{filename}, @var{y}, @var{fs})\n\ |
| 259 @deftypefnx {Loadable Function} {} audiowrite (@var{filename}, @var{y}, @var{fs}, @var{name}, @var{value}, @dots{})\n\ | 257 @deftypefnx {Loadable Function} {} audiowrite (@var{filename}, @var{y}, @var{fs}, @var{name}, @var{value}, @dots{})\n\ |
| 260 \n\ | 258 \n\ |
| 261 Write audio data from the matrix @var{y} to @var{filename} with the file\n\ | 259 Write audio data from the matrix @var{y} to @var{filename} at sampling rate\n\ |
| 262 format determined by the file extension.\n\ | 260 @var{fs} with the file format determined by the file extension.\n\ |
| 263 \n\ | 261 \n\ |
| 264 Additional name and value argument pairs may be used to specify the\n\ | 262 Additional name/value argument pairs may be used to specify the\n\ |
| 265 following options:\n\ | 263 following options:\n\ |
| 266 \n\ | 264 \n\ |
| 267 @table @samp\n\ | 265 @table @samp\n\ |
| 268 @item BitsPerSample\n\ | 266 @item BitsPerSample\n\ |
| 269 Number of bits per sample, valid values are 8, 16, 24 and 32. Default is 16.\n\ | 267 Number of bits per sample, valid values are 8, 16, 24 and 32. Default is 16.\n\ |