From d9d1a91c5f84458408f02c30489890f0a8e87bc6 Mon Sep 17 00:00:00 2001
From: Chris Bradfield <chris@kidscancode.org>
Date: Mon, 1 Oct 2018 15:20:18 -0700
Subject: [PATCH] [DOCS] Update VisibilityEnabler* and TileSet doc

(cherry picked from commit 49549ce93cb8a37b18c632c3ee29c63a82e37958)
---
 doc/classes/TileSet.xml             | 27 ++++++++++++++++++---------
 doc/classes/VisibilityEnabler.xml   |  2 ++
 doc/classes/VisibilityEnabler2D.xml |  6 ++++++
 3 files changed, 26 insertions(+), 9 deletions(-)

diff --git a/doc/classes/TileSet.xml b/doc/classes/TileSet.xml
index d6841ec02d6..d3703c02f93 100644
--- a/doc/classes/TileSet.xml
+++ b/doc/classes/TileSet.xml
@@ -67,7 +67,7 @@
 			<argument index="0" name="id" type="int">
 			</argument>
 			<description>
-				Creates a new tile which will be referenced by the given ID.
+				Creates a new tile with the given ID.
 			</description>
 		</method>
 		<method name="find_tile_by_name" qualifiers="const">
@@ -99,7 +99,7 @@
 			<argument index="0" name="id" type="int">
 			</argument>
 			<description>
-				Removes the tile referenced by the given ID.
+				Removes the given tile ID.
 			</description>
 		</method>
 		<method name="tile_add_shape">
@@ -116,6 +116,7 @@
 			<argument index="4" name="autotile_coord" type="Vector2" default="Vector2( 0, 0 )">
 			</argument>
 			<description>
+				Adds a shape to the tile.
 			</description>
 		</method>
 		<method name="tile_get_light_occluder" qualifiers="const">
@@ -124,7 +125,7 @@
 			<argument index="0" name="id" type="int">
 			</argument>
 			<description>
-				Returns the light occluder of the tile.
+				Returns the tile's light occluder.
 			</description>
 		</method>
 		<method name="tile_get_material" qualifiers="const">
@@ -133,7 +134,7 @@
 			<argument index="0" name="id" type="int">
 			</argument>
 			<description>
-				Returns the material of the tile.
+				Returns the tile's material.
 			</description>
 		</method>
 		<method name="tile_get_name" qualifiers="const">
@@ -142,7 +143,7 @@
 			<argument index="0" name="id" type="int">
 			</argument>
 			<description>
-				Returns the name of the tile.
+				Returns the tile's name.
 			</description>
 		</method>
 		<method name="tile_get_navigation_polygon" qualifiers="const">
@@ -169,6 +170,7 @@
 			<argument index="0" name="id" type="int">
 			</argument>
 			<description>
+				Returns the tile's normal map texture.
 			</description>
 		</method>
 		<method name="tile_get_occluder_offset" qualifiers="const">
@@ -197,6 +199,7 @@
 			<argument index="1" name="shape_id" type="int">
 			</argument>
 			<description>
+				Returns a tile's given shape.
 			</description>
 		</method>
 		<method name="tile_get_shape_count" qualifiers="const">
@@ -205,6 +208,7 @@
 			<argument index="0" name="id" type="int">
 			</argument>
 			<description>
+				Returns the number of shapes assigned to a tile.
 			</description>
 		</method>
 		<method name="tile_get_shape_one_way" qualifiers="const">
@@ -215,6 +219,7 @@
 			<argument index="1" name="shape_id" type="int">
 			</argument>
 			<description>
+				Returns the one-way collision value of a tile's shape.
 			</description>
 		</method>
 		<method name="tile_get_shape_transform" qualifiers="const">
@@ -225,6 +230,7 @@
 			<argument index="1" name="shape_id" type="int">
 			</argument>
 			<description>
+				Returns the [Transform2D] of a tile's sahpe.
 			</description>
 		</method>
 		<method name="tile_get_shapes" qualifiers="const">
@@ -233,7 +239,7 @@
 			<argument index="0" name="id" type="int">
 			</argument>
 			<description>
