From 3c7adcbf8929006ce051b964094d6b1b2801583c Mon Sep 17 00:00:00 2001
From: Christian Luksch <luksch@vrvis.at>
Date: Wed, 20 Nov 2024 14:47:30 +0100
Subject: [PATCH] added comment

---
 src/Aardvark.Geometry.PolyMesh/PolyMesh.cs | 8 ++++++++
 1 file changed, 8 insertions(+)

diff --git a/src/Aardvark.Geometry.PolyMesh/PolyMesh.cs b/src/Aardvark.Geometry.PolyMesh/PolyMesh.cs
index 8c256f8a..ab7a60fa 100644
--- a/src/Aardvark.Geometry.PolyMesh/PolyMesh.cs
+++ b/src/Aardvark.Geometry.PolyMesh/PolyMesh.cs
@@ -1175,6 +1175,14 @@ where a.Key.IsPositive
 
         #region Various Methods
 
+        /// <summary>
+        /// Enumerates non-degenerate face indices.
+        /// The simplest check with compareVertices=false and checkNormals=false will test the edges for identical vertex indices.
+        /// With default arguments (compareVertices=true, checkNormals=true) vertexIndices, vertexValues, and faceNormals are used to test for degenerated faces.
+        /// NOTE: In case there are polygons with more than 3 vertices, a face will be considered degenerated if any edge is degenerated (identical
+        ///       vertex indices or vertex value if compareVertices=true) and will result in missing parts of the mesh. 
+        ///       This can be avoided by using TriangulatedCopy() beforehand.
+        /// </summary>
         public IEnumerable<int> NonDegenerateFaceIndices(
                 bool compareVertices = true, bool checkNormals = true)
         {