Mercurial > hg > octave-terminal
changeset 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 | f217edac2c71 |
children | b12e2cffaa2f |
files | src/file-io.cc |
diffstat | 1 files changed, 4 insertions(+), 2 deletions(-) [+] |
line wrap: on
line diff
--- a/src/file-io.cc +++ b/src/file-io.cc @@ -1176,11 +1176,13 @@ DEFUN (sscanf, args, , "-*- texinfo -*-\n\ -@deftypefn {Built-in Function} {[@var{val}, @var{count}] =} sscanf (@var{string}, @var{template}, @var{size})\n\ +@deftypefn {Built-in Function} {[@var{val}, @var{count}, @var{pos}] =} sscanf (@var{string}, @var{template}, @var{size})\n\ @deftypefnx {Built-in Function} {[@var{v1}, @var{v2}, @dots{}, @var{count}] =} sscanf (@var{string}, @var{template}, \"C\")\n\ This is like @code{fscanf}, except that the characters are taken from the\n\ string @var{string} instead of from a stream. Reaching the end of the\n\ -string is treated as an end-of-file condition.\n\ +string is treated as an end-of-file condition. In addition to the values\n\ +returned by @code{fscanf}, the index of the next character to be read\n\ +is returned in in @var{pos}.\n\ @seealso{fscanf, scanf, sprintf}\n\ @end deftypefn") {