# HG changeset patch # User Rik # Date 1640804720 28800 # Node ID 3eeaba530a036a88a622134c48244d31c2589296 # Parent 0ef88c48578674c3f19d4b352c578379b3dff759 doc: Add @seealso links to @ftp method functions. * ascii.m, binary.m, cd.m, close.m, delete.m, dir.m, ftp.m, mget.m, mkdir.m, mput.m, rename.m, rmdir.m: Add @seealso links to @ftp method functions. diff -r 0ef88c485786 -r 3eeaba530a03 scripts/@ftp/ascii.m --- a/scripts/@ftp/ascii.m Wed Dec 29 08:41:33 2021 -0800 +++ b/scripts/@ftp/ascii.m Wed Dec 29 11:05:20 2021 -0800 @@ -32,6 +32,7 @@ ## representation. ## ## @var{f} is an FTP object returned by the @code{ftp} function. +## @seealso{@ftp/binary, @ftp/ftp} ## @end deftypefn function ascii (f) diff -r 0ef88c485786 -r 3eeaba530a03 scripts/@ftp/binary.m --- a/scripts/@ftp/binary.m Wed Dec 29 08:41:33 2021 -0800 +++ b/scripts/@ftp/binary.m Wed Dec 29 11:05:20 2021 -0800 @@ -31,6 +31,7 @@ ## representation to the local representation. ## ## @var{f} is an FTP object returned by the @code{ftp} function. +## @seealso{@ftp/ascii, @ftp/ftp} ## @end deftypefn function binary (f) diff -r 0ef88c485786 -r 3eeaba530a03 scripts/@ftp/cd.m --- a/scripts/@ftp/cd.m Wed Dec 29 08:41:33 2021 -0800 +++ b/scripts/@ftp/cd.m Wed Dec 29 11:05:20 2021 -0800 @@ -37,6 +37,7 @@ ## ## If the directory does not exist, an error message is printed and the ## working directory is not changed. +## @seealso{@ftp/dir, @ftp/ftp} ## @end deftypefn function path = cd (f, path) diff -r 0ef88c485786 -r 3eeaba530a03 scripts/@ftp/close.m --- a/scripts/@ftp/close.m Wed Dec 29 08:41:33 2021 -0800 +++ b/scripts/@ftp/close.m Wed Dec 29 11:05:20 2021 -0800 @@ -28,6 +28,7 @@ ## Close the FTP connection represented by the FTP object @var{f}. ## ## @var{f} is an FTP object returned by the @code{ftp} function. +## @seealso{@ftp/ftp} ## @end deftypefn function close (f) diff -r 0ef88c485786 -r 3eeaba530a03 scripts/@ftp/delete.m --- a/scripts/@ftp/delete.m Wed Dec 29 08:41:33 2021 -0800 +++ b/scripts/@ftp/delete.m Wed Dec 29 11:05:20 2021 -0800 @@ -28,6 +28,7 @@ ## Delete the remote file @var{file} over the FTP connection @var{f}. ## ## @var{f} is an FTP object returned by the @code{ftp} function. +## @seealso{@ftp/rmdir, @ftp/rename, @ftp/ftp} ## @end deftypefn function delete (f, file) diff -r 0ef88c485786 -r 3eeaba530a03 scripts/@ftp/dir.m --- a/scripts/@ftp/dir.m Wed Dec 29 08:41:33 2021 -0800 +++ b/scripts/@ftp/dir.m Wed Dec 29 11:05:20 2021 -0800 @@ -33,6 +33,7 @@ ## If the optional output @var{lst} is requested return a struct array ## with one entry per file with the fields @code{name}, @code{date}, ## @code{bytes}, @code{isdir}, @code{datenum}. +## @seealso{@ftp/cd, @ftp/mkdir, @ftp/rmdir, @ftp/ftp} ## @end deftypefn function lst = dir (f) diff -r 0ef88c485786 -r 3eeaba530a03 scripts/@ftp/ftp.m --- a/scripts/@ftp/ftp.m Wed Dec 29 08:41:33 2021 -0800 +++ b/scripts/@ftp/ftp.m Wed Dec 29 11:05:20 2021 -0800 @@ -50,6 +50,8 @@ ## @item rmdir @tab Remove remote directory ## @end multitable ## +## @seealso{@ftp/ascii, @ftp/binary, @ftp/cd, @ftp/close, @ftp/delete, +## @ftp/dir, @ftp/mget, @ftp/mkdir, @ftp/mput, @ftp/rename, @ftp/rmdir} ## @end deftypefn function obj = ftp (host = "", username = "anonymous", password = "") diff -r 0ef88c485786 -r 3eeaba530a03 scripts/@ftp/mget.m --- a/scripts/@ftp/mget.m Wed Dec 29 08:41:33 2021 -0800 +++ b/scripts/@ftp/mget.m Wed Dec 29 11:05:20 2021 -0800 @@ -38,6 +38,7 @@ ## If a third string argument @var{target} is given, then it must indicate ## the path to the local destination directory. @var{target} may be a ## relative or absolute path. +## @seealso{@ftp/mput, @ftp/ftp} ## @end deftypefn function mget (f, file, target = "") diff -r 0ef88c485786 -r 3eeaba530a03 scripts/@ftp/mkdir.m --- a/scripts/@ftp/mkdir.m Wed Dec 29 08:41:33 2021 -0800 +++ b/scripts/@ftp/mkdir.m Wed Dec 29 11:05:20 2021 -0800 @@ -28,6 +28,7 @@ ## Create the remote directory @var{path}, over the FTP connection @var{f}. ## ## @var{f} is an FTP object returned by the @code{ftp} function. +## @seealso{@ftp/rmdir, @ftp/ftp} ## @end deftypefn function mkdir (f, path) diff -r 0ef88c485786 -r 3eeaba530a03 scripts/@ftp/mput.m --- a/scripts/@ftp/mput.m Wed Dec 29 08:41:33 2021 -0800 +++ b/scripts/@ftp/mput.m Wed Dec 29 11:05:20 2021 -0800 @@ -36,6 +36,7 @@ ## ## The optional output argument @var{file_list} contains a cell array of ## strings with the names of the uploaded files. +## @seealso{@ftp/mget, @ftp/mkdir, @ftp/ftp} ## @end deftypefn function retval = mput (f, file) diff -r 0ef88c485786 -r 3eeaba530a03 scripts/@ftp/rename.m --- a/scripts/@ftp/rename.m Wed Dec 29 08:41:33 2021 -0800 +++ b/scripts/@ftp/rename.m Wed Dec 29 11:05:20 2021 -0800 @@ -29,6 +29,7 @@ ## over the FTP connection @var{f}. ## ## @var{f} is an FTP object returned by the @code{ftp} function. +## @seealso{@ftp/delete, @ftp/rmdir, @ftp/ftp} ## @end deftypefn function rename (f, oldname, newname) diff -r 0ef88c485786 -r 3eeaba530a03 scripts/@ftp/rmdir.m --- a/scripts/@ftp/rmdir.m Wed Dec 29 08:41:33 2021 -0800 +++ b/scripts/@ftp/rmdir.m Wed Dec 29 11:05:20 2021 -0800 @@ -28,6 +28,7 @@ ## Remove the remote directory @var{path}, over the FTP connection @var{f}. ## ## @var{f} is an FTP object returned by the @code{ftp} function. +## @seealso{@ftp/delete, @ftp/mkdir, @ftp/rename, @ftp/ftp} ## @end deftypefn function rmdir (f, path)