From 3339647bb860c30f319ddb3ca3de7d26bc6ac22e Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Henrik=20Grubbstr=C3=B6m=20=28Grubba=29?=
<grubba@grubba.org>
Date: Wed, 28 Aug 2002 14:40:57 +0200
Subject: [PATCH] Improved documantation for Stdio.read_bytes().
Rev: lib/modules/Stdio.pmod/module.pmod:1.152
---
lib/modules/Stdio.pmod/module.pmod | 10 +++++++++-
1 file changed, 9 insertions(+), 1 deletion(-)
diff --git a/lib/modules/Stdio.pmod/module.pmod b/lib/modules/Stdio.pmod/module.pmod
index 6564af0d44..3604d18e98 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()]
//!
--
GitLab