herbglitch/archeus
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

added basic documentation/boilerplate up till ARC_Lexer for the standard library documentation

Browse source
This commit is contained in:
herbglitch 2024-12-30 05:22:02 -07:00
parent d109bc5152
commit 442f74b195
6 changed files with 23 additions and 12 deletions
Download patch file Download diff file Expand all files Collapse all files

8
doc/Doxyfile
View file

@ -48,7 +48,7 @@ PROJECT_NAME = "Archeus"
# could be handy for archiving the generated documentation or if some version # could be handy for archiving the generated documentation or if some version
# control system is used. # 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 # 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 # 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. # all members of a group must be documented explicitly.
# The default value is: NO. # 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 # 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 # 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 # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
# Note: If this tag is empty the current directory is searched. # 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 # 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 # 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. # recursively expanded use the := operator instead of the = operator.
# This tag requires that the tag ENABLE_PREPROCESSING is set to YES. # 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 # 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 # tag can be used to specify a list of macro names that should be expanded. The

6
doc/index.md
View file

@ -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 Archeus is a C library and game engine that aims to be fully documented and modular
@ref standard Standard Library

4
doc/standard.md
View file

@ -1,4 +0,0 @@
Standard Library {#library}
============
Library Page Content from standard.md.

5
include/arc/std/bool.h
View file

@ -7,10 +7,15 @@ extern "C" {
#include <stdbool.h> #include <stdbool.h>
//allows the boolean type to be overridden (example could be overriding for opengl booleans)
#ifndef ARC_BOOL_OVERRIDE
#define ARC_Bool bool #define ARC_Bool bool
#define ARC_True true #define ARC_True true
#define ARC_False false #define ARC_False false
#endif
#ifdef __cplusplus #ifdef __cplusplus
} }
#endif #endif

8
include/arc/std/lexer.h
View file

@ -243,6 +243,7 @@ ARC_LexerTokenRule ARC_LexerTokenRule_CreateAndReturnMatchStringRule(uint32_t id
ARC_LexerTokenRule ARC_LexerTokenRule_CreateAndReturnMatchCharInStringRule(uint32_t id, ARC_String *string); ARC_LexerTokenRule ARC_LexerTokenRule_CreateAndReturnMatchCharInStringRule(uint32_t id, ARC_String *string);
/** /**
* @{
* @brief basic tokens * @brief basic tokens
*/ */
#define ARC_LEXER_TOKEN_NULL 0 #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_LOWER_CHAR 2
#define ARC_LEXER_TOKEN_ALPHA_UPPER_CHAR 3 #define ARC_LEXER_TOKEN_ALPHA_UPPER_CHAR 3
#define ARC_LEXER_TOKEN_WHITESPACE 4 #define ARC_LEXER_TOKEN_WHITESPACE 4
/**
* @}
*/
/** /**
* @{
* @brief basic token type ids, chars, and tags * @brief basic token type ids, chars, and tags
*/ */
#define ARC_LEXER_TOKEN_NEWLINE_ID 5 #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_ID 19
#define ARC_LEXER_TOKEN_PERCENT_CHAR '%' #define ARC_LEXER_TOKEN_PERCENT_CHAR '%'
#define ARC_LEXER_TOKEN_PERCENT_TAG "PERCENT" #define ARC_LEXER_TOKEN_PERCENT_TAG "PERCENT"
/**
* @}
*/
/** /**
* @brief adds a bunch of basic token rules (matching the BasicTokens above) * @brief adds a bunch of basic token rules (matching the BasicTokens above)