docs: Add documentation for @deprecated

reconquest · Oct 11, 2023 · 651f82c · 651f82c
1 parent 25d8a97
commit 651f82c
Showing 1 changed file with 13 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -191,6 +191,19 @@ function super() {
 }
 ```
 
+### `@deprecated`
+
+Whether or not the function is deprecated. If it is, a short deprecation notice
+will be prepended to the description.
+
+**Example**
+```bash
+# @deprecated
+say-hello() {
+    ...
+}
+```
+
 ### `@section`
 
 The name of a section of the file. Can be used to group functions.