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,34 @@
\page standard-bool ARC_Bool
The ::ARC_Bool type simple sets ::ARC_Bool to the `stdbool.h` `bool` type, ::ARC_True to true, and ::ARC_False to false. This type exists so that it can be overriden if a different boolean type should be used (like with opengl)
Basic Example:
```c
#include <arc/std/bool.h>
ARC_Bool example = ARC_True;
//this example is very pedantic, saying `== ARC_True` isn't required, just recommended
if(example == ARC_True){
//this will be executed
}
```
Override Example:
```c
#include <stdint.h>
//this should be called at the start of the program
#define ARC_BOOL_OVERRIDE
#define ARC_Bool uint8_t
#define ARC_True 1
#define ARC_False 0
#include <arc/std/bool.h>
ARC_Bool example = ARC_False;
if(example != ARC_True){
//this will be executed
}
```