Add doxygen and source comments to some functions of the krb5 API

Signed-off-by: Love Hornquist Astrand <lha@h5l.org>
This commit is contained in:
Marco Molteni
2012-05-08 11:51:54 +02:00
committed by Love Hornquist Astrand
parent 0cee6d1d70
commit 894008ab82
5 changed files with 101 additions and 9 deletions

View File

@@ -33,6 +33,15 @@
#include "krb5_locl.h"
/**
* Read \a len bytes from socket \a p_fd into buffer \a buf.
* Block until \a len bytes are read or until an error.
*
* @return If successful, the number of bytes read: \a len.
* On end-of-file, 0.
* On error, less than 0 (if single-threaded, the error can be found
* in the errno global variable).
*/
KRB5_LIB_FUNCTION krb5_ssize_t KRB5_LIB_CALL
krb5_net_read (krb5_context context,
void *p_fd,