From 26dbb8ea110ff1b911f88c362b4b3c170ffce3e5 Mon Sep 17 00:00:00 2001 From: Mattias Andrée Date: Thu, 16 Apr 2015 05:07:17 +0200 Subject: m doc MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Mattias Andrée --- src/bus.c | 3 +++ src/bus.h | 3 ++- 2 files changed, 5 insertions(+), 1 deletion(-) diff --git a/src/bus.c b/src/bus.c index d97231a..7f05560 100644 --- a/src/bus.c +++ b/src/bus.c @@ -409,6 +409,9 @@ fail: * @param bus Bus information to fill * @param file The filename of the bus * @param flags `BUS_RDONLY`, `BUS_WRONLY` or `BUS_RDWR` + * any negative value is used internally + * for telling the function to not actually + * opening the bus, but just to parse the file * @return 0 on success, -1 on error */ int diff --git a/src/bus.h b/src/bus.h index 2428574..4068909 100644 --- a/src/bus.h +++ b/src/bus.h @@ -113,7 +113,8 @@ int bus_unlink(const char *file); * * @param bus Bus information to fill * @param file The filename of the bus - * @param flags `BUS_RDONLY`, `BUS_WRONLY` or `BUS_RDWR` + * @param flags `BUS_RDONLY`, `BUS_WRONLY` or `BUS_RDWR`, + * the value must not be negative * @return 0 on success, -1 on error */ int bus_open(bus_t *bus, const char *file, int flags); -- cgit v1.2.3-70-g09d2