aboutsummaryrefslogtreecommitdiffstats
path: root/src/word.h
diff options
context:
space:
mode:
authorEugene Triguba <eugenetriguba@gmail.com>2024-07-04 10:55:40 -0400
committerEugene Triguba <eugenetriguba@gmail.com>2024-07-04 10:55:40 -0400
commit26fe1ae8c07c949fb7f0880386c7bfee6cd220f7 (patch)
tree1c595573f215ffc589a2bc975a97277357fa7591 /src/word.h
parentFormat files (diff)
downloadcli-26fe1ae8c07c949fb7f0880386c7bfee6cd220f7.zip
Fix docs
Diffstat (limited to 'src/word.h')
-rw-r--r--src/word.h11
1 files changed, 11 insertions, 0 deletions
diff --git a/src/word.h b/src/word.h
index 77afbdc..f7006a3 100644
--- a/src/word.h
+++ b/src/word.h
@@ -3,6 +3,17 @@
#include <stdio.h>
+/**
+ * Read in a word from a file up to size length.
+ *
+ * @param fp[in] The file to read a word from.
+ * @param word[out] The word that was read as a null-terminated string.
+ * @param length[in] The length of the word to read in.
+ *
+ * @note `length` should be the number of characters you'd
+ * like to read in plus one to take into account the
+ * null terminator.
+ */
int read_word(FILE *fp, char *word, size_t length);
#endif