changeset 6588:4deaf99400b2

[project @ 2007-04-26 20:31:10 by jwe]
author jwe
date Thu, 26 Apr 2007 20:31:10 +0000
parents 00fad3bad2a5
children 1294fa07652b
files src/ChangeLog src/DLD-FUNCTIONS/urlwrite.cc
diffstat 2 files changed, 22 insertions(+), 13 deletions(-) [+]
line wrap: on
line diff
--- a/src/ChangeLog	Thu Apr 26 20:23:31 2007 +0000
+++ b/src/ChangeLog	Thu Apr 26 20:31:10 2007 +0000
@@ -1,3 +1,7 @@
+2007-04-26  Soren Hauberg  <soren@hauberg.org>
+
+	* DLD-FUNCTIONS/urlwrite.cc: Doc fix.
+
 2007-04-26  David Bateman  <dbateman@free.fr>
 
 	* pt-loop.cc (tree_simple_for_command::eval (void)): Correct
--- a/src/DLD-FUNCTIONS/urlwrite.cc	Thu Apr 26 20:23:31 2007 +0000
+++ b/src/DLD-FUNCTIONS/urlwrite.cc	Thu Apr 26 20:31:10 2007 +0000
@@ -196,29 +196,32 @@
 @var{localfile}.  For example,\n\
 \n\
 @example\n\
-urlwrite ('ftp://ftp.octave.org/pub/octave/README', 'README.txt');\n\
+urlwrite (\"ftp://ftp.octave.org/pub/octave/README\", \"README.txt\");\n\
 @end example\n\
 \n\
 The full path of the downloaded file is returned in @var{f}.  The\n\
 variable @var{success} is 1 if the download was successful,\n\
 otherwise it is 0 in which case @var{message} contains an error\n\
 message.  If no output argument is specified and if an error occurs,\n\
-then the error is signaled through octave's error handling mechanism.\n\
+then the error is signaled through Octave's error handling mechanism.\n\
 \n\
 This function uses libcurl.  Curl supports, among others, the HTTP,\n\
 FTP and FILE protocols.  Username and password may be specified in\n\
 the URL, for example:\n\
 \n\
 @example\n\
-urlwrite ('http://username:password@@example.com/file.txt', 'file.txt');\n\
+urlwrite (\"http://username:password@@example.com/file.txt\",\n\
+          \"file.txt\");\n\
 @end example\n\
 \n\
 GET and POST requests can be specified by @var{method} and @var{param}.\n\
-The parameter @var{method} is either 'get' or 'post' and @var{param} is a\n\
-cell array of parameter and value pairs.  For example:\n\
+The parameter @var{method} is either @samp{get} or @get{post}\n\
+and @var{param} is a cell array of parameter and value pairs.\n\
+For example:\n\
 \n\
 @example\n\
-urlwrite ('http://www.google.com/search', 'search.html', 'get', @{'query', 'octave'@});\n\
+urlwrite (\"http://www.google.com/search\", \"search.html\",\n\
+          \"get\", @{\"query\", \"octave\"@});\n\
 @end example\n\
 @seealso{urlread}\n\
 @end deftypefn")
@@ -335,33 +338,35 @@
 in string @var{s}.  For example,\n\
 \n\
 @example\n\
-s = urlread ('ftp://ftp.octave.org/pub/octave/README');\n\
+s = urlread (\"ftp://ftp.octave.org/pub/octave/README\");\n\
 @end example\n\
 \n\
 The variable @var{success} is 1 if the download was successful,\n\
 otherwise it is 0 in which case @var{message} contains an error\n\
 message.  If no output argument is specified and if an error occurs,\n\
-then the error is signaled through octave's error handling mechanism.\n\
+then the error is signaled through Octave's error handling mechanism.\n\
 \n\
 This function uses libcurl.  Curl supports, among others, the HTTP,\n\
 FTP and FILE protocols.  Username and password may be specified in the\n\
 URL.  For example,\n\
 \n\
 @example\n\
-s = urlread ('http://username:password@@example.com/file.txt');\n\
+s = urlread (\"http://username:password@@example.com/file.txt\");\n\
 @end example\n\
 \n\
 GET and POST requests can be specified by @var{method} and @var{param}.\n\
-The parameter @var{method} is either 'get' or 'post' and @var{param} is a\n\
-cell array of parameter and value pairs.  For example,\n\
+The parameter @var{method} is either @samp{get} or @samp{post}\n\
+and @var{param} is a cell array of parameter and value pairs.\n\
+For example,\n\ 
 \n\
 @example\n\
-s = urlread ('http://www.google.com/search', 'get', @{'query', 'octave'@});\n\
+s = urlread (\"http://www.google.com/search\", \"get\",\n\
+             @{\"query\", \"octave\"@});\n\
 @end example\n\
 @seealso{urlwrite}\n\
 @end deftypefn")
 {
-  // octave's return value
+  // Octave's return value
   octave_value_list retval;
 
 #if defined (HAVE_CURL)