diff options
| author | Eugene Triguba <eugenetriguba@gmail.com> | 2024-07-04 10:55:40 -0400 |
|---|---|---|
| committer | Eugene Triguba <eugenetriguba@gmail.com> | 2024-07-04 10:55:40 -0400 |
| commit | 26fe1ae8c07c949fb7f0880386c7bfee6cd220f7 (patch) | |
| tree | 1c595573f215ffc589a2bc975a97277357fa7591 /src/word.h | |
| parent | Format files (diff) | |
| download | cli-26fe1ae8c07c949fb7f0880386c7bfee6cd220f7.zip | |
Fix docs
Diffstat (limited to 'src/word.h')
| -rw-r--r-- | src/word.h | 11 |
1 files changed, 11 insertions, 0 deletions
@@ -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 |