From 131730e7dbdc5adfba4bf1ae78e90b47509156e1 Mon Sep 17 00:00:00 2001
From: merlokk <807634+merlokk@users.noreply.github.com>
Date: Sun, 1 Dec 2019 11:01:56 +0200
Subject: [PATCH] fix docstrings

---
 client/fileutils.h | 10 ++++++----
 1 file changed, 6 insertions(+), 4 deletions(-)

diff --git a/client/fileutils.h b/client/fileutils.h
index 58d05d366..612c9fee6 100644
--- a/client/fileutils.h
+++ b/client/fileutils.h
@@ -176,8 +176,9 @@ int loadFileJSON(const char *preferredName, void *data, size_t maxdatalen, size_
  *
  * @param preferredName
  * @param data The data array to store the loaded bytes from file
- * @param datalen the number of bytes loaded from file
+ * @param datalen the number of bytes loaded from file. may be NULL
  * @param keylen  the number of bytes a key per row is
+ * @param keycnt key count that lays in data. may be NULL
  * @return 0 for ok, 1 for failz
 */
 int loadFileDICTIONARY(const char *preferredName, void *data, size_t *datalen, uint8_t keylen, uint16_t *keycnt);
@@ -190,10 +191,11 @@ int loadFileDICTIONARY(const char *preferredName, void *data, size_t *datalen, u
  * @param preferredName
  * @param data The data array to store the loaded bytes from file
  * @param maxdatalen maximum size of data array in bytes
- * @param datalen the number of bytes loaded from file
+ * @param datalen the number of bytes loaded from file. may be NULL
  * @param keylen  the number of bytes a key per row is
- * @param startFilePosition  
- * @param endFilePosition 
+ * @param keycnt key count that lays in data. may be NULL
+ * @param startFilePosition  start position in dictionary file. used for big dictionaries.
+ * @param endFilePosition in case we have keys in file and maxdatalen reached it returns current key position in file. may be NULL
  * @return 0 for ok, 1 for failz
 */
 int loadFileDICTIONARYEx(const char *preferredName, void *data, size_t maxdatalen, size_t *datalen, uint8_t keylen, uint16_t *keycnt,