# HG changeset patch # User John W. Eaton # Date 1257893463 18000 # Node ID 5f24df61667a64e0fd689e8d50b66f1da076121f # Parent 3ccd3a03944c7b7e0761ed50a3f48c1c9b7d8f8c update ferror doc string diff --git a/src/ChangeLog b/src/ChangeLog --- a/src/ChangeLog +++ b/src/ChangeLog @@ -1,10 +1,13 @@ +2009-11-10 John W. Eaton + + * file-io.cc (Fferror): Update doc string. + 2009-11-10 David Grundberg * oct-strstrm.h (octave_base_strstream::tell): Declare virtual. (octave_istrstream::tell): New method. 2009-11-10 John W. Eaton - * 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, diff --git a/src/file-io.cc b/src/file-io.cc --- a/src/file-io.cc +++ b/src/file-io.cc @@ -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;