comparison libinterp/dldfcn/audiodevinfo.cc @ 30888:32d2b6604a9f

doc: Ensure documentation lists output argument when it exists for functions in libinterp/ For new users of Octave it is best to show explicit calling forms in the documentation and to show a return argument when it exists. * __ftp__.cc, __magick_read__.cc, __pchip_deriv__.cc, bitfcns.cc, bsxfun.cc, call-stack.cc, cellfun.cc, chol.cc, conv2.cc, data.cc, debug.cc, defaults.cc, det.cc, dirfns.cc, display.cc, dot.cc, error.cc, event-manager.cc, fft.cc, fft2.cc, fftn.cc, file-io.cc, getgrent.cc, getpwent.cc, getrusage.cc, graphics.cc, hash.cc, help.cc, input.cc, interpreter.cc, kron.cc, load-path.cc, mappers.cc, max.cc, nproc.cc, oct-hist.cc, pager.cc, pinv.cc, psi.cc, rand.cc, settings.cc, sighandlers.cc, stream-euler.cc, strfns.cc, symtab.cc, syscalls.cc, sysdep.cc, time.cc, toplev.cc, utils.cc, variables.cc, __fltk_uigetfile__.cc, audiodevinfo.cc, audioread.cc, fftw.cc, ov-bool-mat.cc, ov-cell.cc, ov-class.cc, ov-classdef.cc, ov-fcn-handle.cc, ov-java.cc, ov-struct.cc, ov-typeinfo.cc, ov-usr-fcn.cc, ov.cc, octave.cc, profiler.cc: Add return arguments to @deftypefn macros where they were missing. Attempt to use standard naming convention for return variables. Occasionally improved the docstring itself by re-wording or adding code examples.
author Rik <rik@octave.org>
date Mon, 04 Apr 2022 10:31:48 -0700
parents d31d4f2504de
children c9788d7f6e65
comparison
equal deleted inserted replaced
30887:4bab8d3fce79 30888:32d2b6604a9f
2160 return retval; 2160 return retval;
2161 } 2161 }
2162 2162
2163 DEFUN_DLD (__recorder_isrecording__, args, , 2163 DEFUN_DLD (__recorder_isrecording__, args, ,
2164 doc: /* -*- texinfo -*- 2164 doc: /* -*- texinfo -*-
2165 @deftypefn {} {} __recorder_isrecording__ (@var{recorder}) 2165 @deftypefn {} {@var{tf} =} __recorder_isrecording__ (@var{recorder})
2166 Undocumented internal function. 2166 Undocumented internal function.
2167 @end deftypefn */) 2167 @end deftypefn */)
2168 { 2168 {
2169 octave_value retval; 2169 octave_value retval;
2170 2170
2573 return retval; 2573 return retval;
2574 } 2574 }
2575 2575
2576 DEFUN_DLD (__player_isplaying__, args, , 2576 DEFUN_DLD (__player_isplaying__, args, ,
2577 doc: /* -*- texinfo -*- 2577 doc: /* -*- texinfo -*-
2578 @deftypefn {} {} __player_isplaying__ (@var{player}) 2578 @deftypefn {} {@var{tf} =} __player_isplaying__ (@var{player})
2579 Undocumented internal function. 2579 Undocumented internal function.
2580 @end deftypefn */) 2580 @end deftypefn */)
2581 { 2581 {
2582 octave_value retval; 2582 octave_value retval;
2583 2583