Mercurial > octave-antonio
diff 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 |
line wrap: on
line diff
--- a/libinterp/dldfcn/audioread.cc Sun May 03 17:00:11 2015 -0700 +++ b/libinterp/dldfcn/audioread.cc Sun May 03 21:52:42 2015 -0700 @@ -56,20 +56,18 @@ \n\ @deftypefnx {Loadable Function} {[@var{y}, @var{fs}] =} audioread (@var{filename}, @var{datatype})\n\ @deftypefnx {Loadable Function} {[@var{y}, @var{fs}] =} audioread (@var{filename}, @var{samples}, @var{datatype})\n\ -Read the audio file @var{filename} and return the audio data and sampling\n\ -rate. The audio data is stored as matrix with rows corresponding\n\ -to audio frames and columns corresponding to channels.\n\ +Read the audio file @var{filename} and return the audio data @var{y} and\n\ +sampling rate @var{fs}.\n\ +\n\ +The audio data is stored as matrix with rows corresponding to audio frames\n\ +and columns corresponding to channels.\n\ \n\ The optional two-element vector argument @var{samples} specifies starting\n\ and ending frames.\n\ \n\ The optional argument @var{datatype} specifies the datatype to return.\n\ -If it is @qcode{\"native\"}, then the type of data depends on how the\n\ -data is stored in the audio file.\n\ -\n\ -Read a file and return a specified range of frames in an array of specified\n\ -type.\n\ -\n\ +If it is @qcode{\"native\"}, then the type of data depends on how the data\n\ +is stored in the audio file.\n\ @end deftypefn") { octave_value_list retval; @@ -258,10 +256,10 @@ @deftypefn {Loadable Function} {} audiowrite (@var{filename}, @var{y}, @var{fs})\n\ @deftypefnx {Loadable Function} {} audiowrite (@var{filename}, @var{y}, @var{fs}, @var{name}, @var{value}, @dots{})\n\ \n\ -Write audio data from the matrix @var{y} to @var{filename} with the file\n\ -format determined by the file extension.\n\ +Write audio data from the matrix @var{y} to @var{filename} at sampling rate\n\ +@var{fs} with the file format determined by the file extension.\n\ \n\ -Additional name and value argument pairs may be used to specify the\n\ +Additional name/value argument pairs may be used to specify the\n\ following options:\n\ \n\ @table @samp\n\