Mercurial > octave

comparison libinterp/corefcn/__ftp__.cc @ 30888:32d2b6604a9f

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
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 243b51ec9ff0
children 23520a50d74d
comparison
equal deleted inserted replaced
30887:4bab8d3fce79 30888:32d2b6604a9f
80 return ovl (uh.value ()); 80 return ovl (uh.value ());
81 } 81 }
82 82
83 DEFMETHOD (__ftp_pwd__, interp, args, , 83 DEFMETHOD (__ftp_pwd__, interp, args, ,
84 doc: /* -*- texinfo -*- 84 doc: /* -*- texinfo -*-
85 @deftypefn {} {} __ftp_pwd__ (@var{handle}) 85 @deftypefn {} {@var{pwd} =} __ftp_pwd__ (@var{handle})
86 Undocumented internal function 86 Undocumented internal function
87 @end deftypefn */) 87 @end deftypefn */)
88 { 88 {
89 url_handle_manager& uhm = interp.get_url_handle_manager (); 89 url_handle_manager& uhm = interp.get_url_handle_manager ();
90 90
120 return ovl (); 120 return ovl ();
121 } 121 }
122 122
123 DEFMETHOD (__ftp_dir__, interp, args, nargout, 123 DEFMETHOD (__ftp_dir__, interp, args, nargout,
124 doc: /* -*- texinfo -*- 124 doc: /* -*- texinfo -*-
125 @deftypefn {} {} __ftp_dir__ (@var{handle}) 125 @deftypefn {} {} __ftp_dir__ (@var{handle})
126 @deftypefnx {} {@var{S} =} __ftp_dir__ (@var{handle})
126 Undocumented internal function 127 Undocumented internal function
127 @end deftypefn */) 128 @end deftypefn */)
128 { 129 {
129 url_handle_manager& uhm = interp.get_url_handle_manager (); 130 url_handle_manager& uhm = interp.get_url_handle_manager ();
130 131
246 return ovl (); 247 return ovl ();
247 } 248 }
248 249
249 DEFMETHOD (__ftp_mode__, interp, args, , 250 DEFMETHOD (__ftp_mode__, interp, args, ,
250 doc: /* -*- texinfo -*- 251 doc: /* -*- texinfo -*-
251 @deftypefn {} {} __ftp_mode__ (@var{handle}) 252 @deftypefn {} {@var{mode} =} __ftp_mode__ (@var{handle})
252 Undocumented internal function 253 Undocumented internal function
253 @end deftypefn */) 254 @end deftypefn */)
254 { 255 {
255 url_handle_manager& uhm = interp.get_url_handle_manager (); 256 url_handle_manager& uhm = interp.get_url_handle_manager ();
256 257
343 return ovl (); 344 return ovl ();
344 } 345 }
345 346
346 DEFMETHOD (__ftp_mput__, interp, args, nargout, 347 DEFMETHOD (__ftp_mput__, interp, args, nargout,
347 doc: /* -*- texinfo -*- 348 doc: /* -*- texinfo -*-
348 @deftypefn {} {} __ftp_mput__ (@var{handle}, @var{files}) 349 @deftypefn {} {} __ftp_mput__ (@var{handle}, @var{files})
350 @deftypefnx {} {@var{filelist} =} __ftp_mput__ (@var{handle}, @var{files})
349 Undocumented internal function 351 Undocumented internal function
350 @end deftypefn */) 352 @end deftypefn */)
351 { 353 {
352 std::string pat = args(1).xstring_value ("__ftp_mput__: PATTERN must be a string"); 354 std::string pat = args(1).xstring_value ("__ftp_mput__: PATTERN must be a string");
353 355