Mercurial > octave
changeset 30567:3eeaba530a03
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.
| author | Rik <rik@octave.org> |
|---|---|
| date | Wed, 29 Dec 2021 11:05:20 -0800 |
| parents | 0ef88c485786 |
| children | 82b685157e2b |
| files | scripts/@ftp/ascii.m scripts/@ftp/binary.m scripts/@ftp/cd.m scripts/@ftp/close.m scripts/@ftp/delete.m scripts/@ftp/dir.m scripts/@ftp/ftp.m scripts/@ftp/mget.m scripts/@ftp/mkdir.m scripts/@ftp/mput.m scripts/@ftp/rename.m scripts/@ftp/rmdir.m |
| diffstat | 12 files changed, 13 insertions(+), 0 deletions(-) [+] |
line wrap: on
line diff
--- 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)
--- 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)
--- 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)
--- 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)
--- 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)
--- 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)
--- 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 = "")
--- 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 = "")
--- 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)
--- 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)
--- 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)
--- 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)