Document better forb_init()

[frescor/frsh-forb.git] / src / forb / src / forb.h

diff --git a/src/forb/src/forb.h b/src/forb/src/forb.h
index 9e26590d4e201c4c4769a2bdaf7fdda62504361c..f742d50e96451e2ef23943ec46fe7eb7a1eedb06 100644 (file)
--- a/src/forb/src/forb.h
+++ b/src/forb/src/forb.h
@@ -168,8 +168,10 @@ typedef struct forb_init_attr {
  * Initializes FORB. This function has to be called before any other
  * FORB function.
  * 
- * Any command line arguments used by FORB are removed from the array
- * and @a argc and @a argv are updated accordingly.
+ * Any command line arguments used by FORB are removed from the @a
+ * argv array and @a argc is updated accordingly.
+ *
+ * @note Currently, no command line arguments are used by FORB.
  * 
  * @param argc a pointer to the number of command line arguments.
  * @param argv a pointer to the array of command line arguments.