Merge pull request #107130 from timothyqiu/pure-virtual

Doc: Add "required" qualifier to methods

Author: akien-mga

core/doc_data.cpp

@@ -127,6 +127,13 @@ void DocData::method_doc_from_methodinfo(DocData::MethodDoc &p_method, const Met
 		p_method.qualifiers = "virtual";
 	}
 
+	if (p_methodinfo.flags & METHOD_FLAG_VIRTUAL_REQUIRED) {
+		if (!p_method.qualifiers.is_empty()) {
+			p_method.qualifiers += " ";
+		}
+		p_method.qualifiers += "required";
+	}
+
 	if (p_methodinfo.flags & METHOD_FLAG_CONST) {
 		if (!p_method.qualifiers.is_empty()) {
 			p_method.qualifiers += " ";

doc/classes/AnimationNodeExtension.xml

@@ -9,7 +9,7 @@
 	<tutorials>
 	</tutorials>
 	<methods>
-		<method name="_process_animation_node" qualifiers="virtual">
+		<method name="_process_animation_node" qualifiers="virtual required">
 			<return type="PackedFloat32Array" />
 			<param index="0" name="playback_info" type="PackedFloat64Array" />
 			<param index="1" name="test_only" type="bool" />

doc/classes/AudioEffect.xml

@@ -12,7 +12,7 @@
 		<link title="Audio Microphone Record Demo">https://godotengine.org/asset-library/asset/2760</link>
 	</tutorials>
 	<methods>
-		<method name="_instantiate" qualifiers="virtual">
+		<method name="_instantiate" qualifiers="virtual required">
 			<return type="AudioEffectInstance" />
 			<description>
 				Override this method to customize the [AudioEffectInstance] created when this effect is applied on a bus in the editor's Audio panel, or through [method AudioServer.add_bus_effect].

doc/classes/AudioEffectInstance.xml

@@ -10,7 +10,7 @@
 		<link title="Audio buses">$DOCS_URL/tutorials/audio/audio_buses.html</link>
 	</tutorials>
 	<methods>
-		<method name="_process" qualifiers="virtual">
+		<method name="_process" qualifiers="virtual required">
 			<return type="void" />
 			<param index="0" name="src_buffer" type="const void*" />
 			<param index="1" name="dst_buffer" type="AudioFrame*" />

doc/classes/AudioStreamPlayback.xml

@@ -35,7 +35,7 @@
 				Overridable method. Should return [code]true[/code] if this playback is active and playing its audio stream.
 			</description>
 		</method>
-		<method name="_mix" qualifiers="virtual">
+		<method name="_mix" qualifiers="virtual required">
 			<return type="int" />
 			<param index="0" name="buffer" type="AudioFrame*" />
 			<param index="1" name="rate_scale" type="float" />

doc/classes/AudioStreamPlaybackResampled.xml

@@ -7,12 +7,12 @@
 	<tutorials>
 	</tutorials>
 	<methods>
-		<method name="_get_stream_sampling_rate" qualifiers="virtual const">
+		<method name="_get_stream_sampling_rate" qualifiers="virtual required const">
 			<return type="float" />
 			<description>
 			</description>
 		</method>
-		<method name="_mix_resampled" qualifiers="virtual">
+		<method name="_mix_resampled" qualifiers="virtual required">
 			<return type="int" />
 			<param index="0" name="dst_buffer" type="AudioFrame*" />
 			<param index="1" name="frame_count" type="int" />

doc/classes/EditorExportPlatformExtension.xml

@@ -15,15 +15,13 @@
 			<param index="0" name="preset" type="EditorExportPreset" />
 			<param index="1" name="debug" type="bool" />
 			<description>
-				[b]Optional.[/b]
 				Returns [code]true[/code], if specified [param preset] is valid and can be exported. Use [method set_config_error] and [method set_config_missing_templates] to set error details.
 				Usual implementation can call [method _has_valid_export_configuration] and [method _has_valid_project_configuration] to determine if export is possible.
 			</description>
 		</method>
 		<method name="_cleanup" qualifiers="virtual">
 			<return type="void" />
 			<description>
-				[b]Optional.[/b]
 				Called by the editor before platform is unregistered.
 			</description>
 		</method>
@@ -34,7 +32,6 @@
 			<param index="2" name="path" type="String" />
 			<param index="3" name="flags" type="int" enum="EditorExportPlatform.DebugFlags" is_bitfield="true" />
 			<description>
-				[b]Optional.[/b]
 				Creates a PCK archive at [param path] for the specified [param preset].
 				This method is called when "Export PCK/ZIP" button is pressed in the export dialog, with "Export as Patch" disabled, and PCK is selected as a file type.
 			</description>
@@ -47,20 +44,18 @@
 			<param index="3" name="patches" type="PackedStringArray" />
 			<param index="4" name="flags" type="int" enum="EditorExportPlatform.DebugFlags" is_bitfield="true" />
 			<description>
-				[b]Optional.[/b]
 				Creates a patch PCK archive at [param path] for the specified [param preset], containing only the files that have changed since the last patch.
 				This method is called when "Export PCK/ZIP" button is pressed in the export dialog, with "Export as Patch" enabled, and PCK is selected as a file type.
 				[b]Note:[/b] The patches provided in [param patches] have already been loaded when this method is called and are merely provided as context. When empty the patches defined in the export preset have been loaded instead.
 			</description>
 		</method>
-		<method name="_export_project" qualifiers="virtual">
+		<method name="_export_project" qualifiers="virtual required">
 			<return type="int" enum="Error" />
 			<param index="0" name="preset" type="EditorExportPreset" />
 			<param index="1" name="debug" type="bool" />
 			<param index="2" name="path" type="String" />
 			<param index="3" name="flags" type="int" enum="EditorExportPlatform.DebugFlags" is_bitfield="true" />
 			<description>
-				[b]Required.[/b]
 				Creates a full project at [param path] for the specified [param preset].
 				This method is called when "Export" button is pressed in the export dialog.
 				This method implementation can call [method EditorExportPlatform.save_pack] or [method EditorExportPlatform.save_zip] to use default PCK/ZIP export process, or calls [method EditorExportPlatform.export_project_files] and implement custom callback for processing each exported file.
@@ -73,7 +68,6 @@
 			<param index="2" name="path" type="String" />
 			<param index="3" name="flags" type="int" enum="EditorExportPlatform.DebugFlags" is_bitfield="true" />
 			<description>
-				[b]Optional.[/b]
 				Create a ZIP archive at [param path] for the specified [param preset].
 				This method is called when "Export PCK/ZIP" button is pressed in the export dialog, with "Export as Patch" disabled, and ZIP is selected as a file type.
 			</description>
@@ -86,32 +80,28 @@
 			<param index="3" name="patches" type="PackedStringArray" />
 			<param index="4" name="flags" type="int" enum="EditorExportPlatform.DebugFlags" is_bitfield="true" />
 			<description>
-				[b]Optional.[/b]
 				Create a ZIP archive at [param path] for the specified [param preset], containing only the files that have changed since the last patch.
 				This method is called when "Export PCK/ZIP" button is pressed in the export dialog, with "Export as Patch" enabled, and ZIP is selected as a file type.
 				[b]Note:[/b] The patches provided in [param patches] have already been loaded when this method is called and are merely provided as context. When empty the patches defined in the export preset have been loaded instead.
 			</description>
 		</method>
-		<method name="_get_binary_extensions" qualifiers="virtual const">
+		<method name="_get_binary_extensions" qualifiers="virtual required const">
 			<return type="PackedStringArray" />
 			<param index="0" name="preset" type="EditorExportPreset" />
 			<description>
-				[b]Required.[/b]
 				Returns array of supported binary extensions for the full project export.
 			</description>
 		</method>
 		<method name="_get_debug_protocol" qualifiers="virtual const">
 			<return type="String" />
 			<description>
-				[b]Optional.[/b]
 				Returns protocol used for remote debugging. Default implementation return [code]tcp://[/code].
 			</description>
 		</method>
 		<method name="_get_device_architecture" qualifiers="virtual const">
 			<return type="String" />
 			<param index="0" name="device" type="int" />
 			<description>
-				[b]Optional.[/b]
 				Returns device architecture for one-click deploy.
 			</description>
 		</method>
@@ -120,7 +110,6 @@
 			<param index="0" name="preset" type="EditorExportPreset" />
 			<param index="1" name="option" type="String" />
 			<description>
-				[b]Optional.[/b]
 				Validates [param option] and returns visibility for the specified [param preset]. Default implementation return [code]true[/code] for all options.
 			</description>
 		</method>
@@ -129,14 +118,12 @@
 			<param index="0" name="preset" type="EditorExportPreset" />
 			<param index="1" name="option" type="StringName" />
 			<description>
-				[b]Optional.[/b]
 				Validates [param option] and returns warning message for the specified [param preset]. Default implementation return empty string for all options.
 			</description>
 		</method>
 		<method name="_get_export_options" qualifiers="virtual const">
 			<return type="Dictionary[]" />
 			<description>
-				[b]Optional.[/b]
 				Returns a property list, as an [Array] of dictionaries. Each [Dictionary] must at least contain the [code]name: StringName[/code] and [code]type: Variant.Type[/code] entries.
 				Additionally, the following keys are supported:
 				- [code]hint: PropertyHint[/code]
@@ -149,116 +136,101 @@
 				See also [method Object._get_property_list].
 			</description>
 		</method>
-		<method name="_get_logo" qualifiers="virtual const">
+		<method name="_get_logo" qualifiers="virtual required const">
 			<return type="Texture2D" />
 			<description>
-				[b]Required.[/b]
 				Returns platform logo displayed in the export dialog, logo should be 32x32 adjusted to the current editor scale, see [method EditorInterface.get_editor_scale].
 			</description>
 		</method>
-		<method name="_get_name" qualifiers="virtual const">
+		<method name="_get_name" qualifiers="virtual required const">
 			<return type="String" />
 			<description>
-				[b]Required.[/b]
 				Returns export platform name.
 			</description>
 		</method>
 		<method name="_get_option_icon" qualifiers="virtual const">
 			<return type="ImageTexture" />
 			<param index="0" name="device" type="int" />
 			<description>
-				[b]Optional.[/b]
 				Returns one-click deploy menu item icon for the specified [param device], icon should be 16x16 adjusted to the current editor scale, see [method EditorInterface.get_editor_scale].
 			</description>
 		</method>
 		<method name="_get_option_label" qualifiers="virtual const">
 			<return type="String" />
 			<param index="0" name="device" type="int" />
 			<description>
-				[b]Optional.[/b]
 				Returns one-click deploy menu item label for the specified [param device].
 			</description>
 		</method>
 		<method name="_get_option_tooltip" qualifiers="virtual const">
 			<return type="String" />
 			<param index="0" name="device" type="int" />
 			<description>
-				[b]Optional.[/b]
 				Returns one-click deploy menu item tooltip for the specified [param device].
 			</description>
 		</method>
 		<method name="_get_options_count" qualifiers="virtual const">
 			<return type="int" />
 			<description>
-				[b]Optional.[/b]
 				Returns number one-click deploy devices (or other one-click option displayed in the menu).
 			</description>
 		</method>
 		<method name="_get_options_tooltip" qualifiers="virtual const">
 			<return type="String" />
 			<description>
-				[b]Optional.[/b]
 				Returns tooltip of the one-click deploy menu button.
 			</description>
 		</method>
-		<method name="_get_os_name" qualifiers="virtual const">
+		<method name="_get_os_name" qualifiers="virtual required const">
 			<return type="String" />
 			<description>
-				[b]Required.[/b]
 				Returns target OS name.
 			</description>
 		</method>
-		<method name="_get_platform_features" qualifiers="virtual const">
+		<method name="_get_platform_features" qualifiers="virtual required const">
 			<return type="PackedStringArray" />
 			<description>
-				[b]Required.[/b]
 				Returns array of platform specific features.
 			</description>
 		</method>
-		<method name="_get_preset_features" qualifiers="virtual const">
+		<method name="_get_preset_features" qualifiers="virtual required const">
 			<return type="PackedStringArray" />
 			<param index="0" name="preset" type="EditorExportPreset" />
 			<description>
-				[b]Required.[/b]
 				Returns array of platform specific features for the specified [param preset].
 			</description>
 		</method>
 		<method name="_get_run_icon" qualifiers="virtual const">
 			<return type="Texture2D" />
 			<description>
-				[b]Optional.[/b]
 				Returns icon of the one-click deploy menu button, icon should be 16x16 adjusted to the current editor scale, see [method EditorInterface.get_editor_scale].
 			</description>
 		</method>
-		<method name="_has_valid_export_configuration" qualifiers="virtual const">
+		<method name="_has_valid_export_configuration" qualifiers="virtual required const">
 			<return type="bool" />
 			<param index="0" name="preset" type="EditorExportPreset" />
 			<param index="1" name="debug" type="bool" />
 			<description>
-				[b]Required.[/b]
 				Returns [code]true[/code] if export configuration is valid.
 			</description>
 		</method>
-		<method name="_has_valid_project_configuration" qualifiers="virtual const">
+		<method name="_has_valid_project_configuration" qualifiers="virtual required const">
 			<return type="bool" />
 			<param index="0" name="preset" type="EditorExportPreset" />
 			<description>
-				[b]Required.[/b]
 				Returns [code]true[/code] if project configuration is valid.
 			</description>
 		</method>
 		<method name="_is_executable" qualifiers="virtual const">
 			<return type="bool" />
 			<param index="0" name="path" type="String" />
 			<description>
-				[b]Optional.[/b]
 				Returns [code]true[/code] if specified file is a valid executable (native executable or script) for the target platform.
 			</description>
 		</method>
 		<method name="_poll_export" qualifiers="virtual">
 			<return type="bool" />
 			<description>
-				[b]Optional.[/b]
 				Returns [code]true[/code] if one-click deploy options are changed and editor interface should be updated.
 			</description>
 		</method>
@@ -268,15 +240,13 @@
 			<param index="1" name="device" type="int" />
 			<param index="2" name="debug_flags" type="int" enum="EditorExportPlatform.DebugFlags" is_bitfield="true" />
 			<description>
-				[b]Optional.[/b]
 				This method is called when [param device] one-click deploy menu option is selected.
 				Implementation should export project to a temporary location, upload and run it on the specific [param device], or perform another action associated with the menu item.
 			</description>
 		</method>
 		<method name="_should_update_export_options" qualifiers="virtual">
 			<return type="bool" />
 			<description>
-				[b]Optional.[/b]
 				Returns [code]true[/code] if export options list is changed and presets should be updated.
 			</description>
 		</method>

doc/classes/EditorExportPlugin.xml

@@ -30,7 +30,7 @@
 				[b]Note:[/b] [method _customize_scene] will only be called for scenes that have been modified since the last export.
 			</description>
 		</method>
-		<method name="_customize_resource" qualifiers="virtual">
+		<method name="_customize_resource" qualifiers="virtual required">
 			<return type="Resource" />
 			<param index="0" name="resource" type="Resource" />
 			<param index="1" name="path" type="String" />
@@ -47,7 +47,7 @@
 				- [CompressedTexture3D]
 			</description>
 		</method>
-		<method name="_customize_scene" qualifiers="virtual">
+		<method name="_customize_scene" qualifiers="virtual required">
 			<return type="Node" />
 			<param index="0" name="scene" type="Node" />
 			<param index="1" name="path" type="String" />
@@ -152,7 +152,7 @@
 				[b]Note:[/b] Only supported on Android and requires [member EditorExportPlatformAndroid.gradle_build/use_gradle_build] to be enabled.
 			</description>
 		</method>
-		<method name="_get_customization_configuration_hash" qualifiers="virtual const">
+		<method name="_get_customization_configuration_hash" qualifiers="virtual required const">
 			<return type="int" />
 			<description>
 				Return a hash based on the configuration passed (for both scenes and resources). This helps keep separate caches for separate export configurations.
@@ -172,7 +172,6 @@
 			<param index="0" name="platform" type="EditorExportPlatform" />
 			<param index="1" name="option" type="String" />
 			<description>
-				[b]Optional.[/b]
 				Validates [param option] and returns the visibility for the specified [param platform]. The default implementation returns [code]true[/code] for all options.
 			</description>
 		</method>
@@ -220,7 +219,7 @@
 				[/codeblock]
 			</description>
 		</method>
-		<method name="_get_name" qualifiers="virtual const">
+		<method name="_get_name" qualifiers="virtual required const">
 			<return type="String" />
 			<description>
 				Return the name identifier of this plugin (for future identification by the exporter). The plugins are sorted by name before exporting.

doc/classes/EditorFileSystemImportFormatSupportQuery.xml

@@ -9,19 +9,19 @@
 	<tutorials>
 	</tutorials>
 	<methods>
-		<method name="_get_file_extensions" qualifiers="virtual const">
+		<method name="_get_file_extensions" qualifiers="virtual required const">
 			<return type="PackedStringArray" />
 			<description>
 				Return the file extensions supported.
 			</description>
 		</method>
-		<method name="_is_active" qualifiers="virtual const">
+		<method name="_is_active" qualifiers="virtual required const">
 			<return type="bool" />
 			<description>
 				Return whether this importer is active.
 			</description>
 		</method>
-		<method name="_query" qualifiers="virtual const">
+		<method name="_query" qualifiers="virtual required const">
 			<return type="bool" />
 			<description>
 				Query support. Return [code]false[/code] if import must not continue.

doc/classes/EditorScript.xml

@@ -35,7 +35,7 @@
 	<tutorials>
 	</tutorials>
 	<methods>
-		<method name="_run" qualifiers="virtual">
+		<method name="_run" qualifiers="virtual required">
 			<return type="void" />
 			<description>
 				This method is executed by the Editor when [b]File &gt; Run[/b] is used.