From 4e7afa64c6f28694a7cba53db4a00cda226ef645 Mon Sep 17 00:00:00 2001
From: ikpil <ikpil@naver.com>
Date: Tue, 14 May 2024 23:17:39 +0900
Subject: [PATCH] update comment in DtNavMeshParams

---
 src/DotRecast.Detour/DtNavMeshParams.cs | 29 ++++++++-----------------
 1 file changed, 9 insertions(+), 20 deletions(-)

diff --git a/src/DotRecast.Detour/DtNavMeshParams.cs b/src/DotRecast.Detour/DtNavMeshParams.cs
index 81cf963..3de5487 100644
--- a/src/DotRecast.Detour/DtNavMeshParams.cs
+++ b/src/DotRecast.Detour/DtNavMeshParams.cs
@@ -22,27 +22,16 @@ using DotRecast.Core.Numerics;
 
 namespace DotRecast.Detour
 {
-    /**
- * Configuration parameters used to define multi-tile navigation meshes. The values are used to allocate space during
- * the initialization of a navigation mesh.
- *
- * @see NavMesh
- */
+    /// Configuration parameters used to define multi-tile navigation meshes.
+    /// The values are used to allocate space during the initialization of a navigation mesh.
+    /// @see dtNavMesh::init()
+    /// @ingroup detour
     public struct DtNavMeshParams
     {
-        /** The world space origin of the navigation mesh's tile space. [(x, y, z)] */
-        public RcVec3f orig;
-
-        /** The width of each tile. (Along the x-axis.) */
-        public float tileWidth;
-
-        /** The height of each tile. (Along the z-axis.) */
-        public float tileHeight;
-
-        /** The maximum number of tiles the navigation mesh can contain. */
-        public int maxTiles;
-
-        /** The maximum number of polygons each tile can contain. */
-        public int maxPolys;
+        public RcVec3f orig; //< The world space origin of the navigation mesh's tile space. [(x, y, z)]
+        public float tileWidth; //< The width of each tile. (Along the x-axis.)
+        public float tileHeight; //< The height of each tile. (Along the z-axis.)
+        public int maxTiles; //< The maximum number of tiles the navigation mesh can contain. This and maxPolys are used to calculate how many bits are needed to identify tiles and polygons uniquely.
+        public int maxPolys; //< The maximum number of polygons each tile can contain. This and maxTiles are used to calculate how many bits are needed to identify tiles and polygons uniquely.
     }
 }
\ No newline at end of file