From 1bf0a884929ada44db40e43a52f5bf8e67c9d6bd Mon Sep 17 00:00:00 2001 From: ikpil Date: Sat, 11 May 2024 23:58:01 +0900 Subject: [PATCH] update comment in DtPoly class --- src/DotRecast.Detour/DtPoly.cs | 21 ++++++++++++--------- 1 file changed, 12 insertions(+), 9 deletions(-) diff --git a/src/DotRecast.Detour/DtPoly.cs b/src/DotRecast.Detour/DtPoly.cs index 0ef2a77..c60039d 100644 --- a/src/DotRecast.Detour/DtPoly.cs +++ b/src/DotRecast.Detour/DtPoly.cs @@ -20,21 +20,24 @@ freely, subject to the following restrictions: namespace DotRecast.Detour { - /** Defines a polygon within a MeshTile object. */ + /// Defines a polygon within a dtMeshTile object. + /// @ingroup detour public class DtPoly { + /// Index to first link in linked list. (Or #DT_NULL_LINK if there is no link.) public readonly int index; - /** The indices of the polygon's vertices. The actual vertices are located in MeshTile::verts. */ + /// The indices of the polygon's vertices. + /// The actual vertices are located in dtMeshTile::verts. public readonly int[] verts; - /** Packed data representing neighbor polygons references and flags for each edge. */ + /// Packed data representing neighbor polygons references and flags for each edge. public readonly int[] neis; - /** The user defined polygon flags. */ + /// The user defined polygon flags. public int flags; - /** The number of vertices in the polygon. */ + /// The number of vertices in the polygon. public int vertCount; /// The bit packed area id and polygon type. @@ -48,25 +51,25 @@ namespace DotRecast.Detour neis = new int[maxVertsPerPoly]; } - /** Sets the user defined area id. [Limit: < {@link org.recast4j.detour.NavMesh#DT_MAX_AREAS}] */ + /// Sets the user defined area id. [Limit: < #DT_MAX_AREAS] public void SetArea(int a) { areaAndtype = (areaAndtype & 0xc0) | (a & 0x3f); } - /** Sets the polygon type. (See: #dtPolyTypes.) */ + /// Sets the polygon type. (See: #dtPolyTypes.) public void SetPolyType(int t) { areaAndtype = (areaAndtype & 0x3f) | (t << 6); } - /** Gets the user defined area id. */ + /// Gets the user defined area id. public int GetArea() { return areaAndtype & 0x3f; } - /** Gets the polygon type. (See: #dtPolyTypes) */ + /// Gets the polygon type. (See: #dtPolyTypes) public int GetPolyType() { return areaAndtype >> 6;