Mercurial > hg > octave-max
comparison src/file-io.cc @ 12993:dfab2a8ca545 stable
doc: update sscanf doc string to match current behavior
* file-io.cc (Fsscanf): Document POS output.
author | John W. Eaton <jwe@octave.org> |
---|---|
date | Wed, 24 Aug 2011 11:20:26 -0400 |
parents | 9a498efac5f1 |
children | bac0858b92ee |
comparison
equal
deleted
inserted
replaced
12986:f217edac2c71 | 12993:dfab2a8ca545 |
---|---|
1174 return retval; | 1174 return retval; |
1175 } | 1175 } |
1176 | 1176 |
1177 DEFUN (sscanf, args, , | 1177 DEFUN (sscanf, args, , |
1178 "-*- texinfo -*-\n\ | 1178 "-*- texinfo -*-\n\ |
1179 @deftypefn {Built-in Function} {[@var{val}, @var{count}] =} sscanf (@var{string}, @var{template}, @var{size})\n\ | 1179 @deftypefn {Built-in Function} {[@var{val}, @var{count}, @var{pos}] =} sscanf (@var{string}, @var{template}, @var{size})\n\ |
1180 @deftypefnx {Built-in Function} {[@var{v1}, @var{v2}, @dots{}, @var{count}] =} sscanf (@var{string}, @var{template}, \"C\")\n\ | 1180 @deftypefnx {Built-in Function} {[@var{v1}, @var{v2}, @dots{}, @var{count}] =} sscanf (@var{string}, @var{template}, \"C\")\n\ |
1181 This is like @code{fscanf}, except that the characters are taken from the\n\ | 1181 This is like @code{fscanf}, except that the characters are taken from the\n\ |
1182 string @var{string} instead of from a stream. Reaching the end of the\n\ | 1182 string @var{string} instead of from a stream. Reaching the end of the\n\ |
1183 string is treated as an end-of-file condition.\n\ | 1183 string is treated as an end-of-file condition. In addition to the values\n\ |
1184 returned by @code{fscanf}, the index of the next character to be read\n\ | |
1185 is returned in in @var{pos}.\n\ | |
1184 @seealso{fscanf, scanf, sprintf}\n\ | 1186 @seealso{fscanf, scanf, sprintf}\n\ |
1185 @end deftypefn") | 1187 @end deftypefn") |
1186 { | 1188 { |
1187 static std::string who = "sscanf"; | 1189 static std::string who = "sscanf"; |
1188 | 1190 |