From 6c8fc29c2822b6c528a51b74ad049dfeb6b76ad3 Mon Sep 17 00:00:00 2001 From: JeremyStarTM Date: Sun, 31 Mar 2024 17:59:11 +0200 Subject: [PATCH] Update class descriptions --- src/classes/basemodule.gd | 6 +++--- src/classes/config.gd | 4 +--- src/classes/loggerinstance.gd | 10 +++++----- src/classes/types.gd | 6 ++---- 4 files changed, 11 insertions(+), 15 deletions(-) diff --git a/src/classes/basemodule.gd b/src/classes/basemodule.gd index 7994ae2..947e828 100644 --- a/src/classes/basemodule.gd +++ b/src/classes/basemodule.gd @@ -15,9 +15,9 @@ # You should have received a copy of the GNU Affero General Public License # along with this program. If not, see . -## Template for CORE modules. -## -## Provides a basic template and a common foundation for building CORE modules. +## Template for CORE modules.[br] +## [br] +## Provides a basic template and a common foundation for building CORE modules.[br] ## It provides common functions and variables used in all CORE modules. extends Node class_name CoreBaseModule diff --git a/src/classes/config.gd b/src/classes/config.gd index b69f180..af3dc96 100644 --- a/src/classes/config.gd +++ b/src/classes/config.gd @@ -2,9 +2,7 @@ # Copyright (c) 2024 The StarOpenSource Project & Contributors # Licensed in the Public Domain -## The default configuration file for the CORE Framework. -## -## The [code]CoreConfiguration[/code] class holds the Framework's settings. +## The [code]CoreConfiguration[/code] class holds the Framework's settings.[br] ## The default configuration is designed to be usable without any modification. extends Node class_name CoreConfiguration diff --git a/src/classes/loggerinstance.gd b/src/classes/loggerinstance.gd index af07884..70a1639 100644 --- a/src/classes/loggerinstance.gd +++ b/src/classes/loggerinstance.gd @@ -15,11 +15,11 @@ # You should have received a copy of the GNU Affero General Public License # along with this program. If not, see . -## Passes [code]origin[/code] for you. -## -## Pretty much a wrapper around CORE's logging implementation. -## CoreLoggerInstance's only job is to save you some effort aka. -## you not needing to pass the [code]origin[/code] argument to each +## Passes [code]origin[/code] for you.[br] +## [br] +## Pretty much a wrapper around CORE's logging implementation.[br] +## CoreLoggerInstance's only job is to save you some effort aka.[br] +## you not needing to pass the [code]origin[/code] argument to each[br] ## and every log call, which is extremely annoying. Thank us later ;) extends Node class_name CoreLoggerInstance diff --git a/src/classes/types.gd b/src/classes/types.gd index 5595f83..9d6c1e9 100644 --- a/src/classes/types.gd +++ b/src/classes/types.gd @@ -15,15 +15,13 @@ # You should have received a copy of the GNU Affero General Public License # along with this program. If not, see . -## Types and enums for the CORE Framework. -## ## Contains enums and types shared across the CORE Framework. extends Node class_name CoreTypes -## Available version types, following the StarOpenSource Versioning Specification (SOSVS) v1 +## Available version types, following the StarOpenSource Versioning Specification (SOSVS) version 1 enum VersionType { RELEASE, RELEASECANDIDATE, BETA, ALPHA } -## Available log levels, followingthe StarOpenSource Logging Specification (SOSLS) v1 +## Available log levels, followingthe StarOpenSource Logging Specification (SOSLS) version 1 enum LoggerLevel { NONE, ERROR, WARN, INFO, VERB, DIAG } ## Available scene types enum SceneType { NONE, DEBUG, CUTSCENE, MENU, MAIN, BACKGROUND }