docs: documented 'utils/symbol.h'

This commit is contained in:
antifallobst 2023-02-28 22:07:29 +01:00
parent 4d447860f5
commit 44a321b7df
1 changed files with 15 additions and 1 deletions

View File

@ -1222,4 +1222,18 @@ This string will be written into **_string_**.
#### `string_bool_to_alpha(string, value`) - function (void)
Converts the boolean in **_value_** to an alphanumeric string.
The representation is `true` or `false`.
This string will be written into **_string_**.
This string will be written into **_string_**.
### symbol.h
#### `symbol_type_E` - enum
- **Function**
- **Variable**
- **Unknown**
#### `symbol_T` - struct
| Name | Type | Description |
|---------|---------------|-------------------------------------------------------------------------------------|
| name | string_t | The name of the symbol (e.g. the name of the kernels entry symbol would be `_start` |
| type | symbol_type_E | The symbols type (elf types like `File` are of type `Unknown`) |
| address | uint64_t | The symbols address |