go back to normal comments since the vscode addon does not parse them properly

Author: Qubus0

addons/mod_loader/mod_data.gd

@@ -1,41 +1,41 @@
 extends Resource
 class_name ModData
 
-## Stores and validates all Data required to load a mod successfully
-## If some of the data is invalid, [member is_loadable] will be false
+# Stores and validates all Data required to load a mod successfully
+# If some of the data is invalid, [member is_loadable] will be false
 
 const LOG_NAME := "ModLoader:ModData"
 
-## These 2 files are always required by mods.
-## [i]mod_main.gd[/i] = The main init file for the mod
-## [i]manifest.json[/i] = Meta data for the mod, including its dependencies
+# These 2 files are always required by mods.
+# [i]mod_main.gd[/i] = The main init file for the mod
+# [i]manifest.json[/i] = Meta data for the mod, including its dependencies
 enum required_mod_files {
 	MOD_MAIN,
 	MANIFEST,
 }
 
-## Directory of the mod. Has to be identical to [method ModManifest.get_mod_id]
+# Directory of the mod. Has to be identical to [method ModManifest.get_mod_id]
 var dir_name := ""
-## Path to the Mod's Directory
+# Path to the Mod's Directory
 var dir_path := ""
-## False if any data is invalid
+# False if any data is invalid
 var is_loadable := true
-## Is increased for every mod depending on this mod. Highest importance is loaded first
+# Is increased for every mod depending on this mod. Highest importance is loaded first
 var importance := 0
-## Contents of the manifest
+# Contents of the manifest
 var manifest: ModManifest
-## Updated in _load_mod_configs
+# Updated in _load_mod_configs
 var config := {}
 
-## only set if DEBUG_ENABLE_STORING_FILEPATHS is enabled
+# only set if DEBUG_ENABLE_STORING_FILEPATHS is enabled
 var file_paths := []
 
 
 func _init(_dir_path: String) -> void:
 	dir_path = _dir_path
 
 
-## Load meta data from a mod's manifest.json file
+# Load meta data from a mod's manifest.json file
 func load_manifest() -> void:
 	if not has_required_files():
 		return
@@ -57,7 +57,7 @@ func load_manifest() -> void:
 	manifest = mod_manifest
 
 
-## Validates if [member dir_name] matches [method ModManifest.get_mod_id]
+# Validates if [member dir_name] matches [method ModManifest.get_mod_id]
 func is_mod_dir_name_same_as_id() -> bool:
 	var manifest_id = manifest.get_mod_id()
 	if dir_name != manifest_id:
@@ -67,7 +67,7 @@ func is_mod_dir_name_same_as_id() -> bool:
 	return true
 
 
-## Confirms that all files from [member required_mod_files] exist
+# Confirms that all files from [member required_mod_files] exist
 func has_required_files() -> bool:
 	var file_check = File.new()
 
@@ -80,12 +80,12 @@ func has_required_files() -> bool:
 	return is_loadable
 
 
-## Validates if manifest is set
+# Validates if manifest is set
 func has_manifest() -> bool:
 	return not manifest == null
 
 
-## Converts enum indices [member required_mod_files] into their respective file paths
+# Converts enum indices [member required_mod_files] into their respective file paths
 func get_required_mod_file_path(required_file: int) -> String:
 	match required_file:
 		required_mod_files.MOD_MAIN:
@@ -95,8 +95,8 @@ func get_required_mod_file_path(required_file: int) -> String:
 	return ""
 
 
-## Parses JSON from a given file path and returns a dictionary.
-## Returns an empty dictionary if no file exists (check with size() < 1)
+# Parses JSON from a given file path and returns a dictionary.
+# Returns an empty dictionary if no file exists (check with size() < 1)
 static func _get_json_as_dict(path:String) -> Dictionary: # todo move to utils
 	var file = File.new()
 

addons/mod_loader/mod_manifest.gd

@@ -1,33 +1,33 @@
 extends Resource
-## Stores and validates contents of the manifest set by the user
+# Stores and validates contents of the manifest set by the user
 class_name ModManifest
 
 
-## Mod name.
-## Validated by [method is_name_or_namespace_valid]
+# Mod name.
+# Validated by [method is_name_or_namespace_valid]
 var name := ""
-## Mod namespace, most commonly the main author.
-## Validated by [method is_name_or_namespace_valid]
+# Mod namespace, most commonly the main author.
+# Validated by [method is_name_or_namespace_valid]
 var namespace := ""
