Mercurial > jwe > octave
changeset 27811:06af06188403
doc: Add missing DOCSTRINGs to Octave manual.
* octave.texi: Rename documentation node "URL Manipulation" to "WWW Access".
* system.txi: Rename documentation node "URL Manipulation" to "WWW Access".
Add paragraph describing the web-related functions available. Add DOCSTRING
anchors for "web", "webread", "webwrite", "weboptions".
* web.m, weboptions.m, webread.m, webwrite.m: Remove references to "websave"
function which does not exist.
| author | Rik <rik@octave.org> |
|---|---|
| date | Thu, 12 Dec 2019 09:23:53 -0800 |
| parents | dccc551aa83b |
| children | 1626e50fa8ee |
| files | doc/interpreter/octave.texi doc/interpreter/system.txi scripts/web/web.m scripts/web/weboptions.m scripts/web/webread.m scripts/web/webwrite.m |
| diffstat | 6 files changed, 27 insertions(+), 12 deletions(-) [+] |
line wrap: on
line diff
--- a/doc/interpreter/octave.texi Thu Dec 12 06:45:57 2019 +0100 +++ b/doc/interpreter/octave.texi Thu Dec 12 09:23:53 2019 -0800 @@ -829,7 +829,7 @@ Networking Utilities * FTP Objects:: -* URL Manipulation:: +* WWW Access:: * Base64 and Binary Data Transmission:: Packages
--- a/doc/interpreter/system.txi Thu Dec 12 06:45:57 2019 +0100 +++ b/doc/interpreter/system.txi Thu Dec 12 09:23:53 2019 -0800 @@ -254,7 +254,7 @@ @menu * FTP Objects:: -* URL Manipulation:: +* WWW Access:: * Base64 and Binary Data Transmission:: @end menu @@ -291,13 +291,28 @@ @DOCSTRING(@ftp/rmdir) -@node URL Manipulation -@subsection URL Manipulation +@node WWW Access +@subsection WWW Access + +Octave can communicate with websites across the Internet. The @code{web} +function will launch an external web browser to interactively view a site. The +remaining functions---@code{urlread}, @code{urlwrite}, @code{webread}, +@code{webwrite}---are internal Octave functions which can import or export +data to/from Octave and a website identified by a URL (Uniform Resource +Locator). + +@DOCSTRING(web) @DOCSTRING(urlread) @DOCSTRING(urlwrite) +@DOCSTRING(webread) + +@DOCSTRING(webwrite) + +@DOCSTRING(weboptions) + @node Base64 and Binary Data Transmission @subsection Base64 and Binary Data Transmission
--- a/scripts/web/web.m Thu Dec 12 06:45:57 2019 +0100 +++ b/scripts/web/web.m Thu Dec 12 09:23:53 2019 -0800 @@ -63,7 +63,7 @@ ## The return values @var{handle} and @var{url} are currently unimplemented ## but given for compatibility. ## -## @seealso{weboptions, webread, webwrite, websave, urlread, urlwrite} +## @seealso{weboptions, webread, webwrite, urlread, urlwrite} ## @end deftypefn function [status, h, url] = web (url, varargin)
--- a/scripts/web/weboptions.m Thu Dec 12 06:45:57 2019 +0100 +++ b/scripts/web/weboptions.m Thu Dec 12 09:23:53 2019 -0800 @@ -24,8 +24,8 @@ ## ## @code{weboptions} with no inputs returns a default @code{weboptions} object ## to specify parameters for a request to a web service. A @code{weboptions} -## object can be an optional input argument to the @code{webread}, -## @code{websave}, and ## @code{webwrite} functions. +## object can be an optional input argument to the @code{webread} and +## @code{webwrite} functions. ## ## Multiple name and value pair arguments may be specified in any order as ## @var{name1}, @var{value1}, @var{name2}, @var{value2}, etc. @@ -117,8 +117,8 @@ ## The following methods are available: ## @samp{get}, @samp{put}, @samp{post}, @samp{delete}, @samp{patch} ## -## @code{webread} and @code{websave} use the HTTP GET method. @code{webwrite} -## uses the HTTP POST method as default. +## @code{webread} uses the HTTP GET method. @code{webwrite} uses the HTTP POST +## method as default. ## ## @item ## @samp{ArrayFormat} -- Not yet implemented. Only for @sc{matlab} @@ -129,7 +129,7 @@ ## compatibility. ## @end itemize ## -## @seealso{webwrite, webread, websave} +## @seealso{webread, webwrite} ## @end deftypefn classdef weboptions < handle
--- a/scripts/web/webread.m Thu Dec 12 06:45:57 2019 +0100 +++ b/scripts/web/webread.m Thu Dec 12 09:23:53 2019 -0800 @@ -35,7 +35,7 @@ ## HTTP request options. This argument can be used with either calling form. ## See @code{help weboptions} for a complete list of supported HTTP options. ## -## @seealso{weboptions, webwrite, websave} +## @seealso{weboptions, webwrite} ## @end deftypefn function response = webread (url, varargin)
--- a/scripts/web/webwrite.m Thu Dec 12 06:45:57 2019 +0100 +++ b/scripts/web/webwrite.m Thu Dec 12 09:23:53 2019 -0800 @@ -34,7 +34,7 @@ ## HTTP request options. This argument can be used with either calling form. ## See @code{help weboptions} for a complete list of supported HTTP options. ## -## @seealso{weboptions, webread, websave} +## @seealso{weboptions, webread} ## @end deftypefn function response = webwrite (url, varargin)