fixed the documentation for the fbuf_detach() function

xant · Jul 3, 2014 · 113d464 · 113d464
1 parent 6fd835b
commit 113d464
Showing 1 changed file with 3 additions and 3 deletions.
diff --git a/src/fbuf.h b/src/fbuf.h
@@ -125,10 +125,10 @@ void fbuf_clear(fbuf_t *fbuf);
  * @brief Detach the underlying buffer and reset the fbuf
  * @param fbuf fbuf
  * @param buf A reference to the pointer where to store the addres of the actual buffer
- * @param used If not NULL, the amount of bytes actually used in the buffer is stored at the pointed address
- * @returns The size of the detached buffer (now stored in *buf)
+ * @param len If not NULL, the size of the detached buffer is stored at the pointed address
+ * @returns The amount of bytes actually used in the buffer is stored at the pointed address
  */
-unsigned int fbuf_detach(fbuf_t *fbuf, char **buf, int *used);
+unsigned int fbuf_detach(fbuf_t *fbuf, char **buf, int *len);
 
 /**
  * @brief Attach a pre-existing buffer to an fbuf