Update ffi README files (#243)

lune-org · Nov 9, 2024 · 461ab26 · 461ab26
1 parent 7a7ccf7
commit 461ab26
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 3 deletions.
diff --git a/crates/lune-std-ffi/README.md b/crates/lune-std-ffi/README.md
@@ -40,7 +40,7 @@ Define C-ABI type information and provide conversion and casting
 - [**Struct `CStructInfo`:**](./src/c/struct_info.rs) Represents C Struct type
 - [**Struct `CTypeInfo<T>`:**](./src/c/type_info.rs) Represents C type, extended in `/c/types`
 
-<details><summary><a href="./src/c/helper.rs"><strong>Mod <code>helper.rs</code>: C ABI type helper</strong></a></summary>
+<details><summary><a href="./src/c/helper.rs"><strong>Mod <code>helper.rs</code>:</strong></a> C ABI type helper</summary>
 
 - **Function `get_conv`, `get_conv_list`:**
   get `FfiConvert` from userdata (CStruct, CArr, CPtr, CTypes)
@@ -64,7 +64,7 @@ Define C-ABI type information and provide conversion and casting
 Export fixed-size source time known types and non-fixed compile time known types
 mod.rs implememts type-casting for all CTypes
 
-<details><summary><a href="./src/c/types/mod.rs"><strong>Mod <code>ctype_helper</code>:</strong></a> c type helper</summary>
+<details><summary><a href="./src/c/types/mod.rs"><strong>Mod <code>ctype_helper</code>:</strong></a> CTypeInfo helper</summary>
 
 - **Function `get_conv`:**
   get `FfiConvert` from ctype userdata, used for struct and array conversion

diff --git a/tests/ffi/README.md b/tests/ffi/README.md
@@ -1,4 +1,5 @@
 <!-- markdownlint-disable MD036 -->
+<!-- markdownlint-disable MD033 -->
 
 # `tests/ffi`
 
@@ -24,6 +25,12 @@ gcc for library compiling (for external-\*)
 - [x] [read_boundary](./read_boundary.luau)
 - [x] [write_boundary](./write_boundary.luau)
 
+**Types**
+
+- [x] [arr](./types/arr.luau)
+- [x] [ptr](./types/ptr.luau)
+- [x] [struct](./types/struct.luau)
+
 **Pretty Print**
 
 - [x] [arr](./pretty_print/arr.luau)
@@ -39,7 +46,7 @@ gcc for library compiling (for external-\*)
 
 > Note: LuaJit's os.clock function returns process CPU time (used) which much smaller then Luau's os.clock output. In this benchmark, luau uses 'time.h' instead of os.clock. See [utility/proc_clock](./utility/proc_clock/init.luau)
 
-### [benchmark/external_call](./benchmark/external_call/init.luau)
+<details><summary><h3><a href="./benchmark/external_call/init.luau">benchmark/external_call</a></h3></summary>
 
 **Target external c function**
 
@@ -102,3 +109,5 @@ Command: `deno run --unstable-ffi --allow-ffi ./tests/ffi/benchmark/external_cal
   > MEM: 12250MiB 5600 MT/s  
   > KERNEL: 10.0.22631 (Windows 11 x86_64)  
   > HOST: QEMU Standard PC (Q35 + ICH9, 2009)
+
+</details>