aboutsummaryrefslogtreecommitdiffstats
path: root/include/locusts.h
diff options
context:
space:
mode:
Diffstat (limited to 'include/locusts.h')
-rw-r--r--include/locusts.h13
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