Merge pull request #44636 from Calinou/doc-sliderjoint3d-description

Fix confusing SliderJoint3D brief description
godotengine · Dec 24, 2020 · dbd00d9 · dbd00d9
2 parents 6063af6 + 27f964d
commit dbd00d9
Show file tree

Hide file tree

Showing 5 changed files with 9 additions and 9 deletions.
diff --git a/doc/classes/ConeTwistJoint3D.xml b/doc/classes/ConeTwistJoint3D.xml
@@ -1,12 +1,12 @@
 <?xml version="1.0" encoding="UTF-8" ?>
 <class name="ConeTwistJoint3D" inherits="Joint3D" version="4.0">
 	<brief_description>
-		A twist joint between two 3D bodies.
+		A twist joint between two 3D PhysicsBodies.
 	</brief_description>
 	<description>
 		The joint can rotate the bodies across an axis defined by the local x-axes of the [Joint3D].
 		The twist axis is initiated as the X axis of the [Joint3D].
-		Once the Bodies swing, the twist axis is calculated as the middle of the x-axes of the Joint3D in the local space of the two Bodies.
+		Once the Bodies swing, the twist axis is calculated as the middle of the x-axes of the Joint3D in the local space of the two Bodies. See also [Generic6DOFJoint3D].
 	</description>
 	<tutorials>
 	</tutorials>

diff --git a/doc/classes/HingeJoint3D.xml b/doc/classes/HingeJoint3D.xml
@@ -1,10 +1,10 @@
 <?xml version="1.0" encoding="UTF-8" ?>
 <class name="HingeJoint3D" inherits="Joint3D" version="4.0">
 	<brief_description>
-		A hinge between two 3D bodies.
+		A hinge between two 3D PhysicsBodies.
 	</brief_description>
 	<description>
-		A HingeJoint3D normally uses the Z axis of body A as the hinge axis, another axis can be specified when adding it manually though.
+		A HingeJoint3D normally uses the Z axis of body A as the hinge axis, another axis can be specified when adding it manually though. See also [Generic6DOFJoint3D].
 	</description>
 	<tutorials>
 	</tutorials>

diff --git a/doc/classes/Joint3D.xml b/doc/classes/Joint3D.xml
@@ -4,7 +4,7 @@
 		Base class for all 3D joints.
 	</brief_description>
 	<description>
-		Joints are used to bind together two physics bodies. They have a solver priority and can define if the bodies of the two attached nodes should be able to collide with each other.
+		Joints are used to bind together two physics bodies. They have a solver priority and can define if the bodies of the two attached nodes should be able to collide with each other. See also [Generic6DOFJoint3D].
 	</description>
 	<tutorials>
 		<link title="3D Truck Town Demo">https://godotengine.org/asset-library/asset/524</link>

diff --git a/doc/classes/PinJoint3D.xml b/doc/classes/PinJoint3D.xml
@@ -1,10 +1,10 @@
 <?xml version="1.0" encoding="UTF-8" ?>
 <class name="PinJoint3D" inherits="Joint3D" version="4.0">
 	<brief_description>
-		Pin joint for 3D shapes.
+		Pin joint for 3D PhysicsBodies.
 	</brief_description>
 	<description>
-		Pin joint for 3D rigid bodies. It pins 2 bodies (rigid or static) together.
+		Pin joint for 3D rigid bodies. It pins 2 bodies (rigid or static) together. See also [Generic6DOFJoint3D].
 	</description>
 	<tutorials>
 	</tutorials>

diff --git a/doc/classes/SliderJoint3D.xml b/doc/classes/SliderJoint3D.xml
@@ -1,10 +1,10 @@
 <?xml version="1.0" encoding="UTF-8" ?>
 <class name="SliderJoint3D" inherits="Joint3D" version="4.0">
 	<brief_description>
-		Piston kind of slider between two bodies in 3D.
+		Slider between two PhysicsBodies in 3D.
 	</brief_description>
 	<description>
-		Slides across the X axis of the pivot object.
+		Slides across the X axis of the pivot object. See also [Generic6DOFJoint3D].
 	</description>
 	<tutorials>
 	</tutorials>