From 5bba84883e510e7d146523785eaffa2fd9284739 Mon Sep 17 00:00:00 2001 From: ikpil Date: Wed, 31 Jan 2024 00:13:23 +0900 Subject: [PATCH] clean up comments in DtRaycastHit --- src/DotRecast.Detour/DtRaycastHit.cs | 19 ++++++++++--------- 1 file changed, 10 insertions(+), 9 deletions(-) diff --git a/src/DotRecast.Detour/DtRaycastHit.cs b/src/DotRecast.Detour/DtRaycastHit.cs index cdd6219..bc52bb6 100644 --- a/src/DotRecast.Detour/DtRaycastHit.cs +++ b/src/DotRecast.Detour/DtRaycastHit.cs @@ -23,24 +23,25 @@ using DotRecast.Core.Numerics; namespace DotRecast.Detour { - /** - * Provides information about raycast hit. Filled by NavMeshQuery::raycast - */ + /// Provides information about raycast hit + /// filled by dtNavMeshQuery::raycast + /// @ingroup detour public class DtRaycastHit { - /** The hit parameter. (float.MaxValue if no wall hit.) */ + /// The hit parameter. (FLT_MAX if no wall hit.) public float t; - /** hitNormal The normal of the nearest wall hit. [(x, y, z)] */ + /// hitNormal The normal of the nearest wall hit. [(x, y, z)] public RcVec3f hitNormal = new RcVec3f(); - /** Visited polygons. */ + /// The index of the edge on the final polygon where the wall was hit. + public int hitEdgeIndex; + + /// Pointer to an array of reference ids of the visited polygons. [opt] public readonly List path = new List(); - /** The cost of the path until hit. */ + /// The cost of the path until hit. public float pathCost; - /** The index of the edge on the readonly polygon where the wall was hit. */ - public int hitEdgeIndex; } } \ No newline at end of file