From a30c4a71987a795fac0c7e667ccec2d73922ca03 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?St=C3=A9phane=20Fillod=2C=20F8CFE?=
 <fillods@users.sourceforge.net>
Date: Sun, 26 Oct 2008 10:47:33 +0000
Subject: [PATCH] some more documenting of read_block()

git-svn-id: https://hamlib.svn.sourceforge.net/svnroot/hamlib/trunk@2422 7ae35d74-ebe9-4afe-98af-79ac388436b8
---
 src/iofunc.c | 5 ++++-
 1 file changed, 4 insertions(+), 1 deletion(-)

diff --git a/src/iofunc.c b/src/iofunc.c
index e51245b66..d0c41deef 100644
--- a/src/iofunc.c
+++ b/src/iofunc.c
@@ -2,7 +2,7 @@
  *  Hamlib Interface - generic file based io functions
  *  Copyright (c) 2000-2008 by Stephane Fillod and Frank Singleton
  *
- *	$Id: iofunc.c,v 1.17 2008-04-11 14:07:09 fillods Exp $
+ *	$Id: iofunc.c,v 1.18 2008-10-26 10:47:33 fillods Exp $
  *
  *   This library is free software; you can redistribute it and/or modify
  *   it under the terms of the GNU Library General Public License as
@@ -228,6 +228,9 @@ int HAMLIB_API read_block(hamlib_port_t *p, char *rxbuffer, size_t count)
  * \param rxmax maximum string size + 1
  * \param stopset string of recognized end of string characters
  * \param stopset_len length of stopset
+ * \return number of characters read if the operation has been sucessful,
+ * otherwise a negative value if an error occured (in which case, cause is
+ * set appropriately).
  *
  * Read a string from "fd" and put result into
  * an array of unsigned char pointed to by "rxbuffer"