Merge pull request #21670 from cbscribe/kcc_class_edits

[DOCS] Classref additions and corrections

doc/classes/RID.xml

@@ -17,14 +17,14 @@
 			<argument index="0" name="from" type="Object">
 			</argument>
 			<description>
-				Create a new RID instance with the ID of a given resource. When not handed a valid resource, silently stores the unused ID 0.
+				Creates a new RID instance with the ID of a given resource. When not handed a valid resource, silently stores the unused ID 0.
 			</description>
 		</method>
 		<method name="get_id">
 			<return type="int">
 			</return>
 			<description>
-				Retrieve the ID of the referenced resource.
+				Returns the ID of the referenced resource.
 			</description>
 		</method>
 	</methods>

doc/classes/ResourceSaver.xml

@@ -1,10 +1,10 @@
 <?xml version="1.0" encoding="UTF-8" ?>
 <class name="ResourceSaver" inherits="Object" category="Core" version="3.1">
 	<brief_description>
-		Resource Saving Interface.
+		Resource saving interface.
 	</brief_description>
 	<description>
-		Resource Saving Interface. This interface is used for saving resources to disk.
+		Resource saving interface, used for saving resources to disk.
 	</description>
 	<tutorials>
 	</tutorials>
@@ -17,7 +17,7 @@
 			<argument index="0" name="type" type="Resource">
 			</argument>
 			<description>
-				Return the list of extensions available for saving a resource of a given type.
+				Returns the list of extensions available for saving a resource of a given type.
 			</description>
 		</method>
 		<method name="save">
@@ -30,7 +30,7 @@
 			<argument index="2" name="flags" type="int" default="0">
 			</argument>
 			<description>
-				Save a resource to disk, to a given path.
+				Saves a resource to disk.
 			</description>
 		</method>
 	</methods>

doc/classes/Script.xml

@@ -4,8 +4,8 @@
 		A class stored as a resource.
 	</brief_description>
 	<description>
-		A class stored as a resource. The script exends the functionality of all objects that instance it.
+		A class stored as a resource. A script exends the functionality of all objects that instance it.
-		The 'new' method of a script subclass creates a new instance. [method Object.set_script] extends an existing object, if that object's class matches one of the script's base classes.
+		The [code]new[/code] method of a script subclass creates a new instance. [method Object.set_script] extends an existing object, if that object's class matches one of the script's base classes.
 	</description>
 	<tutorials>
 		<link>http://docs.godotengine.org/en/3.0/getting_started/step_by_step/scripting.html</link>
@@ -17,7 +17,7 @@
 			<return type="bool">
 			</return>
 			<description>
-				Returns true if the script can be instanced.
+				Returns [code]true[/code] if the script can be instanced.
 			</description>
 		</method>
 		<method name="get_base_script" qualifiers="const">
@@ -31,6 +31,7 @@
 			<return type="String">
 			</return>
 			<description>
+				Returns the script's base type.
 			</description>
 		</method>
 		<method name="has_script_signal" qualifiers="const">
@@ -39,14 +40,14 @@
 			<argument index="0" name="signal_name" type="String">
 			</argument>
 			<description>
-				Returns true if the script, or a base class, defines a signal with the given name.
+				Returns [code]true[/code] if the script, or a base class, defines a signal with the given name.
 			</description>
 		</method>
 		<method name="has_source_code" qualifiers="const">
 			<return type="bool">
 			</return>
 			<description>
-				Returns true if the script contains non-empty source code.
+				Returns [code]true[/code] if the script contains non-empty source code.
 			</description>
 		</method>
 		<method name="instance_has" qualifiers="const">
@@ -55,14 +56,14 @@
 			<argument index="0" name="base_object" type="Object">
 			</argument>
 			<description>
-				Returns true if 'base_object' is an instance of this script.
+				Returns [code]true[/code] if [code]base_object[/code] is an instance of this script.
 			</description>
 		</method>
 		<method name="is_tool" qualifiers="const">
 			<return type="bool">
 			</return>
 			<description>
-				Returns true if the script is a tool script. A tool script can run in the editor.
+				Returns [code]true[/code] if the script is a tool script. A tool script can run in the editor.
 			</description>
 		</method>
 		<method name="reload">
