From fdf09f8c8e9428a8c071d7e0d99a21810bdd2567 Mon Sep 17 00:00:00 2001 From: JeremyStarTM Date: Sat, 4 May 2024 12:39:19 +0200 Subject: [PATCH] Update CoreTypes online documentation --- docs/docs/reference/coretypes.md | 20 ------------ docs/docs/reference/types.md | 56 ++++++++++++++++++++++++++++++++ 2 files changed, 56 insertions(+), 20 deletions(-) delete mode 100644 docs/docs/reference/coretypes.md create mode 100644 docs/docs/reference/types.md diff --git a/docs/docs/reference/coretypes.md b/docs/docs/reference/coretypes.md deleted file mode 100644 index 87942dc..0000000 --- a/docs/docs/reference/coretypes.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -sidebar_position: 2 -description: Contains various enums. ---- - -# `CoreTypes` -Contains globaly accessible custom enums and types used throughout the CORE Framework's source code. - - -## Enums -### VersionType{ RELEASE, RELEASECANDIDATE, BETA, ALPHA } -Available version types, following the StarOpenSource Versioning Specification (SOSVS) version 1. -### LoggerLevel{ NONE, ERROR, WARN, INFO, VERB, DIAG } -Available log levels, followingthe StarOpenSource Logging Specification (SOSLS) version 1. -### SceneType{ NONE, DEBUG, CUTSCENE, MENU, MAIN, BACKGROUND } -Available scene types. -### BlockadeLevel{ IGNORE, WARN, BLOCK } -To what degree *something* should be blocked. -### ValidationType{ MATCHES_TYPE, MATCHES_CLASS, IN_RANGE, HAS_MINIMUM, HAS_MAXIMUM, HAS_VALUES, CONTAINS, MATCHES_REGEX, IS_NOT_EMPTY, IS_NOT_NULL, IS_NORMALIZED, IS_ORTHONORMALIZED } -All validation rules some data can be checked against. diff --git a/docs/docs/reference/types.md b/docs/docs/reference/types.md new file mode 100644 index 0000000..28d1184 --- /dev/null +++ b/docs/docs/reference/types.md @@ -0,0 +1,56 @@ +--- +sidebar_position: 2 +description: Contains various enums. +--- + +# `CoreTypes` +Contains globaly accessible custom enums and types used throughout the CORE Framework's source code. + + +## Enums +### VersionType +Available version types, following the StarOpenSource Versioning Specification (SOSVS) version 1. +#### Available values +- RELEASE +- RELEASECANDIDATE +- BETA +- ALPHA +### LoggerLevel +Available log levels, following the StarOpenSource Logging Specification (SOSLS) version 1. +#### Available values +- NONE +- ERROR +- WARN +- INFO +- VERB +- DIAG +### SceneType +Available scene types. +### Available values +- NONE +- DEBUG +- CUTSCENE +- MENU +- MAIN +- BACKGROUND +### BlockadeLevel +To what degree *something* should be blocked. +#### Available values +- IGNORE +- WARN +- BLOCK +### ValidationType +All validation rules some data can be checked against. +#### Available values +- MATCHES_TYPE +- MATCHES_CLASS +- IN_RANGE +- HAS_MINIMUM +- HAS_MAXIMUM +- HAS_VALUES +- CONTAINS +- MATCHES_REGEX +- IS_NOT_EMPTY +- IS_NOT_NULL +- IS_NORMALIZED +- IS_ORTHONORMALIZED