# HG changeset patch # User Binki # Date 2009-07-12 21:51:34 # Node ID 9416465039f36c488231a5b1d647e5f10692a05d # Parent 49a8e39f40dbca5d55cbaf826a505793f7ca388c fixed typos and added doxygen tags diff --git a/src/common/execio.h b/src/common/execio.h --- a/src/common/execio.h +++ b/src/common/execio.h @@ -43,27 +43,30 @@ struct execio pid_t child; }; -/* +/** runs progname with the arguments in argv. argv must be null terminated!!!!!!!!! returns nonzero return on error */ -int execio_open(struct execio **rem, const char *progname, char *const argv[]); +int execio_open(struct execio **eio, const char *progname, char *const argv[]); -/* +/** doesn't block, returns 0 on success, 1 on failure */ int execio_read(struct execio *eio, void *buf, size_t len, size_t *bytesread); -int execio_write(struct execio *eio, void *buf, size_t len, size_t *bytesread); +int execio_write(struct execio *eio, void *buf, size_t len, size_t *byteswritten); -/* +/** use this function to determine if the using program should keep trying to read/write + + @todo is this function good enough/necessary? */ enum execio_state execio_state(struct execio *eio); -/* - nonzero return on error +/** + Closes an execio session. + @return nonzero on error */ int execio_close(struct execio *eio);