From 442f74b195112d0908c9a6007e6f233950a03186 Mon Sep 17 00:00:00 2001 From: herbglitch Date: Mon, 30 Dec 2024 05:22:02 -0700 Subject: [PATCH] added basic documentation/boilerplate up till ARC_Lexer for the standard library documentation --- doc/Doxyfile | 8 ++++---- doc/index.md | 6 ++++-- doc/standard.md | 4 ---- include/arc/std/bool.h | 7 ++++++- include/arc/std/lexer.h | 8 ++++++++ src/std/io.c | 2 +- 6 files changed, 23 insertions(+), 12 deletions(-) delete mode 100644 doc/standard.md diff --git a/doc/Doxyfile b/doc/Doxyfile index 4555618..5ab5cd0 100644 --- a/doc/Doxyfile +++ b/doc/Doxyfile @@ -48,7 +48,7 @@ PROJECT_NAME = "Archeus" # could be handy for archiving the generated documentation or if some version # control system is used. -PROJECT_NUMBER = 0.0.0 +PROJECT_NUMBER = 0.1.0 # Using the PROJECT_BRIEF tag one can provide an optional one line description # for a project that appears at the top of each page and should give viewer a @@ -428,7 +428,7 @@ IDL_PROPERTY_SUPPORT = YES # all members of a group must be documented explicitly. # The default value is: NO. -DISTRIBUTE_GROUP_DOC = NO +DISTRIBUTE_GROUP_DOC = YES # If one adds a struct or class to a group and this option is enabled, then also # any nested class or struct is added to the same group. By default this option @@ -965,7 +965,7 @@ WARN_LOGFILE = # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING # Note: If this tag is empty the current directory is searched. -INPUT = ../include index.md standard.md +INPUT = ../include index.md ./pages/standard.md ./pages/math.md ./pages # This tag can be used to specify the character encoding of the source files # that Doxygen parses. Internally Doxygen uses the UTF-8 encoding. Doxygen uses @@ -2490,7 +2490,7 @@ INCLUDE_FILE_PATTERNS = # recursively expanded use the := operator instead of the = operator. # This tag requires that the tag ENABLE_PREPROCESSING is set to YES. -PREDEFINED = +PREDEFINED = ARC_DEBUG # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this # tag can be used to specify a list of macro names that should be expanded. The diff --git a/doc/index.md b/doc/index.md index ddd7d01..c99338d 100644 --- a/doc/index.md +++ b/doc/index.md @@ -1,5 +1,7 @@ -# Archeus Documentation +@mainpage About -# Introduction +Introduction Archeus is a C library and game engine that aims to be fully documented and modular + +@ref standard Standard Library diff --git a/doc/standard.md b/doc/standard.md deleted file mode 100644 index a6df5f4..0000000 --- a/doc/standard.md +++ /dev/null @@ -1,4 +0,0 @@ -Standard Library {#library} -============ - -Library Page Content from standard.md. diff --git a/include/arc/std/bool.h b/include/arc/std/bool.h index 3a251ff..bd59824 100644 --- a/include/arc/std/bool.h +++ b/include/arc/std/bool.h @@ -7,12 +7,17 @@ extern "C" { #include +//allows the boolean type to be overridden (example could be overriding for opengl booleans) +#ifndef ARC_BOOL_OVERRIDE + #define ARC_Bool bool #define ARC_True true #define ARC_False false +#endif + #ifdef __cplusplus } #endif -#endif //ARC_STD_BOOL_H_ \ No newline at end of file +#endif //ARC_STD_BOOL_H_ diff --git a/include/arc/std/lexer.h b/include/arc/std/lexer.h index 2525cf3..a4d803e 100644 --- a/include/arc/std/lexer.h +++ b/include/arc/std/lexer.h @@ -243,6 +243,7 @@ ARC_LexerTokenRule ARC_LexerTokenRule_CreateAndReturnMatchStringRule(uint32_t id ARC_LexerTokenRule ARC_LexerTokenRule_CreateAndReturnMatchCharInStringRule(uint32_t id, ARC_String *string); /** + * @{ * @brief basic tokens */ #define ARC_LEXER_TOKEN_NULL 0 @@ -250,8 +251,12 @@ ARC_LexerTokenRule ARC_LexerTokenRule_CreateAndReturnMatchCharInStringRule(uint3 #define ARC_LEXER_TOKEN_ALPHA_LOWER_CHAR 2 #define ARC_LEXER_TOKEN_ALPHA_UPPER_CHAR 3 #define ARC_LEXER_TOKEN_WHITESPACE 4 +/** + * @} +*/ /** + * @{ * @brief basic token type ids, chars, and tags */ #define ARC_LEXER_TOKEN_NEWLINE_ID 5 @@ -298,6 +303,9 @@ ARC_LexerTokenRule ARC_LexerTokenRule_CreateAndReturnMatchCharInStringRule(uint3 #define ARC_LEXER_TOKEN_PERCENT_ID 19 #define ARC_LEXER_TOKEN_PERCENT_CHAR '%' #define ARC_LEXER_TOKEN_PERCENT_TAG "PERCENT" +/** + * @} +*/ /** * @brief adds a bunch of basic token rules (matching the BasicTokens above) diff --git a/src/std/io.c b/src/std/io.c index b9b945a..82106f3 100644 --- a/src/std/io.c +++ b/src/std/io.c @@ -90,4 +90,4 @@ void ARC_IO_WriteStrToFile(ARC_String *path, ARC_String *data){ } fclose(file); -} \ No newline at end of file +}