Mercurial > hg > octave-nkf

diff libinterp/dldfcn/audiodevinfo.cc @ 20373:075a5e2e1ba5 stable

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
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 7aaf756b1532
children a9574e3c6e9e
line wrap: on
line diff
--- a/libinterp/dldfcn/audiodevinfo.cc
+++ b/libinterp/dldfcn/audiodevinfo.cc
@@ -77,25 +77,28 @@
 \n\
 @deftypefnx {Loadable Function} {@var{supports} =} audiodevinfo (@var{io}, @var{id}, @var{rate}, @var{bits}, @var{chans})\n\
 \n\
-Return a structure with fields \"input\" and \"output\".\n\
-The value of each field is a structure array with fields\n\
-\"Name\", @nospell{\"DriverVersion\"} and \"ID\" describing an audio device.\n\
+Return a structure describing the available audio input and output devices.\n\
+\n\
+The @var{devinfo} structure has two fields @qcode{\"input\"} and\n\
+@qcode{\"output\"}.  The value of each field is a structure array with fields\n\
+@qcode{\"Name\"}, @nospell{\"DriverVersion\"} and @qcode{\"ID\"} describing\n\
+an audio device.\n\
 \n\
 If the optional argument @var{io} is 1, return information about input\n\
 devices only.  If it is 0, return information about output devices only.\n\
 \n\
 If the optional argument @var{id} is provided, return information about\n\
-corresponding device.\n\
+the corresponding device.\n\
 \n\
 If the optional argument @var{name} is provided, return the id of the\n\
 named device.\n\
 \n\
-Given a sampling rate, bits per sample, and number of channels for\n\
-an input or output device, return the ID of the first device that\n\
-supports playback or recording using the specified parameters.\n\
+Given a sampling rate, bits per sample, and number of channels for an input\n\
+or output device, return the ID of the first device that supports playback\n\
+or recording using the specified parameters.\n\
 \n\
-If also given a device ID, return true if the device supports playback\n\
-or recording using those parameters.\n\
+If also given a device ID, return true if the device supports playback or\n\
+recording using those parameters.\n\
 @end deftypefn")
 {
   octave_value retval;