Mercurial > octave-antonio

comparison libinterp/dldfcn/audiodevinfo.cc @ 20163: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
comparison
equal deleted inserted replaced
20162:2645f9ef8c88 20163:075a5e2e1ba5
75 @deftypefnx {Loadable Function} {@var{id} =} audiodevinfo (@var{io}, @var{name})\n\ 75 @deftypefnx {Loadable Function} {@var{id} =} audiodevinfo (@var{io}, @var{name})\n\
76 @deftypefnx {Loadable Function} {@var{id} =} audiodevinfo (@var{io}, @var{rate}, @var{bits}, @var{chans})\n\ 76 @deftypefnx {Loadable Function} {@var{id} =} audiodevinfo (@var{io}, @var{rate}, @var{bits}, @var{chans})\n\
77 \n\ 77 \n\
78 @deftypefnx {Loadable Function} {@var{supports} =} audiodevinfo (@var{io}, @var{id}, @var{rate}, @var{bits}, @var{chans})\n\ 78 @deftypefnx {Loadable Function} {@var{supports} =} audiodevinfo (@var{io}, @var{id}, @var{rate}, @var{bits}, @var{chans})\n\
79 \n\ 79 \n\
80 Return a structure with fields \"input\" and \"output\".\n\ 80 Return a structure describing the available audio input and output devices.\n\
81 The value of each field is a structure array with fields\n\ 81 \n\
82 \"Name\", @nospell{\"DriverVersion\"} and \"ID\" describing an audio device.\n\ 82 The @var{devinfo} structure has two fields @qcode{\"input\"} and\n\
83 @qcode{\"output\"}. The value of each field is a structure array with fields\n\
84 @qcode{\"Name\"}, @nospell{\"DriverVersion\"} and @qcode{\"ID\"} describing\n\
85 an audio device.\n\
83 \n\ 86 \n\
84 If the optional argument @var{io} is 1, return information about input\n\ 87 If the optional argument @var{io} is 1, return information about input\n\
85 devices only. If it is 0, return information about output devices only.\n\ 88 devices only. If it is 0, return information about output devices only.\n\
86 \n\ 89 \n\
87 If the optional argument @var{id} is provided, return information about\n\ 90 If the optional argument @var{id} is provided, return information about\n\
88 corresponding device.\n\ 91 the corresponding device.\n\
89 \n\ 92 \n\
90 If the optional argument @var{name} is provided, return the id of the\n\ 93 If the optional argument @var{name} is provided, return the id of the\n\
91 named device.\n\ 94 named device.\n\
92 \n\ 95 \n\
93 Given a sampling rate, bits per sample, and number of channels for\n\ 96 Given a sampling rate, bits per sample, and number of channels for an input\n\
94 an input or output device, return the ID of the first device that\n\ 97 or output device, return the ID of the first device that supports playback\n\
95 supports playback or recording using the specified parameters.\n\ 98 or recording using the specified parameters.\n\
96 \n\ 99 \n\
97 If also given a device ID, return true if the device supports playback\n\ 100 If also given a device ID, return true if the device supports playback or\n\
98 or recording using those parameters.\n\ 101 recording using those parameters.\n\
99 @end deftypefn") 102 @end deftypefn")
100 { 103 {
101 octave_value retval; 104 octave_value retval;
102 105
103 #ifdef HAVE_PORTAUDIO 106 #ifdef HAVE_PORTAUDIO