@@ -77,7 +78,7 @@
 	</methods>
 	<members>
 		<member name="source_code" type="String" setter="set_source_code" getter="get_source_code">
-			The script source code, or an empty string if source code is not available. When set, does not reload the class implementation automatically.
+			The script source code or an empty string if source code is not available. When set, does not reload the class implementation automatically.
 		</member>
 	</members>
 	<constants>

doc/classes/Shape.xml

@@ -4,7 +4,7 @@
 		Base class for all 3D shape resources.
 	</brief_description>
 	<description>
-		Base class for all 3D shape resources. All 3D shapes that inherit from this can be set into a [PhysicsBody] or [Area].
+		Base class for all 3D shape resources. Nodes that inherit from this can be used as shapes for a [PhysicsBody] or [Area] objects.
 	</description>
 	<tutorials>
 		<link>http://docs.godotengine.org/en/3.0/tutorials/physics/physics_introduction.html</link>

doc/classes/Spatial.xml

@@ -296,11 +296,11 @@
 			World space (global) [Transform] of this node.
 		</member>
 		<member name="rotation" type="Vector3" setter="set_rotation" getter="get_rotation">
-			Rotation part of the local transformation, specified in terms of YXZ-Euler angles in the format (X-angle, Y-angle, Z-angle), in radians.
+			Rotation part of the local transformation in radians, specified in terms of YXZ-Euler angles in the format (X-angle, Y-angle, Z-angle).
-			Note that in the mathematical sense, rotation is a matrix and not a vector. The three Euler angles, which are the three indepdent parameters of the Euler-angle parametrization of the rotation matrix, are stored in a [Vector3] data structure not because the rotation is a vector, but only because [Vector3] exists as a convenient data-structure to store 3 floating point numbers. Therefore, applying affine operations on the rotation "vector" is not meaningful.
+			Note that in the mathematical sense, rotation is a matrix and not a vector. The three Euler angles, which are the three independent parameters of the Euler-angle parametrization of the rotation matrix, are stored in a [Vector3] data structure not because the rotation is a vector, but only because [Vector3] exists as a convenient data-structure to store 3 floating point numbers. Therefore, applying affine operations on the rotation "vector" is not meaningful.
 		</member>
 		<member name="rotation_degrees" type="Vector3" setter="set_rotation_degrees" getter="get_rotation_degrees">
-			Rotation part of the local transformation, specified in terms of YXZ-Euler angles in the format (X-angle, Y-angle, Z-angle), in degrees.
+			Rotation part of the local transformation in degrees, specified in terms of YXZ-Euler angles in the format (X-angle, Y-angle, Z-angle).
 		</member>
 		<member name="scale" type="Vector3" setter="set_scale" getter="get_scale">
 			Scale part of the local transformation.
@@ -312,7 +312,7 @@
 			Local translation of this node.
 		</member>
 		<member name="visible" type="bool" setter="set_visible" getter="is_visible">
-			Visibility of this node. Toggles if this node is rendered.
+			If [code]true[/code] this node is drawn. Default value: [code]true[/code].
 		</member>
 	</members>
 	<signals>

doc/classes/VisualServer.xml

@@ -1552,7 +1552,7 @@
 			<argument index="0" name="feature" type="String">
 			</argument>
 			<description>
-				Returns true, if the OS supports a certain feature. Features might be s3tc, etc, etc2 and pvrtc,
+				Returns [code]true[/code] if the OS supports a certain feature. Features might be s3tc, etc, etc2 and pvrtc,
 			</description>
 		</method>
 		<method name="immediate_begin">
@@ -3110,7 +3110,7 @@
 			<argument index="2" name="scale" type="bool">
 			</argument>
 			<description>
-				Sets a boot image. The color defines the background color and if scale is [code]true[/code], the image will be scaled to fit the screen size.
+				Sets a boot image. The color defines the background color and if scale is [code]true[/code] the image will be scaled to fit the screen size.
 			</description>
 		</method>
 		<method name="set_debug_generate_wireframes">
@@ -3484,7 +3484,7 @@
 			<argument index="0" name="shrink" type="bool">
 			</argument>
 			<description>
