Update class descriptions
This commit is contained in:
parent
5e9ef226d6
commit
6c8fc29c28
4 changed files with 11 additions and 15 deletions
|
@ -15,9 +15,9 @@
|
|||
# You should have received a copy of the GNU Affero General Public License
|
||||
# along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||
|
||||
## 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
|
||||
|
|
|
@ -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
|
||||
|
|
|
@ -15,11 +15,11 @@
|
|||
# You should have received a copy of the GNU Affero General Public License
|
||||
# along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||
|
||||
## 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
|
||||
|
|
|
@ -15,15 +15,13 @@
|
|||
# You should have received a copy of the GNU Affero General Public License
|
||||
# along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||
|
||||
## 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 }
|
||||
|
|
Loading…
Reference in a new issue