diff libinterp/corefcn/chol.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 e88a07dec498
line wrap: on
line diff
--- a/libinterp/corefcn/chol.cc	Mon Apr 04 00:20:48 2022 -0400
+++ b/libinterp/corefcn/chol.cc	Mon Apr 04 10:31:48 2022 -0700
@@ -360,7 +360,7 @@
 
 DEFUN (cholinv, args, ,
        doc: /* -*- texinfo -*-
-@deftypefn {} {} cholinv (@var{A})
+@deftypefn {} {@var{Ainv} =} cholinv (@var{A})
 Compute the inverse of the symmetric positive definite matrix @var{A} using
 the Cholesky@tie{}factorization.
 @seealso{chol, chol2inv, inv}
@@ -484,13 +484,13 @@
 
 DEFUN (chol2inv, args, ,
        doc: /* -*- texinfo -*-
-@deftypefn {} {} chol2inv (@var{U})
+@deftypefn {} {@var{Ainv} =} chol2inv (@var{R})
 Invert a symmetric, positive definite square matrix from its Cholesky
-decomposition, @var{U}.
+decomposition, @var{R}.
 
-Note that @var{U} should be an upper-triangular matrix with positive
-diagonal elements.  @code{chol2inv (@var{U})} provides
-@code{inv (@var{U}'*@var{U})} but it is much faster than using @code{inv}.
+Note that @var{R} should be an upper-triangular matrix with positive diagonal
+elements.  @code{chol2inv (@var{U})} provides @code{inv (@var{R}'*@var{R})} but
+is much faster than using @code{inv}.
 @seealso{chol, cholinv, inv}
 @end deftypefn */)
 {