-## Semantic version. Not a number, but required to be named like this by Thunderstore
-## Validated by [method is_semver_valid]
+# Semantic version. Not a number, but required to be named like this by Thunderstore
+# Validated by [method is_semver_valid]
 var version_number := "0.0.0"
 var description := ""
 var website_url := ""
-## Used to determine mod load order
+# Used to determine mod load order
 var dependencies := []				# Array[String]
 
 var authors := [] 					# Array[String]
-## only used for information
+# only used for information
 var compatible_game_version := [] 	# Array[String]
-## only used for information
+# only used for information
 var incompatibilities := [] 			# Array[String]
 var tags := [] 						# Array[String]
 var description_rich := ""
 var image: StreamTexture
 
 
-## Required keys in a mod's manifest.json file
+# Required keys in a mod's manifest.json file
 const REQUIRED_MANIFEST_KEYS_ROOT = [
 	"name",
 	"namespace",
@@ -38,7 +38,7 @@ const REQUIRED_MANIFEST_KEYS_ROOT = [
 	"extra",
 ]
 
-## Required keys in manifest's `json.extra.godot`
+# Required keys in manifest's `json.extra.godot`
 const REQUIRED_MANIFEST_KEYS_EXTRA = [
 	"authors",
 	"compatible_mod_loader_version",
@@ -48,8 +48,8 @@ const REQUIRED_MANIFEST_KEYS_EXTRA = [
 ]
 
 
-## Takes the manifest as [Dictionary] and validates everything.
-## Will return null if something is invalid.
+# Takes the manifest as [Dictionary] and validates everything.
+# Will return null if something is invalid.
 func _init(manifest: Dictionary) -> void:
 	if (not dict_has_fields(manifest, REQUIRED_MANIFEST_KEYS_ROOT) or
 		not dict_has_fields(manifest.extra, ["godot"]) or
@@ -79,21 +79,21 @@ func _init(manifest: Dictionary) -> void:
 #	image StreamTexture
 
 
-## Mod ID used in the mod loader
-## Format: {namespace}-{name}
+# Mod ID used in the mod loader
+# Format: {namespace}-{name}
 func get_mod_id() -> String:
 	return "%s-%s" % [namespace, name]
 
 
-## Package ID used by Thunderstore
-## Format: {namespace}-{name}-{version_number}
+# Package ID used by Thunderstore
+# Format: {namespace}-{name}-{version_number}
 func get_package_id() -> String:
 	return "%s-%s-%s" % [namespace, name, version_number]
 
 
-## A valid namespace may only use letters (any case), numbers and underscores
-## and has to be longer than 3 characters
-## /^[a-zA-Z0-9_]{3,}$/
+# A valid namespace may only use letters (any case), numbers and underscores
+# and has to be longer than 3 characters
+# /^[a-zA-Z0-9_]{3,}$/
 static func is_name_or_namespace_valid(name: String) -> bool:
 	var re := RegEx.new()
 	re.compile("^[a-zA-Z0-9_]*$") # alphanumeric and _
@@ -110,9 +110,9 @@ static func is_name_or_namespace_valid(name: String) -> bool:
 	return true
 
 
-## A valid semantic version should follow this format: {mayor}.{minor}.{patch}
-## reference https://semver.org/ for details
-## /^[0-9]+\\.[0-9]+\\.[0-9]+$/
+# A valid semantic version should follow this format: {mayor}.{minor}.{patch}
+# reference https://semver.org/ for details
+# /^[0-9]+\\.[0-9]+\\.[0-9]+$/
 static func is_semver_valid(version_number: String) -> bool:
 	var re := RegEx.new()
 	re.compile("^[0-9]+\\.[0-9]+\\.[0-9]+$")
@@ -125,22 +125,22 @@ static func is_semver_valid(version_number: String) -> bool:
 	return true
 
 
-## Returns an empty String if the key does not exist
+# Returns an empty String if the key does not exist
 static func _get_string_from_dict(dict: Dictionary, key: String) -> String:
 	if not dict.has(key):
 		return ""
 	return dict[key]
 
 
-## Returns an empty Array if the key does not exist
+# Returns an empty Array if the key does not exist
 static func _get_array_from_dict(dict: Dictionary, key: String) -> Array:
 	if not dict.has(key):
 		return []
 	return dict[key]
 
 
-## Works like [method Dictionary.has_all],
-## but allows for more specific errors if a field is missing
+# Works like [method Dictionary.has_all],
+# but allows for more specific errors if a field is missing
 static func dict_has_fields(dict: Dictionary, required_fields: Array) -> bool:
 	var missing_fields := required_fields