svn: /web/doc-editor/trunk/php/ File.php

yannick                                  Tue, 01 Dec 2009 11:57:51 +0000

Revision: http://svn.php.net/viewvc?view=revision&revision=291551

Log:
Add comment on read method

Changed paths:
    U   web/doc-editor/trunk/php/File.php

Modified: web/doc-editor/trunk/php/File.php
===================================================================
--- web/doc-editor/trunk/php/File.php	2009-12-01 11:57:17 UTC (rev 291550)
+++ web/doc-editor/trunk/php/File.php	2009-12-01 11:57:51 UTC (rev 291551)
@@ -36,7 +36,10 @@
     }

     /**
-     * Read the content of a file.
+     * Read the content of a file.
+     *
+     * @param $readOriginal true to read the original content of the file, false to read the modified file (if any). By default, false.
+     * @return The content of the file.
      */
     public function read($readOriginal=false)
     {