From 24589d7ca37a5a8678aa6480596a37eb866921d0 Mon Sep 17 00:00:00 2001
From: kobewi <kobewi4e@gmail.com>
Date: Mon, 27 Feb 2023 11:54:01 +0100
Subject: Improve documentation of EditorExportPlugin

---
 doc/classes/EditorExportPlugin.xml | 9 +++++++--
 1 file changed, 7 insertions(+), 2 deletions(-)

(limited to 'doc')

diff --git a/doc/classes/EditorExportPlugin.xml b/doc/classes/EditorExportPlugin.xml
index fd76e8ddaa..5d1d2cd8f2 100644
--- a/doc/classes/EditorExportPlugin.xml
+++ b/doc/classes/EditorExportPlugin.xml
@@ -15,7 +15,8 @@
 			<param index="0" name="platform" type="EditorExportPlatform" />
 			<param index="1" name="features" type="PackedStringArray" />
 			<description>
-				Return true if this plugin will customize resources based on the platform and features used.
+				Return [code]true[/code] if this plugin will customize resources based on the platform and features used.
+				When enabled, [method _get_customization_configuration_hash], [method _customize_resource] and [method _customize_scene] will be called and must be implemented.
 			</description>
 		</method>
 		<method name="_begin_customize_scenes" qualifiers="virtual const">
@@ -33,6 +34,7 @@
 			<description>
 				Customize a resource. If changes are made to it, return the same or a new resource. Otherwise, return [code]null[/code].
 				The [i]path[/i] argument is only used when customizing an actual file, otherwise this means that this resource is part of another one and it will be empty.
+				Implementing this method is required if [method _begin_customize_resources] returns [code]true[/code].
 			</description>
 		</method>
 		<method name="_customize_scene" qualifiers="virtual">
@@ -41,6 +43,7 @@
 			<param index="1" name="path" type="String" />
 			<description>
 				Customize a scene. If changes are made to it, return the same or a new scene. Otherwise, return [code]null[/code]. If a new scene is returned, it is up to you to dispose of the old one.
+				Implementing this method is required if [method _begin_customize_resources] returns [code]true[/code].
 			</description>
 		</method>
 		<method name="_end_customize_resources" qualifiers="virtual">
@@ -85,6 +88,7 @@
 			<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.
+				Implementing this method is required if [method _begin_customize_resources] returns [code]true[/code].
 			</description>
 		</method>
 		<method name="_get_export_features" qualifiers="virtual const">
@@ -98,7 +102,8 @@
 		<method name="_get_name" qualifiers="virtual const">
 			<return type="String" />
 			<description>
-				Return the name identifier of this plugin (for future identification by the exporter).
+				Return the name identifier of this plugin (for future identification by the exporter). The plugins are sorted by name before exporting.
+				Implementing this method is required.
 			</description>
 		</method>
 		<method name="add_file">
-- 
cgit v1.2.3