added basic documentation/boilerplate up till ARC_Lexer for the standard library documentation

This commit is contained in:
herbglitch 2024-12-30 05:22:12 -07:00
parent 442f74b195
commit 7b5194dc05
15 changed files with 153 additions and 0 deletions

View file

@ -0,0 +1,20 @@
\page standard-array ARC_Array
The ARC_Array is a simple type, all it does is have a `void *` to store the array data in and a `uint32_t` to store the size in. This type is mostly a helper type to cut down on the number of parameters needed within Archeus' functions
Example:
```c
#include <arc/std/array.h>
#include <stdlib.h>
//initing the array (as it is a basic type there is no ARC_Array_Create or ARC_Array_Destroy)
ARC_Array exampleArray;
exampleArray.size = 4;
exampleArray.data = malloc(sizeof(uint32_t) * exampleArray.size);
//example function using an ARC_Array
ARC_Example_RunArray(&exampleArray);
//cleanup
free(exampleArray.data);
```