Mercurial > octave-libtiff
comparison libinterp/dldfcn/audioread.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 | 83f9f8bda883 |
| children |
comparison
equal
deleted
inserted
replaced
| 30887:4bab8d3fce79 | 30888:32d2b6604a9f |
|---|---|
| 463 | 463 |
| 464 total_items_written += items_written; | 464 total_items_written += items_written; |
| 465 offset += chunk_size; | 465 offset += chunk_size; |
| 466 } | 466 } |
| 467 | 467 |
| 468 // FIXME: shouldn't we return something to indicate whether the file | 468 // FIXME: Shouldn't we return something to indicate whether the file |
| 469 // was written successfully? | 469 // was written successfully? On the other hand, Matlab doesn't |
| 470 // return anything. | |
| 470 return ovl (); | 471 return ovl (); |
| 471 | 472 |
| 472 #else | 473 #else |
| 473 | 474 |
| 474 octave_unused_parameter (args); | 475 octave_unused_parameter (args); |
| 778 | 779 |
| 779 audio_sub_formats (info.format); | 780 audio_sub_formats (info.format); |
| 780 } | 781 } |
| 781 } | 782 } |
| 782 | 783 |
| 784 return octave_value_list (); | |
| 785 | |
| 783 #else | 786 #else |
| 784 | 787 |
| 785 octave_unused_parameter (args); | 788 octave_unused_parameter (args); |
| 786 | 789 |
| 787 err_disabled_feature ("audioformats", | 790 err_disabled_feature ("audioformats", |
| 788 "getting sound formats through libsndfile"); | 791 "getting sound formats through libsndfile"); |
| 789 | 792 |
| 790 #endif | 793 #endif |
| 791 | |
| 792 return octave_value_list (); | |
| 793 } | 794 } |
| 794 | 795 |
| 795 OCTAVE_NAMESPACE_END | 796 OCTAVE_NAMESPACE_END |