Mercurial > octave-nkf
changeset 9796:5f24df61667a
update ferror doc string
| author | John W. Eaton <jwe@octave.org> |
|---|---|
| date | Tue, 10 Nov 2009 17:51:03 -0500 |
| parents | 3ccd3a03944c |
| children | f569f46a1c34 |
| files | src/ChangeLog src/file-io.cc |
| diffstat | 2 files changed, 8 insertions(+), 1 deletions(-) [+] |
line wrap: on
line diff
--- a/src/ChangeLog Tue Nov 10 17:17:38 2009 -0500 +++ b/src/ChangeLog Tue Nov 10 17:51:03 2009 -0500 @@ -1,10 +1,13 @@ +2009-11-10 John W. Eaton <jwe@octave.org> + + * file-io.cc (Fferror): Update doc string. + 2009-11-10 David Grundberg <davidg@cs.umu.se> * oct-strstrm.h (octave_base_strstream::tell): Declare virtual. (octave_istrstream::tell): New method. 2009-11-10 John W. Eaton <jwe@octave.org> - * Makefile.am, OPERATORS/module.mk, TEMPLATE-INST/module.mk, find-defun-files.sh, version.h.in, DLD-FUNCTIONS/config-module.awk, DLD-FUNCTIONS/config-module.sh,
--- a/src/file-io.cc Tue Nov 10 17:17:38 2009 -0500 +++ b/src/file-io.cc Tue Nov 10 17:51:03 2009 -0500 @@ -1718,10 +1718,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\ 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;