From 4543df0b90c955311a2ba051b55cb90f05441379 Mon Sep 17 00:00:00 2001 From: ikpil Date: Wed, 15 May 2024 23:06:52 +0900 Subject: [PATCH] update comment --- src/DotRecast.Detour/DtBVNode.cs | 20 ++++++----------- src/DotRecast.Detour/DtLink.cs | 32 ++++++++-------------------- src/DotRecast.Detour/DtPolyDetail.cs | 17 +++++---------- 3 files changed, 20 insertions(+), 49 deletions(-) diff --git a/src/DotRecast.Detour/DtBVNode.cs b/src/DotRecast.Detour/DtBVNode.cs index 2de5e75..2e4ff4e 100644 --- a/src/DotRecast.Detour/DtBVNode.cs +++ b/src/DotRecast.Detour/DtBVNode.cs @@ -20,21 +20,13 @@ freely, subject to the following restrictions: namespace DotRecast.Detour { - /** - * Bounding volume node. - * - * @note This structure is rarely if ever used by the end user. - * @see MeshTile - */ + /// Bounding volume node. + /// @note This structure is rarely if ever used by the end user. + /// @see dtMeshTile public class DtBVNode { - /** Minimum bounds of the node's AABB. [(x, y, z)] */ - public int[] bmin = new int[3]; - - /** Maximum bounds of the node's AABB. [(x, y, z)] */ - public int[] bmax = new int[3]; - - /** The node's index. (Negative for escape sequence.) */ - public int i; + public int[] bmin = new int[3]; //< Minimum bounds of the node's AABB. [(x, y, z)] + public int[] bmax = new int[3]; //< Maximum bounds of the node's AABB. [(x, y, z)] + public int i; //< The node's index. (Negative for escape sequence.) } } \ No newline at end of file diff --git a/src/DotRecast.Detour/DtLink.cs b/src/DotRecast.Detour/DtLink.cs index 434bb73..d249ce4 100644 --- a/src/DotRecast.Detour/DtLink.cs +++ b/src/DotRecast.Detour/DtLink.cs @@ -20,30 +20,16 @@ freely, subject to the following restrictions: namespace DotRecast.Detour { - /** - * Defines a link between polygons. - * - * @note This structure is rarely if ever used by the end user. - * @see MeshTile - */ + /// Defines a link between polygons. + /// @note This structure is rarely if ever used by the end user. + /// @see dtMeshTile public class DtLink { - /** Neighbour reference. (The neighbor that is linked to.) */ - public long refs; - - /** Index of the next link. */ - public int next; - - /** Index of the polygon edge that owns this link. */ - public int edge; - - /** If a boundary link, defines on which side the link is. */ - public int side; - - /** If a boundary link, defines the minimum sub-edge area. */ - public int bmin; - - /** If a boundary link, defines the maximum sub-edge area. */ - public int bmax; + public long refs; //< Neighbour reference. (The neighbor that is linked to.) + public int next; //< Index of the next link. + public int edge; //< Index of the polygon edge that owns this link. + public int side; //< If a boundary link, defines on which side the link is. + public int bmin; //< If a boundary link, defines the minimum sub-edge area. + public int bmax; //< If a boundary link, defines the maximum sub-edge area. } } \ No newline at end of file diff --git a/src/DotRecast.Detour/DtPolyDetail.cs b/src/DotRecast.Detour/DtPolyDetail.cs index cd813a4..7ea88c6 100644 --- a/src/DotRecast.Detour/DtPolyDetail.cs +++ b/src/DotRecast.Detour/DtPolyDetail.cs @@ -20,20 +20,13 @@ freely, subject to the following restrictions: namespace DotRecast.Detour { - /** Defines the location of detail sub-mesh data within a dtMeshTile. */ + /// Defines the location of detail sub-mesh data within a dtMeshTile. public readonly struct DtPolyDetail { - /** The offset of the vertices in the MeshTile::detailVerts array. */ - public readonly int vertBase; - - /** The offset of the triangles in the MeshTile::detailTris array. */ - public readonly int triBase; - - /** The number of vertices in the sub-mesh. */ - public readonly int vertCount; - - /** The number of triangles in the sub-mesh. */ - public readonly int triCount; + public readonly int vertBase; //< The offset of the vertices in the dtMeshTile::detailVerts array. + public readonly int triBase; //< The offset of the triangles in the dtMeshTile::detailTris array. + public readonly int vertCount; //< The number of vertices in the sub-mesh. + public readonly int triCount; //< The number of triangles in the sub-mesh. public DtPolyDetail(int vertBase, int triBase, int vertCount, int triCount) {