From a7f3933a51c55221bbe9184bb2b7b9fb0ccfc5cb Mon Sep 17 00:00:00 2001
From: Denis Washington <denis@denisw.de>
Date: Sun, 8 Apr 2018 22:42:09 +0200
Subject: [PATCH] Add Navigation2D docs

---
 doc/classes/Navigation2D.xml | 9 ++++++++-
 1 file changed, 8 insertions(+), 1 deletion(-)

diff --git a/doc/classes/Navigation2D.xml b/doc/classes/Navigation2D.xml
index d2f45133721..364da55f999 100644
--- a/doc/classes/Navigation2D.xml
+++ b/doc/classes/Navigation2D.xml
@@ -1,9 +1,10 @@
 <?xml version="1.0" encoding="UTF-8" ?>
 <class name="Navigation2D" inherits="Node2D" category="Core" version="3.1">
 	<brief_description>
-		Class to assist with character navigation and pathfinding.
+		2D navigation and pathfinding node.
 	</brief_description>
 	<description>
+		Navigation2D provides navigation and pathfinding within a 2D area, specified as a collection of [NavigationPolygon] resources. By default these are automatically collected from child [NavigationPolygonInstance] nodes, but they can also be added on the fly with [method navpoly_add].
 	</description>
 	<tutorials>
 	</tutorials>
@@ -16,6 +17,7 @@
 			<argument index="0" name="to_point" type="Vector2">
 			</argument>
 			<description>
+				Returns the navigation point closest to the point given. Points are in local coordinate space.
 			</description>
 		</method>
 		<method name="get_closest_point_owner">
@@ -24,6 +26,7 @@
 			<argument index="0" name="to_point" type="Vector2">
 			</argument>
 			<description>
+				Returns the owner of the [NavigationPolygon] which contains the navigation point closest to the point given. This is usually a [NavigtionPolygonInstance]. For polygons added via [method navpoly_add], returns the owner that was given (or [code]null[/code] if the [code]owner[/code] parameter was omitted).
 			</description>
 		</method>
 		<method name="get_simple_path">
@@ -36,6 +39,7 @@
 			<argument index="2" name="optimize" type="bool" default="true">
 			</argument>
 			<description>
+				Returns the path between two given points. Points are in local coordinate space. If [code]optimize[/code] is [code]true[/code] (the default), the path is smoothed by merging path segments where possible.
 			</description>
 		</method>
 		<method name="navpoly_add">
@@ -48,6 +52,7 @@
 			<argument index="2" name="owner" type="Object" default="null">
 			</argument>
 			<description>
+				Adds a [NavigationPolygon]. Returns an ID for use with [method navpoly_remove] or [method navpoly_set_transform]. If given, a [Transform2D] is applied to the polygon. The optional [code]owner[/code] is used as return value for [method get_closest_point_owner].
 			</description>
 		</method>
 		<method name="navpoly_remove">
@@ -56,6 +61,7 @@
 			<argument index="0" name="id" type="int">
 			</argument>
 			<description>
+				Removes the [NavigationPolygon] with the given ID.
 			</description>
 		</method>
 		<method name="navpoly_set_transform">
@@ -66,6 +72,7 @@
 			<argument index="1" name="xform" type="Transform2D">
 			</argument>
 			<description>
+				Sets the transform applied to the [NavigationPolygon] with the given ID.
 			</description>
 		</method>
 	</methods>