[PHP-DOC] cvs: phpdoc /en/functions filesystem.xml

[Sterling Hughes]

sterling                Tue Dec  4 15:10:08 2001 EDT

  Modified files:              
    /phpdoc/en/functions        filesystem.xml 
  Log:
  Add documentation as per mr. zmievski's request
  
Index: phpdoc/en/functions/filesystem.xml
diff -u phpdoc/en/functions/filesystem.xml:1.91 phpdoc/en/functions/filesystem.xml:1.92
--- phpdoc/en/functions/filesystem.xml:1.91     Thu Nov 22 17:20:10 2001
+++ phpdoc/en/functions/filesystem.xml  Tue Dec  4 15:10:08 2001
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.91 $ -->
+<!-- $Revision: 1.92 $ -->
  <reference id="ref.filesystem">
   <title>Filesystem functions</title>
   <titleabbrev>Filesystem</titleabbrev>
@@ -595,14 +595,15 @@
      <funcprototype>
       <funcdef>string <function>fgets</function></funcdef>
       <paramdef>int <parameter>fp</parameter></paramdef>
-      <paramdef>int <parameter>length</parameter></paramdef>
+      <paramdef>int <parameter><optional>length</optional></parameter></paramdef>
      </funcprototype>
     </funcsynopsis>
     <para>
      Returns a string of up to length - 1 bytes read from the file
      pointed to by fp. Reading ends when length - 1 bytes have been
      read, on a newline (which is included in the return value), or on
-     EOF (whichever comes first).
+     EOF (whichever comes first).  If no length is specified, the length 
+     defaults to 1k, or 1024 bytes.
     </para>
     <para>
      If an error occurs, returns &false;.