diff options
| author | Matt Strapp <matt@mattstrapp.net> | 2024-05-14 16:16:31 -0500 |
|---|---|---|
| committer | Matt Strapp <matt@mattstrapp.net> | 2024-05-14 16:16:31 -0500 |
| commit | 57164aba14c157288df338b8cf2f5622d01ff460 (patch) | |
| tree | a91454f6b008f26e0d5838ff3e334b7d394da356 /include | |
| parent | Add a C file to make C compilers actually build this into a shared object (diff) | |
| download | locusts-57164aba14c157288df338b8cf2f5622d01ff460.tar locusts-57164aba14c157288df338b8cf2f5622d01ff460.tar.gz locusts-57164aba14c157288df338b8cf2f5622d01ff460.tar.bz2 locusts-57164aba14c157288df338b8cf2f5622d01ff460.tar.lz locusts-57164aba14c157288df338b8cf2f5622d01ff460.tar.xz locusts-57164aba14c157288df338b8cf2f5622d01ff460.tar.zst locusts-57164aba14c157288df338b8cf2f5622d01ff460.zip | |
Add a half-assed doxygen implementation and start a really bad idea
Signed-off-by: Matt Strapp <matt@mattstrapp.net>
Diffstat (limited to 'include')
| -rw-r--r-- | include/locusts.h | 13 |
1 files changed, 7 insertions, 6 deletions
diff --git a/include/locusts.h b/include/locusts.h index 870a0ad..316bfdb 100644 --- a/include/locusts.h +++ b/include/locusts.h @@ -1,3 +1,4 @@ +/** @file */ #ifndef LOCUSTS_H #define LOCUSTS_H @@ -5,12 +6,12 @@ extern "C" { #endif -/* -Introduces locusts into your codebase. - -Note: locusts are not included with installing this library. Please source your -own. -*/ +/** + * @brief Add locusts to your codebase. + * + * NOTE: Locusts are not included in this library. + * You will have to provide your own. + */ void introduce_locusts(void); #ifdef __cplusplus |