Skip to content

Commit 2d1dd42

Browse files
committed
Add early experimental support for enum extraction for API docs.
1 parent 05875d4 commit 2d1dd42

2 files changed

Lines changed: 540 additions & 69 deletions

File tree

docs/api.md

Lines changed: 100 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,10 @@
22

33
---
44

5-
# fs_result_to_string
5+
# fs_result_description
66

77
```c
8-
const char* fs_result_to_string(
8+
const char* fs_result_description(
99
fs_result result
1010
);
1111
```
@@ -2814,3 +2814,101 @@ int fs_snprintf(
28142814

28152815
---
28162816

2817+
# Enums
2818+
2819+
## fs_result
2820+
2821+
| Value | Description |
2822+
|-------|-------------|
2823+
| `FS_SUCCESS` = `0` | |
2824+
| `FS_ERROR` = `-1, /* Generic, unknown error. */` | |
2825+
| `FS_INVALID_ARGS` = `-2` | |
2826+
| `FS_INVALID_OPERATION` = `-3` | |
2827+
| `FS_OUT_OF_MEMORY` = `-4` | |
2828+
| `FS_OUT_OF_RANGE` = `-5` | |
2829+
| `FS_ACCESS_DENIED` = `-6` | |
2830+
| `FS_DOES_NOT_EXIST` = `-7` | |
2831+
| `FS_ALREADY_EXISTS` = `-8` | |
2832+
| `FS_TOO_MANY_OPEN_FILES` = `-9` | |
2833+
| `FS_INVALID_FILE` = `-10` | |
2834+
| `FS_TOO_BIG` = `-11` | |
2835+
| `FS_PATH_TOO_LONG` = `-12` | |
2836+
| `FS_NAME_TOO_LONG` = `-13` | |
2837+
| `FS_NOT_DIRECTORY` = `-14` | |
2838+
| `FS_IS_DIRECTORY` = `-15` | |
2839+
| `FS_DIRECTORY_NOT_EMPTY` = `-16` | |
2840+
| `FS_AT_END` = `-17` | |
2841+
| `FS_NO_SPACE` = `-18` | |
2842+
| `FS_BUSY` = `-19` | |
2843+
| `FS_IO_ERROR` = `-20` | |
2844+
| `FS_INTERRUPT` = `-21` | |
2845+
| `FS_UNAVAILABLE` = `-22` | |
2846+
| `FS_ALREADY_IN_USE` = `-23` | |
2847+
| `FS_BAD_ADDRESS` = `-24` | |
2848+
| `FS_BAD_SEEK` = `-25` | |
2849+
| `FS_BAD_PIPE` = `-26` | |
2850+
| `FS_DEADLOCK` = `-27` | |
2851+
| `FS_TOO_MANY_LINKS` = `-28` | |
2852+
| `FS_NOT_IMPLEMENTED` = `-29` | |
2853+
| `FS_NO_MESSAGE` = `-30` | |
2854+
| `FS_BAD_MESSAGE` = `-31` | |
2855+
| `FS_NO_DATA_AVAILABLE` = `-32` | |
2856+
| `FS_INVALID_DATA` = `-33` | |
2857+
| `FS_TIMEOUT` = `-34` | |
2858+
| `FS_NO_NETWORK` = `-35` | |
2859+
| `FS_NOT_UNIQUE` = `-36` | |
2860+
| `FS_NOT_SOCKET` = `-37` | |
2861+
| `FS_NO_ADDRESS` = `-38` | |
2862+
| `FS_BAD_PROTOCOL` = `-39` | |
2863+
| `FS_PROTOCOL_UNAVAILABLE` = `-40` | |
2864+
| `FS_PROTOCOL_NOT_SUPPORTED` = `-41` | |
2865+
| `FS_PROTOCOL_FAMILY_NOT_SUPPORTED` = `-42` | |
2866+
| `FS_ADDRESS_FAMILY_NOT_SUPPORTED` = `-43` | |
2867+
| `FS_SOCKET_NOT_SUPPORTED` = `-44` | |
2868+
| `FS_CONNECTION_RESET` = `-45` | |
2869+
| `FS_ALREADY_CONNECTED` = `-46` | |
2870+
| `FS_NOT_CONNECTED` = `-47` | |
2871+
| `FS_CONNECTION_REFUSED` = `-48` | |
2872+
| `FS_NO_HOST` = `-49` | |
2873+
| `FS_IN_PROGRESS` = `-50` | |
2874+
| `FS_CANCELLED` = `-51` | |
2875+
| `FS_MEMORY_ALREADY_MAPPED` = `-52` | |
2876+
| `FS_DIFFERENT_DEVICE` = `-53` | |
2877+
| `FS_CHECKSUM_MISMATCH` = `-100` | |
2878+
| `FS_NO_BACKEND` = `-101` | |
2879+
| `FS_NEEDS_MORE_INPUT` = `100, /* Some stream needs more input data before it can be proc` | |
2880+
| `FS_HAS_MORE_OUTPUT` = `102 /* Some stream has more output data to be read, but there'` | |
2881+
2882+
---
2883+
2884+
## fs_seek_origin
2885+
2886+
| Value | Description |
2887+
|-------|-------------|
2888+
| `FS_SEEK_SET` = `0` | |
2889+
| `FS_SEEK_CUR` = `1` | |
2890+
| `FS_SEEK_END` = `2` | |
2891+
2892+
---
2893+
2894+
## fs_format
2895+
2896+
| Value | Description |
2897+
|-------|-------------|
2898+
| `FS_FORMAT_TEXT` | |
2899+
| `FS_FORMAT_BINARY` | |
2900+
2901+
---
2902+
2903+
## fs_sysdir_type
2904+
2905+
| Value | Description |
2906+
|-------|-------------|
2907+
| `FS_SYSDIR_HOME` | |
2908+
| `FS_SYSDIR_TEMP` | |
2909+
| `FS_SYSDIR_CONFIG` | |
2910+
| `FS_SYSDIR_DATA` | |
2911+
| `FS_SYSDIR_CACHE` | |
2912+
2913+
---
2914+

0 commit comments

Comments
 (0)