-				Returns the array of shapes of the tile.
+				Returns an array of the tile's shapes.
 			</description>
 		</method>
 		<method name="tile_get_texture" qualifiers="const">
@@ -242,7 +248,7 @@
 			<argument index="0" name="id" type="int">
 			</argument>
 			<description>
-				Returns the texture of the tile.
+				Returns the tile's texture.
 			</description>
 		</method>
 		<method name="tile_get_texture_offset" qualifiers="const">
@@ -328,7 +334,7 @@
 			<argument index="1" name="occluder_offset" type="Vector2">
 			</argument>
 			<description>
-				Set an offset for the tile's light occluder.
+				Sets an offset for the tile's light occluder.
 			</description>
 		</method>
 		<method name="tile_set_region">
@@ -339,7 +345,7 @@
 			<argument index="1" name="region" type="Rect2">
 			</argument>
 			<description>
-				Set the tile's sub-region in the texture. This is common in texture atlases.
+				Sets the tile's sub-region in the texture. This is common in texture atlases.
 			</description>
 		</method>
 		<method name="tile_set_shape">
@@ -352,6 +358,7 @@
 			<argument index="2" name="shape" type="Shape2D">
 			</argument>
 			<description>
+				Sets a shape for the tile, enabling collision.
 			</description>
 		</method>
 		<method name="tile_set_shape_one_way">
@@ -364,6 +371,7 @@
 			<argument index="2" name="one_way" type="bool">
 			</argument>
 			<description>
+				Enables one-way collision on a tile's shape.
 			</description>
 		</method>
 		<method name="tile_set_shape_transform">
@@ -376,6 +384,7 @@
 			<argument index="2" name="shape_transform" type="Transform2D">
 			</argument>
 			<description>
+				Sets a [Transform2D] on a tile's shape.
 			</description>
 		</method>
 		<method name="tile_set_shapes">
diff --git a/doc/classes/VisibilityEnabler.xml b/doc/classes/VisibilityEnabler.xml
index a4d47152e6b..449185be6ce 100644
--- a/doc/classes/VisibilityEnabler.xml
+++ b/doc/classes/VisibilityEnabler.xml
@@ -14,8 +14,10 @@
 	</methods>
 	<members>
 		<member name="freeze_bodies" type="bool" setter="set_enabler" getter="is_enabler_enabled">
+			If [code]true[/code] [RigidBody] nodes will be paused.
 		</member>
 		<member name="pause_animations" type="bool" setter="set_enabler" getter="is_enabler_enabled">
+			If [code]true[/code] [AnimationPlayer] nodes will be paused.
 		</member>
 	</members>
 	<constants>
diff --git a/doc/classes/VisibilityEnabler2D.xml b/doc/classes/VisibilityEnabler2D.xml
index 2d7f4e33946..294d9a87e1d 100644
--- a/doc/classes/VisibilityEnabler2D.xml
+++ b/doc/classes/VisibilityEnabler2D.xml
@@ -14,16 +14,22 @@
 	</methods>
 	<members>
 		<member name="freeze_bodies" type="bool" setter="set_enabler" getter="is_enabler_enabled">
+			If [code]true[/code] [RigidBody2D] nodes will be paused.
 		</member>
 		<member name="pause_animated_sprites" type="bool" setter="set_enabler" getter="is_enabler_enabled">
+			If [code]true[/code] [AnimatedSprite] nodes will be paused.
 		</member>
 		<member name="pause_animations" type="bool" setter="set_enabler" getter="is_enabler_enabled">
+			If [code]true[/code] [AnimationPlayer] nodes will be paused.
 		</member>
 		<member name="pause_particles" type="bool" setter="set_enabler" getter="is_enabler_enabled">
+			If [code]true[/code] [Particles2D] nodes will be paused.
 		</member>
 		<member name="physics_process_parent" type="bool" setter="set_enabler" getter="is_enabler_enabled">
+			If [code]true[/code] the parent's [method Node._physics_process] will be stopped.
 		</member>
 		<member name="process_parent" type="bool" setter="set_enabler" getter="is_enabler_enabled">
+			If [code]true[/code] the parent's [method Node._process] will be stopped.
 		</member>
 	</members>
 	<constants>