From a0829dcc3a60c924220a9d46ac3a0fd3778011d5 Mon Sep 17 00:00:00 2001
From: DevPoodle <richardbonilla112@gmail.com>
Date: Thu, 17 Oct 2024 06:57:56 -0700
Subject: [PATCH] Add descriptions to RDTextureFormat's methods

---
 doc/classes/RDTextureFormat.xml | 2 ++
 doc/classes/RDTextureView.xml   | 2 +-
 2 files changed, 3 insertions(+), 1 deletion(-)

diff --git a/doc/classes/RDTextureFormat.xml b/doc/classes/RDTextureFormat.xml
index f8de7feda0b..ac875ab7c10 100644
--- a/doc/classes/RDTextureFormat.xml
+++ b/doc/classes/RDTextureFormat.xml
@@ -13,12 +13,14 @@
 			<return type="void" />
 			<param index="0" name="format" type="int" enum="RenderingDevice.DataFormat" />
 			<description>
+				Adds [param format] as a valid format for the corresponding [RDTextureView]'s [member RDTextureView.format_override] property. If any format is added as shareable, then the main [member format] must also be added.
 			</description>
 		</method>
 		<method name="remove_shareable_format">
 			<return type="void" />
 			<param index="0" name="format" type="int" enum="RenderingDevice.DataFormat" />
 			<description>
+				Removes [param format] from the list of valid formats that the corresponding [RDTextureView]'s [member RDTextureView.format_override] property can be set to.
 			</description>
 		</method>
 	</methods>
diff --git a/doc/classes/RDTextureView.xml b/doc/classes/RDTextureView.xml
index 30b6bfedf53..bd8102d5531 100644
--- a/doc/classes/RDTextureView.xml
+++ b/doc/classes/RDTextureView.xml
@@ -10,7 +10,7 @@
 	</tutorials>
 	<members>
 		<member name="format_override" type="int" setter="set_format_override" getter="get_format_override" enum="RenderingDevice.DataFormat" default="218">
-			Optional override for the data format to return sampled values in. The default value of [constant RenderingDevice.DATA_FORMAT_MAX] does not override the format.
+			Optional override for the data format to return sampled values in. The corresponding [RDTextureFormat] must have had this added as a shareable format. The default value of [constant RenderingDevice.DATA_FORMAT_MAX] does not override the format.
 		</member>
 		<member name="swizzle_a" type="int" setter="set_swizzle_a" getter="get_swizzle_a" enum="RenderingDevice.TextureSwizzle" default="6">
 			The channel to sample when sampling the alpha channel.