Mercurial > octave-nkf
changeset 9797:f569f46a1c34
update ferror doc string, take 2
| author | John W. Eaton <jwe@octave.org> |
|---|---|
| date | Tue, 10 Nov 2009 17:55:19 -0500 |
| parents | 5f24df61667a |
| children | 2d6a5af744b6 |
| files | src/file-io.cc |
| diffstat | 1 files changed, 7 insertions(+), 8 deletions(-) [+] |
line wrap: on
line diff
--- a/src/file-io.cc Tue Nov 10 17:51:03 2009 -0500 +++ b/src/file-io.cc Tue Nov 10 17:55:19 2009 -0500 @@ -1717,15 +1717,14 @@ DEFUNX ("ferror", Fferror, args, , "-*- texinfo -*-\n\ -@deftypefn {Built-in Function} {} ferror (@var{fid})\n\ -@deftypefnx {Built-in Function} {} ferror (@var{fid}, \"clear\")\n\ -Return 1 if an error condition has been encountered for a given file\n\ -and 0 otherwise. Note that it will only return 1 if an error has\n\ -already been encountered, not if the next operation will result in an\n\ +@deftypefn {Built-in Function} {[@var{err}, @var{msg}] =} ferror (@var{fid}, \"clear\")\n\ +Return 1 if an error condition has been encountered for the file ID\n\ +@var{fid} and 0 otherwise. Note that it will only return 1 if an error\n\ +has already been encountered, not if the next operation will result in\n\ +an error condition.\n\ +\n\ +The second argument is optional. If it is supplied, also clear the\n\ error condition.\n\ -\n\ -If the optional argument @code{\"clear\"} is supplied, the error\n\ -condition is cleared.\n\ @end deftypefn") { octave_value_list retval;