m doc

Signed-off-by: Mattias Andrée <maandree@operamail.com>

2 files changed, 5 insertions, 1 deletions

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);