aboutsummaryrefslogtreecommitdiffhomepage
path: root/doc
diff options
context:
space:
mode:
authorCaleb Figgers <cdfiggers@gmail.com>2024-09-01 14:29:13 -0500
committerCaleb Figgers <cdfiggers@gmail.com>2024-09-01 14:29:13 -0500
commit5141866ea1de6fcf7b546dcf98736c7609b3c938 (patch)
treeab669d8811ac863d72fe0da974169ba306db79f8 /doc
parentAlways have an h1 header on doc pages (diff)
Include API Docs for C Modules
Diffstat (limited to 'doc')
-rw-r--r--doc/api/base64.mdz3
-rw-r--r--doc/api/cmath.mdz2
-rw-r--r--doc/api/crc.mdz3
-rw-r--r--doc/api/json.mdz2
-rw-r--r--doc/api/rawterm.mdz2
-rw-r--r--doc/api/utf8.mdz2
-rw-r--r--doc/api/zip.mdz3
7 files changed, 13 insertions, 4 deletions
diff --git a/doc/api/base64.mdz b/doc/api/base64.mdz
index 74104a6..0f78120 100644
--- a/doc/api/base64.mdz
+++ b/doc/api/base64.mdz
@@ -28,3 +28,6 @@ Converts a base64 encoded string to its binary representation of any format
# => "this is a test"
```
+## Reference
+
+@api-docs("../../spork" "base64")
diff --git a/doc/api/cmath.mdz b/doc/api/cmath.mdz
index 974f55f..5097b29 100644
--- a/doc/api/cmath.mdz
+++ b/doc/api/cmath.mdz
@@ -6,4 +6,4 @@
## Reference
-@api-docs[../../build/spork/cmath]
+@api-docs("../../spork" "cmath")
diff --git a/doc/api/crc.mdz b/doc/api/crc.mdz
index 75a2634..8e95400 100644
--- a/doc/api/crc.mdz
+++ b/doc/api/crc.mdz
@@ -7,3 +7,6 @@
Generate CRC variants. Rather than compile separate variants, we have code to generate the needed tables.
Keeps build simple, footprint small but with many variants accessible.
+# Reference
+
+@api-docs("../../spork" "crc")
diff --git a/doc/api/json.mdz b/doc/api/json.mdz
index 4cdac25..e3cfc8b 100644
--- a/doc/api/json.mdz
+++ b/doc/api/json.mdz
@@ -6,4 +6,4 @@
## Reference
-@api-docs[../../build/spork/json]
+@api-docs("../../spork" "json")
diff --git a/doc/api/rawterm.mdz b/doc/api/rawterm.mdz
index 8ea3fa8..683de60 100644
--- a/doc/api/rawterm.mdz
+++ b/doc/api/rawterm.mdz
@@ -6,4 +6,4 @@
## Reference
-@api-docs[../../build/spork/rawterm]
+@api-docs("../../spork" "rawterm")
diff --git a/doc/api/utf8.mdz b/doc/api/utf8.mdz
index 975b691..28f1fef 100644
--- a/doc/api/utf8.mdz
+++ b/doc/api/utf8.mdz
@@ -6,4 +6,4 @@
## Reference
-@api-docs[../../build/spork/utf8]
+@api-docs("../../spork" "utf8")
diff --git a/doc/api/zip.mdz b/doc/api/zip.mdz
index d8920bc..97a1249 100644
--- a/doc/api/zip.mdz
+++ b/doc/api/zip.mdz
@@ -6,3 +6,6 @@
Wrapper around miniz for compression functionality.
+## Reference
+
+@api-docs("../../spork" "zip")