Mercurial > octave-nkf
comparison libinterp/corefcn/urlwrite.cc @ 20207:4f45eaf83908 stable
doc: Update more docstrings to have one sentence summary as first line.
Reviewed libinterp/corefcn directory.
* libinterp/corefcn/__ilu__.cc, libinterp/corefcn/balance.cc,
libinterp/corefcn/besselj.cc, libinterp/corefcn/betainc.cc,
libinterp/corefcn/bitfcns.cc, libinterp/corefcn/bsxfun.cc,
libinterp/corefcn/cellfun.cc, libinterp/corefcn/colloc.cc,
libinterp/corefcn/conv2.cc, libinterp/corefcn/data.cc,
libinterp/corefcn/debug.cc, libinterp/corefcn/defaults.cc,
libinterp/corefcn/det.cc, libinterp/corefcn/dirfns.cc,
libinterp/corefcn/dlmread.cc, libinterp/corefcn/dot.cc,
libinterp/corefcn/eig.cc, libinterp/corefcn/error.cc,
libinterp/corefcn/fft2.cc, libinterp/corefcn/fftn.cc,
libinterp/corefcn/file-io.cc, libinterp/corefcn/filter.cc,
libinterp/corefcn/find.cc, libinterp/corefcn/gammainc.cc,
libinterp/corefcn/gcd.cc, libinterp/corefcn/getgrent.cc,
libinterp/corefcn/getpwent.cc, libinterp/corefcn/getrusage.cc,
libinterp/corefcn/graphics.cc, libinterp/corefcn/help.cc,
libinterp/corefcn/hex2num.cc, libinterp/corefcn/input.cc,
libinterp/corefcn/inv.cc, libinterp/corefcn/kron.cc,
libinterp/corefcn/load-path.cc, libinterp/corefcn/load-save.cc,
libinterp/corefcn/lookup.cc, libinterp/corefcn/ls-oct-ascii.cc,
libinterp/corefcn/lsode.cc, libinterp/corefcn/lu.cc,
libinterp/corefcn/luinc.cc, libinterp/corefcn/mappers.cc,
libinterp/corefcn/matrix_type.cc, libinterp/corefcn/max.cc,
libinterp/corefcn/md5sum.cc, libinterp/corefcn/mgorth.cc,
libinterp/corefcn/nproc.cc, libinterp/corefcn/oct-hist.cc,
libinterp/corefcn/ordschur.cc, libinterp/corefcn/pager.cc,
libinterp/corefcn/pinv.cc, libinterp/corefcn/pr-output.cc,
libinterp/corefcn/pt-jit.cc, libinterp/corefcn/quad.cc,
libinterp/corefcn/quadcc.cc, libinterp/corefcn/qz.cc,
libinterp/corefcn/rand.cc, libinterp/corefcn/rcond.cc,
libinterp/corefcn/regexp.cc, libinterp/corefcn/schur.cc,
libinterp/corefcn/sighandlers.cc, libinterp/corefcn/sparse.cc,
libinterp/corefcn/spparms.cc, libinterp/corefcn/str2double.cc,
libinterp/corefcn/strfind.cc, libinterp/corefcn/strfns.cc,
libinterp/corefcn/sub2ind.cc, libinterp/corefcn/svd.cc,
libinterp/corefcn/symtab.cc, libinterp/corefcn/syscalls.cc,
libinterp/corefcn/sysdep.cc, libinterp/corefcn/time.cc,
libinterp/corefcn/toplev.cc, libinterp/corefcn/tril.cc,
libinterp/corefcn/tsearch.cc, libinterp/corefcn/typecast.cc,
libinterp/corefcn/urlwrite.cc, libinterp/corefcn/utils.cc,
libinterp/corefcn/variables.cc, scripts/polynomial/spline.m:
Update more docstrings to have one sentence summary as first line.
| author | Rik <rik@octave.org> |
|---|---|
| date | Sat, 09 May 2015 17:19:30 -0700 |
| parents | 4197fc428c7d |
| children | aa36fb998a4d |
comparison
equal
deleted
inserted
replaced
| 20206:b70f8da6dcd3 | 20207:4f45eaf83908 |
|---|---|
| 293 @deftypefn {Loadable Function} {} urlwrite (@var{url}, @var{localfile})\n\ | 293 @deftypefn {Loadable Function} {} urlwrite (@var{url}, @var{localfile})\n\ |
| 294 @deftypefnx {Loadable Function} {@var{f} =} urlwrite (@var{url}, @var{localfile})\n\ | 294 @deftypefnx {Loadable Function} {@var{f} =} urlwrite (@var{url}, @var{localfile})\n\ |
| 295 @deftypefnx {Loadable Function} {[@var{f}, @var{success}] =} urlwrite (@var{url}, @var{localfile})\n\ | 295 @deftypefnx {Loadable Function} {[@var{f}, @var{success}] =} urlwrite (@var{url}, @var{localfile})\n\ |
| 296 @deftypefnx {Loadable Function} {[@var{f}, @var{success}, @var{message}] =} urlwrite (@var{url}, @var{localfile})\n\ | 296 @deftypefnx {Loadable Function} {[@var{f}, @var{success}, @var{message}] =} urlwrite (@var{url}, @var{localfile})\n\ |
| 297 Download a remote file specified by its @var{url} and save it as\n\ | 297 Download a remote file specified by its @var{url} and save it as\n\ |
| 298 @var{localfile}. For example:\n\ | 298 @var{localfile}.\n\ |
| 299 \n\ | |
| 300 For example:\n\ | |
| 299 \n\ | 301 \n\ |
| 300 @example\n\ | 302 @example\n\ |
| 301 @group\n\ | 303 @group\n\ |
| 302 urlwrite (\"ftp://ftp.octave.org/pub/README\",\n\ | 304 urlwrite (\"ftp://ftp.octave.org/pub/README\",\n\ |
| 303 \"README.txt\");\n\ | 305 \"README.txt\");\n\ |
| 304 @end group\n\ | 306 @end group\n\ |
| 305 @end example\n\ | 307 @end example\n\ |
| 306 \n\ | 308 \n\ |
| 307 The full path of the downloaded file is returned in @var{f}. The\n\ | 309 The full path of the downloaded file is returned in @var{f}.\n\ |
| 308 variable @var{success} is 1 if the download was successful,\n\ | 310 \n\ |
| 309 otherwise it is 0 in which case @var{message} contains an error\n\ | 311 The variable @var{success} is 1 if the download was successful,\n\ |
| 310 message. If no output argument is specified and an error occurs,\n\ | 312 otherwise it is 0 in which case @var{message} contains an error message.\n\ |
| 311 then the error is signaled through Octave's error handling mechanism.\n\ | 313 \n\ |
| 312 \n\ | 314 If no output argument is specified and an error occurs, then the error is\n\ |
| 313 This function uses libcurl. Curl supports, among others, the HTTP,\n\ | 315 signaled through Octave's error handling mechanism.\n\ |
| 314 FTP and FILE protocols. Username and password may be specified in\n\ | 316 \n\ |
| 315 the URL, for example:\n\ | 317 This function uses libcurl. Curl supports, among others, the HTTP, FTP and\n\ |
| 318 FILE protocols. Username and password may be specified in the URL, for\n\ | |
| 319 example:\n\ | |
| 316 \n\ | 320 \n\ |
| 317 @example\n\ | 321 @example\n\ |
| 318 @group\n\ | 322 @group\n\ |
| 319 urlwrite (\"http://username:password@@example.com/file.txt\",\n\ | 323 urlwrite (\"http://username:password@@example.com/file.txt\",\n\ |
| 320 \"file.txt\");\n\ | 324 \"file.txt\");\n\ |
| 321 @end group\n\ | 325 @end group\n\ |
| 322 @end example\n\ | 326 @end example\n\ |
| 323 \n\ | 327 \n\ |
| 324 GET and POST requests can be specified by @var{method} and @var{param}.\n\ | 328 GET and POST requests can be specified by @var{method} and @var{param}.\n\ |
| 325 The parameter @var{method} is either @samp{get} or @samp{post}\n\ | 329 The parameter @var{method} is either @samp{get} or @samp{post} and\n\ |
| 326 and @var{param} is a cell array of parameter and value pairs.\n\ | 330 @var{param} is a cell array of parameter and value pairs.\n\ |
| 327 For example:\n\ | 331 For example:\n\ |
| 328 \n\ | 332 \n\ |
| 329 @example\n\ | 333 @example\n\ |
| 330 @group\n\ | 334 @group\n\ |
| 331 urlwrite (\"http://www.google.com/search\", \"search.html\",\n\ | 335 urlwrite (\"http://www.google.com/search\", \"search.html\",\n\ |
| 456 @deftypefn {Loadable Function} {@var{s} =} urlread (@var{url})\n\ | 460 @deftypefn {Loadable Function} {@var{s} =} urlread (@var{url})\n\ |
| 457 @deftypefnx {Loadable Function} {[@var{s}, @var{success}] =} urlread (@var{url})\n\ | 461 @deftypefnx {Loadable Function} {[@var{s}, @var{success}] =} urlread (@var{url})\n\ |
| 458 @deftypefnx {Loadable Function} {[@var{s}, @var{success}, @var{message}] =} urlread (@var{url})\n\ | 462 @deftypefnx {Loadable Function} {[@var{s}, @var{success}, @var{message}] =} urlread (@var{url})\n\ |
| 459 @deftypefnx {Loadable Function} {[@dots{}] =} urlread (@var{url}, @var{method}, @var{param})\n\ | 463 @deftypefnx {Loadable Function} {[@dots{}] =} urlread (@var{url}, @var{method}, @var{param})\n\ |
| 460 Download a remote file specified by its @var{url} and return its content\n\ | 464 Download a remote file specified by its @var{url} and return its content\n\ |
| 461 in string @var{s}. For example:\n\ | 465 in string @var{s}.\n\ |
| 466 \n\ | |
| 467 For example:\n\ | |
| 462 \n\ | 468 \n\ |
| 463 @example\n\ | 469 @example\n\ |
| 464 s = urlread (\"ftp://ftp.octave.org/pub/README\");\n\ | 470 s = urlread (\"ftp://ftp.octave.org/pub/README\");\n\ |
| 465 @end example\n\ | 471 @end example\n\ |
| 466 \n\ | 472 \n\ |
| 467 The variable @var{success} is 1 if the download was successful,\n\ | 473 The variable @var{success} is 1 if the download was successful,\n\ |
| 468 otherwise it is 0 in which case @var{message} contains an error\n\ | 474 otherwise it is 0 in which case @var{message} contains an error\n\ |
| 469 message. If no output argument is specified and an error occurs,\n\ | 475 message.\n\ |
| 470 then the error is signaled through Octave's error handling mechanism.\n\ | 476 \n\ |
| 471 \n\ | 477 If no output argument is specified and an error occurs, then the error is\n\ |
| 472 This function uses libcurl. Curl supports, among others, the HTTP,\n\ | 478 signaled through Octave's error handling mechanism.\n\ |
| 473 FTP and FILE protocols. Username and password may be specified in the\n\ | 479 \n\ |
| 474 URL@. For example:\n\ | 480 This function uses libcurl. Curl supports, among others, the HTTP, FTP and\n\ |
| 481 FILE protocols. Username and password may be specified in the URL@. For\n\ | |
| 482 example:\n\ | |
| 475 \n\ | 483 \n\ |
| 476 @example\n\ | 484 @example\n\ |
| 477 s = urlread (\"http://user:password@@example.com/file.txt\");\n\ | 485 s = urlread (\"http://user:password@@example.com/file.txt\");\n\ |
| 478 @end example\n\ | 486 @end example\n\ |
| 479 \n\ | 487 \n\ |
| 480 GET and POST requests can be specified by @var{method} and @var{param}.\n\ | 488 GET and POST requests can be specified by @var{method} and @var{param}.\n\ |
| 481 The parameter @var{method} is either @samp{get} or @samp{post}\n\ | 489 The parameter @var{method} is either @samp{get} or @samp{post} and\n\ |
| 482 and @var{param} is a cell array of parameter and value pairs.\n\ | 490 @var{param} is a cell array of parameter and value pairs.\n\ |
| 483 For example:\n\ | 491 For example:\n\ |
| 484 \n\ | 492 \n\ |
| 485 @example\n\ | 493 @example\n\ |
| 486 @group\n\ | 494 @group\n\ |
| 487 s = urlread (\"http://www.google.com/search\", \"get\",\n\ | 495 s = urlread (\"http://www.google.com/search\", \"get\",\n\ |