hasufell/pqc
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

FILE: fix/add doxygen comments

Browse Source
This commit is contained in:
hasufell 2014-05-26 21:39:10 +02:00
parent b27170d150
commit c862c83f1f
No known key found for this signature in database
GPG Key ID: 220CD1C5BDEED020
2 changed files with 8 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
src/file.c
View File

@ -21,7 +21,7 @@
/** /**
* @file file.c * @file file.c
* Allows operations of files, such as reading * Allows operations on files, such as reading
* and writing. * and writing.
* @brief file operations * @brief file operations
*/ */

7
src/file.h
View File

@ -42,6 +42,13 @@
string * string *
read_file(char const * const filename); read_file(char const * const filename);
/**
* Write a string to a file. The file will be pruned or created
* if it does not exist.
*
* @param wstring the string to write to the file
* @param filename the name of the file to write to
*/
void void
write_file(string const *wstring, char const * const filename); write_file(string const *wstring, char const * const filename);