From a613b0d9155f86c25c7ed83b029c95c69cd6689e Mon Sep 17 00:00:00 2001 From: "Cyril B." <53737317+Cykyrios@users.noreply.github.com> Date: Wed, 9 Jul 2025 10:55:20 +0200 Subject: [PATCH] Use admonition tags in doc comments --- src/modules/gis_module.gd | 64 +++++++++++++++++++-------------------- 1 file changed, 32 insertions(+), 32 deletions(-) diff --git a/src/modules/gis_module.gd b/src/modules/gis_module.gd index 0a14227..85906dd 100644 --- a/src/modules/gis_module.gd +++ b/src/modules/gis_module.gd @@ -601,8 +601,8 @@ func save_config() -> void: #region GodotInSim wrappers ## Adds an [InSimButton] for the given [param ucids], or everyone if [param ucids] is empty. ## See [method InSim.add_button] for more details.[br] -## [b]Note:[/b] You should use this method instead of its [InSim] counterpart, as it allows -## other modules to know who sent the corresponding packets. +## [note]You should use this method instead of its [InSim] counterpart, as it allows +## other modules to know who sent the corresponding packets.[/note] func add_button( ucids: Array[int], button_position: Vector2i, button_size: Vector2i, style: int, text: Variant, button_name := "", type_in := 0, caption := "", show_everywhere := false, @@ -614,8 +614,8 @@ func add_button( ## Adds a global [InSimButton]. See [method InSim.add_global_button] for more details.[br] -## [b]Note:[/b] You should use this method instead of its [InSim] counterpart, as it allows -## other modules to know who sent the corresponding packets. +## [note]You should use this method instead of its [InSim] counterpart, as it allows +## other modules to know who sent the corresponding packets.[/note] func add_global_button( button_position: Vector2i, button_size: Vector2i, style: int, text: Variant, button_name := "", type_in := 0, caption := "", show_everywhere := false, @@ -628,88 +628,88 @@ func add_global_button( ## Deletes one or more buttons based on their [param click_id], for the given [param ucids]. ## See [method InSim.delete_buttons_by_id] for more details.[br] -## [b]Note:[/b] You should use this method instead of its [InSim] counterpart, as it allows -## other modules to know who sent the corresponding packets. +## [note]You should use this method instead of its [InSim] counterpart, as it allows +## other modules to know who sent the corresponding packets.[/note] func delete_buttons_by_id(ucids: Array[int], click_id: int, max_id := 0) -> void: hub_insim.delete_buttons_by_id(ucids, click_id, max_id, _module_name) ## Deletes one or more buttons based on their [param button_name], for the given [param ucids]. ## See [method InSim.delete_buttons_by_name] for more details.[br] -## [b]Note:[/b] You should use this method instead of its [InSim] counterpart, as it allows -## other modules to know who sent the corresponding packets. +## [note]You should use this method instead of its [InSim] counterpart, as it allows +## other modules to know who sent the corresponding packets.[/note] func delete_buttons_by_name(ucids: Array[int], button_name: StringName) -> void: hub_insim.delete_buttons_by_name(ucids, button_name, _module_name) ## Deletes one or more buttons based on their [param prefix], for the given [param ucids]. ## See [method InSim.delete_buttons_by_prefix] for more details.[br] -## [b]Note:[/b] You should use this method instead of its [InSim] counterpart, as it allows -## other modules to know who sent the corresponding packets. +## [note]You should use this method instead of its [InSim] counterpart, as it allows +## other modules to know who sent the corresponding packets.[/note] func delete_buttons_by_prefix(ucids: Array[int], prefix: StringName) -> void: hub_insim.delete_buttons_by_prefix(ucids, prefix, _module_name) ## Deletes one or more buttons based on the given [param regex], for the given [param ucids]. ## See [method InSim.delete_buttons_by_regex] for more details.[br] -## [b]Note:[/b] You should use this method instead of its [InSim] counterpart, as it allows -## other modules to know who sent the corresponding packets. +## [note]You should use this method instead of its [InSim] counterpart, as it allows +## other modules to know who sent the corresponding packets.[/note] func delete_buttons_by_regex(ucids: Array[int], regex: RegEx) -> void: hub_insim.delete_buttons_by_regex(ucids, regex, _module_name) ## Deletes a global button based on its [param id]. See [method InSim.delete_global_button_by_id] ## for more details.[br] -## [b]Note:[/b] You should use this method instead of its [InSim] counterpart, as it allows -## other modules to know who sent the corresponding packets. +## [note]You should use this method instead of its [InSim] counterpart, as it allows +## other modules to know who sent the corresponding packets.[/note] func delete_global_button_by_id(id: int) -> void: hub_insim.delete_global_button_by_id(id, _module_name) ## Deletes a global button based on its [param button_name]. See ## [method InSim.delete_global_button_by_name] for more details.[br] -## [b]Note:[/b] You should use this method instead of its [InSim] counterpart, as it allows -## other modules to know who sent the corresponding packets. +## [note]You should use this method instead of its [InSim] counterpart, as it allows +## other modules to know who sent the corresponding packets.[/note] func delete_global_button_by_name(button_name: StringName) -> void: hub_insim.delete_global_button_by_name(button_name, _module_name) ## Deletes one or more global buttons based on their [param prefix]. See ## [method InSim.delete_global_buttons_by_prefix] for more details.[br] -## [b]Note:[/b] You should use this method instead of its [InSim] counterpart, as it allows -## other modules to know who sent the corresponding packets. +## [note]You should use this method instead of its [InSim] counterpart, as it allows +## other modules to know who sent the corresponding packets.[/note] func delete_global_buttons_by_prefix(prefix: StringName) -> void: hub_insim.delete_global_buttons_by_prefix(prefix, _module_name) ## Deletes one or more global buttons based on the given [param regex]. See ## [method InSim.delete_global_buttons_by_regex] for more details.[br] -## [b]Note:[/b] You should use this method instead of its [InSim] counterpart, as it allows -## other modules to know who sent the corresponding packets. +## [note]You should use this method instead of its [InSim] counterpart, as it allows +## other modules to know who sent the corresponding packets.[/note] func delete_global_buttons_by_regex(regex: RegEx) -> void: hub_insim.delete_global_buttons_by_regex(regex, _module_name) ## Sends a UTF8-formatted text string to LFS as a local message. See ## [method InSim.send_local_message] for more details.[br] -## [b]Note:[/b] You should use this method instead of its [InSim] counterpart, as it allows -## other modules to know who sent the corresponding packets. +## [note]You should use this method instead of its [InSim] counterpart, as it allows +## other modules to know who sent the corresponding packets.[/note] func send_local_message(message: String, sound := InSim.MessageSound.SND_SILENT) -> void: hub_insim.send_local_message(message, sound, _module_name) ## Sends a UTF8-formatted message to LFS as user. See [method InSim.send_message] ## for more details.[br] -## [b]Note:[/b] You should use this method instead of its [InSim] counterpart, as it allows -## other modules to know who sent the corresponding packets. +## [note]You should use this method instead of its [InSim] counterpart, as it allows +## other modules to know who sent the corresponding packets.[/note] func send_message(message: String) -> void: hub_insim.send_message(message, _module_name) ## Sends a UTF8-formatted message to a specific connection, identified by its [param ucid]. ## See [method InSim.send_message_to_connection] for more details.[br] -## [b]Note:[/b] You should use this method instead of its [InSim] counterpart, as it allows -## other modules to know who sent the corresponding packets. +## [note]You should use this method instead of its [InSim] counterpart, as it allows +## other modules to know who sent the corresponding packets.[/note] func send_message_to_connection( ucid: int, message: String, sound := InSim.MessageSound.SND_SILENT ) -> void: @@ -718,8 +718,8 @@ func send_message_to_connection( ## Sends a UTF8-formatted message to a specific player, identified by their [param plid]. ## See [method InSim.send_message_to_player] for more details.[br] -## [b]Note:[/b] You should use this method instead of its [InSim] counterpart, as it allows -## other modules to know who sent the corresponding packets. +## [note]You should use this method instead of its [InSim] counterpart, as it allows +## other modules to know who sent the corresponding packets.[/note] func send_message_to_player( plid: int, message: String, sound := InSim.MessageSound.SND_SILENT ) -> void: @@ -727,16 +727,16 @@ func send_message_to_player( ## Sends an [InSimPacket] to LFS. See [method InSim.send_packet] for more details.[br] -## [b]Note:[/b] You should use this method instead of its [InSim] counterpart, as it allows -## other modules to know who sent the corresponding packets. +## [note]You should use this method instead of its [InSim] counterpart, as it allows +## other modules to know who sent the corresponding packets.[/note] func send_packet(packet: InSimPacket) -> void: packet_sent.emit(packet, _module_name) ## Sends all of the given [param packets] to LFS. See [method InSim.send_packets] ## for more details.[br] -## [b]Note:[/b] You should use this method instead of its [InSim] counterpart, as it allows -## other modules to know who sent the corresponding packets. +## [note]You should use this method instead of its [InSim] counterpart, as it allows +## other modules to know who sent the corresponding packets.[/note] func send_packets(packets: Array[InSimPacket]) -> void: for packet in packets: packet_sent.emit(packet, _module_name) -- GitLab