From b38fa70af9e70f17948548a07cd300b964301db4 Mon Sep 17 00:00:00 2001 From: Randy Jordan Date: Thu, 25 Jun 2026 19:14:14 -0500 Subject: [PATCH] comments --- README.md | 7 ++++--- include/platform/ci2_platform.h | 4 +++- include/platform/error/ci2_exception.h | 6 +++++- src/linux_exception.c | 4 +++- src/win32_exception.c | 4 +++- 5 files changed, 18 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 200cccc..1823f35 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# ci2 +# ci2_base ## Description Inspired by all in the acknowledgments, this is my own personal C codebase. @@ -16,15 +16,16 @@ Inspired by all in the acknowledgments, this is my own personal C codebase. ## Features ## Todos +- [ ] Makefile ## Usage ```bash # Example installation -git clone https://myrepos.dev/Randy-Jordan/ci2.git +git clone https://myrepos.dev/Randy-Jordan/ci2_base.git # Navigate into the directory -cd ci2 +cd ci2_base # Build the project make diff --git a/include/platform/ci2_platform.h b/include/platform/ci2_platform.h index ba71d18..ab3ba76 100644 --- a/include/platform/ci2_platform.h +++ b/include/platform/ci2_platform.h @@ -1,4 +1,4 @@ -/* - | Copyright | ------------------------------------------------------------ +/* - | Copyright / About | ---------------------------------------------------- Copyright (c) 2026 Randy Jordan Permission is hereby granted, free of charge, to any person obtaining a copy of @@ -19,6 +19,8 @@ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. + +ci2_platform is the main api for all services the platform will provide. * --------------------------------------------------------------------------*/ #ifndef CI2_PLATFORM_H #define CI2_PLATFORM_H diff --git a/include/platform/error/ci2_exception.h b/include/platform/error/ci2_exception.h index 1c289c2..83e21de 100644 --- a/include/platform/error/ci2_exception.h +++ b/include/platform/error/ci2_exception.h @@ -1,4 +1,4 @@ -/* - | Copyright | ------------------------------------------------------------ +/* - | Copyright / About | ---------------------------------------------------- Copyright (c) 2026 Randy Jordan Permission is hereby granted, free of charge, to any person obtaining a copy of @@ -19,6 +19,10 @@ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. +Try/Catch implementation written in C. Macro magic, and not an ideal error +handling mechanism, but good enough for simple things, and start or fail type +things. + * --------------------------------------------------------------------------*/ #ifndef CI2_EXCEPTION_H #define CI2_EXCEPTION_H diff --git a/src/linux_exception.c b/src/linux_exception.c index f72d4e5..a255f0f 100644 --- a/src/linux_exception.c +++ b/src/linux_exception.c @@ -1,4 +1,4 @@ -/* - | Copyright | ------------------------------------------------------------ +/* - | Copyright / About | ---------------------------------------------------- Copyright (c) 2026 Randy Jordan Permission is hereby granted, free of charge, to any person obtaining a copy of @@ -19,6 +19,8 @@ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. +ci2_exception linux implementation. + * --------------------------------------------------------------------------*/ #include "../include/platform/error/ci2_exception.h" diff --git a/src/win32_exception.c b/src/win32_exception.c index d29d033..aa5fa9c 100644 --- a/src/win32_exception.c +++ b/src/win32_exception.c @@ -1,4 +1,4 @@ -/* - | Copyright | ------------------------------------------------------------ +/* - | Copyright / About | ---------------------------------------------------- Copyright (c) 2026 Randy Jordan Permission is hereby granted, free of charge, to any person obtaining a copy of @@ -19,6 +19,8 @@ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. +ci2_exception win32 implementation. + * --------------------------------------------------------------------------*/ #include "../include/platform/error/ci2_exception.h"