From 26fe1ae8c07c949fb7f0880386c7bfee6cd220f7 Mon Sep 17 00:00:00 2001 From: Eugene Triguba Date: Thu, 4 Jul 2024 10:55:40 -0400 Subject: Fix docs --- src/word.h | 11 +++++++++++ 1 file changed, 11 insertions(+) (limited to 'src/word.h') 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 +/** + * 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 -- cgit v1.2.3