From 16d612dccc992d64d65d920ff2639f04d99aec51 Mon Sep 17 00:00:00 2001
From: Hugo Locurcio <hugo.locurcio@hugo.pro>
Date: Mon, 9 Dec 2019 15:16:28 +0100
Subject: Improve the Shape/Shape2D classes documentation

---
 doc/classes/PhysicsShapeQueryParameters.xml | 10 ++++++++++
 1 file changed, 10 insertions(+)

(limited to 'doc/classes/PhysicsShapeQueryParameters.xml')

diff --git a/doc/classes/PhysicsShapeQueryParameters.xml b/doc/classes/PhysicsShapeQueryParameters.xml
index 7d7307592e..d56247fcaf 100644
--- a/doc/classes/PhysicsShapeQueryParameters.xml
+++ b/doc/classes/PhysicsShapeQueryParameters.xml
@@ -1,8 +1,10 @@
 <?xml version="1.0" encoding="UTF-8" ?>
 <class name="PhysicsShapeQueryParameters" inherits="Reference" category="Core" version="3.2">
 	<brief_description>
+		Parameters to be sent to a 3D shape physics query.
 	</brief_description>
 	<description>
+		This class contains the shape and other parameters for 3D intersection/collision queries. See also [PhysicsShapeQueryResult].
 	</description>
 	<tutorials>
 	</tutorials>
@@ -13,23 +15,31 @@
 			<argument index="0" name="shape" type="Resource">
 			</argument>
 			<description>
+				Sets the [Shape] that will be used for collision/intersection queries.
 			</description>
 		</method>
 	</methods>
 	<members>
 		<member name="collide_with_areas" type="bool" setter="set_collide_with_areas" getter="is_collide_with_areas_enabled" default="false">
+			If [code]true[/code], the query will take [Area]s into account.
 		</member>
 		<member name="collide_with_bodies" type="bool" setter="set_collide_with_bodies" getter="is_collide_with_bodies_enabled" default="true">
+			If [code]true[/code], the query will take [PhysicsBody]s into account.
 		</member>
 		<member name="collision_mask" type="int" setter="set_collision_mask" getter="get_collision_mask" default="2147483647">
+			The physics layer(s) the query will take into account (as a bitmask).
 		</member>
 		<member name="exclude" type="Array" setter="set_exclude" getter="get_exclude" default="[  ]">
+			The list of objects or object [RID]s that will be excluded from collisions.
 		</member>
 		<member name="margin" type="float" setter="set_margin" getter="get_margin" default="0.0">
+			The collision margin for the shape.
 		</member>
 		<member name="shape_rid" type="RID" setter="set_shape_rid" getter="get_shape_rid">
+			The queried shape's [RID]. See also [method set_shape].
 		</member>
 		<member name="transform" type="Transform" setter="set_transform" getter="get_transform" default="Transform( 1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0 )">
+			The queried shape's transform matrix.
 		</member>
 	</members>
 	<constants>
-- 
cgit v1.2.3