diff --git a/lib/modules/Stdio.pmod/module.pmod b/lib/modules/Stdio.pmod/module.pmod index 6564af0d44be91193176822ad793a9c6e6a97e29..3604d18e98745ba993032b513b68e04220b38911 100644 --- a/lib/modules/Stdio.pmod/module.pmod +++ b/lib/modules/Stdio.pmod/module.pmod @@ -1,4 +1,4 @@ -// $Id: module.pmod,v 1.151 2002/08/27 09:45:05 grubba Exp $ +// $Id: module.pmod,v 1.152 2002/08/28 12:40:57 grubba Exp $ #pike __REAL_VERSION__ inherit files; @@ -1628,6 +1628,14 @@ string read_file(string filename,void|int start,void|int len) //! //! If @[start] is also omitted, the entire file will be returned. //! +//! @throws +//! Throws an error if @[filename] isn't a regular file. +//! +//! @returns +//! Returns @tt{0@} (zero) on failure to open @[filename]. +//! +//! Returns a string with the requested data otherwise. +//! //! @seealso //! @[read_file], @[write_file()], @[append_file()] //!