changeset 12552:1cfa3d9adf0a

Document the "all" parameter to fclose.
author Jordi Gutiérrez Hermoso <jordigh@gmail.com>
date Wed, 30 Mar 2011 13:07:53 -0600
parents e4a1ede4e832
children 7c915d013b9c
files src/ChangeLog src/file-io.cc
diffstat 2 files changed, 7 insertions(+), 1 deletions(-) [+]
line wrap: on
line diff
--- a/src/ChangeLog	Tue Mar 29 17:51:38 2011 -0700
+++ b/src/ChangeLog	Wed Mar 30 13:07:53 2011 -0600
@@ -1,3 +1,7 @@
+2011-03-30  Jordi GutiƩrrez Hermoso  <jordigh@gmail.com>
+
+	* file-io.cc: Document the "all" parameter to fclose.
+
 2011-03-29  Ben Abbott  <bpabbott@mac.com>
 
 	* graphics.cc: Prevent ticks from being cropped by round-off errors
--- a/src/file-io.cc	Tue Mar 29 17:51:38 2011 -0700
+++ b/src/file-io.cc	Wed Mar 30 13:07:53 2011 -0600
@@ -210,8 +210,10 @@
 DEFUN (fclose, args, ,
   "-*- texinfo -*-\n\
 @deftypefn {Built-in Function} {} fclose (@var{fid})\n\
+@deftypefnx {Built-in Function} {} fclose (\"all\")\n\
 Close the specified file.  If successful, @code{fclose} returns 0,\n\
-otherwise, it returns -1.\n\
+otherwise, it returns -1. The second form of the @code{fclose} call closes\n\
+all open files except @code{stdout}, @code{stderr}, and @code{stdin}.\n\
 @seealso{fopen, fseek, ftell}\n\
 @end deftypefn")
 {