Browse Source

Classref typo fixes and improvements

Haoyu Qiu 3 years ago
parent
commit
b43fdea0d5

+ 1 - 1
doc/classes/@GlobalScope.xml

@@ -1453,7 +1453,7 @@
 			Hints that an integer property is a bitmask using the optionally named 3D physics layers.
 		</constant>
 		<constant name="PROPERTY_HINT_LAYERS_3D_NAVIGATION" value="14" enum="PropertyHint">
-			Hints that an integer property is a bitmask using the optionally named 2D navigation layers.
+			Hints that an integer property is a bitmask using the optionally named 3D navigation layers.
 		</constant>
 		<constant name="PROPERTY_HINT_FILE" value="15" enum="PropertyHint">
 			Hints that a string property is a path to a file. Editing it will show a file dialog for picking the path. The hint string can be a set of filters with wildcards like [code]"*.png,*.jpg"[/code].

+ 2 - 2
doc/classes/NavigationMeshInstance.xml

@@ -34,7 +34,7 @@
 			Determines if the [NavigationMeshInstance] is enabled or disabled.
 		</member>
 		<member name="enter_cost" type="float" setter="set_enter_cost" getter="get_enter_cost" default="0.0">
-			When pathfinding enters this regions navmesh from another regions navmesh the [code]enter_cost[/code] value is added to the path distance for determining the shortest path.
+			When pathfinding enters this region's navmesh from another regions navmesh the [code]enter_cost[/code] value is added to the path distance for determining the shortest path.
 		</member>
 		<member name="navigation_layers" type="int" setter="set_navigation_layers" getter="get_navigation_layers" default="1">
 			A bitfield determining all navigation map layers the [NavigationMesh] belongs to. On path requests with [method NavigationServer.map_get_path] navmeshes without matching layers will be ignored and the navigation map will only proximity merge different navmeshes with matching layers.
@@ -43,7 +43,7 @@
 			The [NavigationMesh] resource to use.
 		</member>
 		<member name="travel_cost" type="float" setter="set_travel_cost" getter="get_travel_cost" default="1.0">
-			When pathfinding moves inside this regions navmesh the traveled distances are multiplied with [code]travel_cost[/code] for determining the shortest path.
+			When pathfinding moves inside this region's navmesh the traveled distances are multiplied with [code]travel_cost[/code] for determining the shortest path.
 		</member>
 	</members>
 	<signals>

+ 2 - 2
doc/classes/NavigationPolygonInstance.xml

@@ -27,7 +27,7 @@
 			Determines if the [NavigationPolygonInstance] is enabled or disabled.
 		</member>
 		<member name="enter_cost" type="float" setter="set_enter_cost" getter="get_enter_cost" default="0.0">
-			When pathfinding enters this regions navmesh from another regions navmesh the [code]enter_cost[/code] value is added to the path distance for determining the shortest path.
+			When pathfinding enters this region's navmesh from another regions navmesh the [code]enter_cost[/code] value is added to the path distance for determining the shortest path.
 		</member>
 		<member name="navigation_layers" type="int" setter="set_navigation_layers" getter="get_navigation_layers" default="1">
 			A bitfield determining all navigation map layers the [NavigationPolygon] belongs to. On path requests with [method Navigation2DServer.map_get_path] navmeshes without matching layers will be ignored and the navigation map will only proximity merge different navmeshes with matching layers.
@@ -36,7 +36,7 @@
 			The [NavigationPolygon] resource to use.
 		</member>
 		<member name="travel_cost" type="float" setter="set_travel_cost" getter="get_travel_cost" default="1.0">
-			When pathfinding moves inside this regions navmesh the traveled distances are multiplied with [code]travel_cost[/code] for determining the shortest path.
+			When pathfinding moves inside this region's navmesh the traveled distances are multiplied with [code]travel_cost[/code] for determining the shortest path.
 		</member>
 	</members>
 	<constants>

+ 2 - 2
doc/classes/VisibilityEnabler2D.xml

@@ -59,10 +59,10 @@
 			This enabler will stop [Particles2D] nodes.
 		</constant>
 		<constant name="ENABLER_PARENT_PROCESS" value="3" enum="Enabler">
-			This enabler will stop the parent's _process function.
+			This enabler will stop the parent's [method Node._process] function.
 		</constant>
 		<constant name="ENABLER_PARENT_PHYSICS_PROCESS" value="4" enum="Enabler">
-			This enabler will stop the parent's _physics_process function.
+			This enabler will stop the parent's [method Node._physics_process] function.
 		</constant>
 		<constant name="ENABLER_PAUSE_ANIMATED_SPRITES" value="5" enum="Enabler">
 			This enabler will stop [AnimatedSprite] nodes animations.

+ 1 - 1
doc/classes/World.xml

@@ -19,7 +19,7 @@
 			The World's [Environment].
 		</member>
 		<member name="fallback_environment" type="Environment" setter="set_fallback_environment" getter="get_fallback_environment">
-			The World's fallback_environment will be used if the World's [Environment] fails or is missing.
+			The World's fallback environment will be used if [member environment] fails or is missing.
 		</member>
 		<member name="navigation_map" type="RID" setter="" getter="get_navigation_map">
 			The [RID] of this world's navigation map. Used by the [NavigationServer].

+ 1 - 1
modules/gdscript/doc_classes/@GDScript.xml

@@ -236,7 +236,7 @@
 			<argument index="0" name="a" type="Variant" />
 			<argument index="1" name="b" type="Variant" />
 			<description>
-				Compares two values by checking their actual contents, recursing into any `Array` or `Dictionary` up to its deepest level.
+				Compares two values by checking their actual contents, recursing into any [Array] or [Dictionary] up to its deepest level.
 				This compares to [code]==[/code] in a number of ways:
 				- For [code]null[/code], [code]int[/code], [code]float[/code], [code]String[/code], [code]Object[/code] and [code]RID[/code] both [code]deep_equal[/code] and [code]==[/code] work the same.
 				- For [code]Dictionary[/code], [code]==[/code] considers equality if, and only if, both variables point to the very same [code]Dictionary[/code], with no recursion or awareness of the contents at all.