-				If [code]true[/code], sets internal processes to shrink all image data to half the size.
+				If [code]true[/code] sets internal processes to shrink all image data to half the size.
 			</description>
 		</method>
 		<method name="texture_set_size_override">
@@ -3507,7 +3507,7 @@
 			<argument index="0" name="enable" type="bool">
 			</argument>
 			<description>
-				If [code]true[/code], the image will be stored in the texture's images array if overwritten.
+				If [code]true[/code] the image will be stored in the texture's images array if overwritten.
 			</description>
 		</method>
 		<method name="viewport_attach_camera">
@@ -3600,7 +3600,7 @@
 			<argument index="1" name="active" type="bool">
 			</argument>
 			<description>
-				If [code]true[/code], sets the viewport active, else sets it inactive.
+				If [code]true[/code] sets the viewport active, else sets it inactive.
 			</description>
 		</method>
 		<method name="viewport_set_canvas_layer">
@@ -3659,7 +3659,7 @@
 			<argument index="1" name="disabled" type="bool">
 			</argument>
 			<description>
-				If [code]true[/code] a viewport's 3D rendering should be disabled.
+				If [code]true[/code] a viewport's 3D rendering is disabled.
 			</description>
 		</method>
 		<method name="viewport_set_disable_environment">
@@ -3670,7 +3670,7 @@
 			<argument index="1" name="disabled" type="bool">
 			</argument>
 			<description>
-				If [code]true[/code] rendering of a viewport's environment should be disabled.
+				If [code]true[/code] rendering of a viewport's environment is disabled.
 			</description>
 		</method>
 		<method name="viewport_set_global_canvas_transform">
@@ -3692,7 +3692,7 @@
 			<argument index="1" name="enabled" type="bool">
 			</argument>
 			<description>
-				If [code]true[/code] the viewport should render to hdr.
+				If [code]true[/code] the viewport renders to hdr.
 			</description>
 		</method>
 		<method name="viewport_set_hide_canvas">
@@ -3703,7 +3703,7 @@
 			<argument index="1" name="hidden" type="bool">
 			</argument>
 			<description>
-				If [code]true[/code] the viewport's canvas should not be rendered.
+				If [code]true[/code] the viewport's canvas is not rendered.
 			</description>
 		</method>
 		<method name="viewport_set_hide_scenario">
@@ -3795,7 +3795,7 @@
 			<argument index="1" name="enabled" type="bool">
 			</argument>
 			<description>
-				If [code]true[/code] the viewport should render its background as transparent.
+				If [code]true[/code] the viewport renders its background as transparent.
 			</description>
 		</method>
 		<method name="viewport_set_update_mode">
@@ -3806,7 +3806,7 @@
 			<argument index="1" name="update_mode" type="int" enum="VisualServer.ViewportUpdateMode">
 			</argument>
 			<description>
-				Sets when the viewport should be updated. See VIEWPORT_UPDATE_MODE_* constants for options.
+				Sets when the viewport should be updated. See [enum ViewportUpdateMode] constants for options.
 			</description>
 		</method>
 		<method name="viewport_set_usage">
@@ -3817,7 +3817,7 @@
 			<argument index="1" name="usage" type="int" enum="VisualServer.ViewportUsage">
 			</argument>
 			<description>
-				Sets what should be rendered in the viewport. See VIEWPORT_USAGE_* constants for options.
+				Sets the viewport's 2D/3D mode. See [enum ViewportUsage] constants for options.
 			</description>
 		</method>
 		<method name="viewport_set_use_arvr">
@@ -3828,7 +3828,7 @@
 			<argument index="1" name="use_arvr" type="bool">
 			</argument>
 			<description>
-				If [code]true[/code] the viewport should use augmented or virtual reality technologies. See [ARVRInterface].
+				If [code]true[/code] the viewport uses augmented or virtual reality technologies. See [ARVRInterface].
 			</description>
 		</method>
 		<method name="viewport_set_vflip">
@@ -3839,7 +3839,7 @@
 			<argument index="1" name="enabled" type="bool">
 			</argument>
 			<description>
-				If [code]true[/code] the viewport's rendering should be flipped vertically.
+				If [code]true[/code] the viewport's rendering is flipped vertically.
 			</description>
 		</method>
 	</methods>