docs: add ignore to readme

ltabis · Apr 18, 2024 · b9361a2 · b9361a2
1 parent b9ab5ba
commit b9361a2
Showing 1 changed file with 8 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -57,6 +57,14 @@ mod my_module {
     pub fn add(a: rhai::INT, b: rhai::INT) -> rhai::INT {
         a + b
     }
+
+    /// Use the following directive to not generate documentation:
+    ///
+    /// # rhai-autodocs:ignore
+    #[rhai_fn(global)]
+    pub fn dont_care() {
+        println!("nope");
+    }
 }
 
 // 2. Generate the docs with autodocs. This library can be imported as a build dependency into your build script.