From 6fa403dcc0c3427b3ef2129ffb9d7e1f2b0afe0a Mon Sep 17 00:00:00 2001
From: wo80 <christian.woltering@tu-dortmund.de>
Date: Sat, 28 May 2022 16:24:25 +0200
Subject: [PATCH] Code documentation updates (2).

---
 src/Triangle/IO/IFileFormat.cs               | 8 ++++++++
 src/Triangle/IO/TriangleFormat.cs            | 8 ++------
 src/Triangle/Meshing/IMesh.cs                | 2 +-
 src/Triangle/Topology/DCEL/DcelMesh.cs       | 6 ++++++
 src/Triangle/Voronoi/Legacy/SimpleVoronoi.cs | 7 ++++---
 src/Triangle/Voronoi/VoronoiBase.cs          | 9 +++++++--
 6 files changed, 28 insertions(+), 12 deletions(-)

diff --git a/src/Triangle/IO/IFileFormat.cs b/src/Triangle/IO/IFileFormat.cs
index 490641a..7441d8b 100644
--- a/src/Triangle/IO/IFileFormat.cs
+++ b/src/Triangle/IO/IFileFormat.cs
@@ -6,8 +6,16 @@
 
 namespace TriangleNet.IO
 {
+    /// <summary>
+    /// Interface used to indicate support for file formats in the <see cref="FileProcessor" />.
+    /// </summary>
     public interface IFileFormat
     {
+        /// <summary>
+        /// Test whether the given file is supported.
+        /// </summary>
+        /// <param name="file">The file to read.</param>
+        /// <returns>Returns true if the file can be read.</returns>
         bool IsSupported(string file);
     }
 }
diff --git a/src/Triangle/IO/TriangleFormat.cs b/src/Triangle/IO/TriangleFormat.cs
index 2bd6d75..e9611f7 100644
--- a/src/Triangle/IO/TriangleFormat.cs
+++ b/src/Triangle/IO/TriangleFormat.cs
@@ -13,15 +13,11 @@ namespace TriangleNet.IO
     using TriangleNet.Meshing;
 
     /// <summary>
-    /// Implements geometry and mesh file formats of the the original Triangle code.
+    /// Implements geometry and mesh file formats of the original Triangle project.
     /// </summary>
     public class TriangleFormat : IPolygonFormat, IMeshFormat
     {
-        /// <summary>
-        /// Returns a value indicating whether the given file is supported by this format.
-        /// </summary>
-        /// <param name="file"></param>
-        /// <returns></returns>
+        /// <inheritdoc />
         public bool IsSupported(string file)
         {
             string ext = Path.GetExtension(file).ToLower();
diff --git a/src/Triangle/Meshing/IMesh.cs b/src/Triangle/Meshing/IMesh.cs
index 03f11ef..b1be86b 100644
--- a/src/Triangle/Meshing/IMesh.cs
+++ b/src/Triangle/Meshing/IMesh.cs
@@ -50,7 +50,7 @@ namespace TriangleNet.Meshing
         /// </summary>
         /// <param name="quality">The quality constraints.</param>
         /// <param name="delaunay">
-        /// A value indicating, if the refined mesh should be Conforming Delaunay.
+        /// A value indicating, whether the refined mesh should be Conforming Delaunay.
         /// </param>
         void Refine(QualityOptions quality, bool delaunay);
     }
diff --git a/src/Triangle/Topology/DCEL/DcelMesh.cs b/src/Triangle/Topology/DCEL/DcelMesh.cs
index 3cbff97..4dcfd67 100644
--- a/src/Triangle/Topology/DCEL/DcelMesh.cs
+++ b/src/Triangle/Topology/DCEL/DcelMesh.cs
@@ -84,6 +84,12 @@ namespace TriangleNet.Topology.DCEL
         /// a valid next pointer).</param>
         /// <param name="depth">Maximum edge count of faces (default = 0 means skip check).</param>
         /// <returns></returns>
+        /// <remarks>
+        /// The <paramref name="depth"/> value relates to the maximum degree of a vertex in the
+        /// triangulation. For quality meshes, the maximum degree is usually low, but for meshes
+        /// build from PSLGs without quality constraints applied, either provide a larger value
+        /// or disable the check by setting <paramref name="depth"/> to 0 (default).
+        /// </remarks>
         public virtual bool IsConsistent(bool closed = true, int depth = 0)
         {
             // Check vertices for null pointers.
diff --git a/src/Triangle/Voronoi/Legacy/SimpleVoronoi.cs b/src/Triangle/Voronoi/Legacy/SimpleVoronoi.cs
index c9a5a49..68a3d24 100644
--- a/src/Triangle/Voronoi/Legacy/SimpleVoronoi.cs
+++ b/src/Triangle/Voronoi/Legacy/SimpleVoronoi.cs
@@ -63,16 +63,17 @@ namespace TriangleNet.Voronoi.Legacy
             get { return regions.Values; }
         }
 
+        /// <summary>
+        /// Enumerates the edges of the Voronoi diagram.
+        /// </summary>
         public IEnumerable<IEdge> Edges
         {
             get { return EnumerateEdges(); }
         }
 
         /// <summary>
-        /// Gets the Voronoi diagram as raw output data.
+        /// Generate the Voronoi diagram.
         /// </summary>
-        /// <param name="mesh"></param>
-        /// <returns></returns>
         /// <remarks>
         /// The Voronoi diagram is the geometric dual of the Delaunay triangulation.
         /// Hence, the Voronoi vertices are listed by traversing the Delaunay
diff --git a/src/Triangle/Voronoi/VoronoiBase.cs b/src/Triangle/Voronoi/VoronoiBase.cs
index 69444de..c015dd3 100644
--- a/src/Triangle/Voronoi/VoronoiBase.cs
+++ b/src/Triangle/Voronoi/VoronoiBase.cs
@@ -19,12 +19,16 @@ namespace TriangleNet.Voronoi
     /// </summary>
     public abstract class VoronoiBase : DcelMesh
     {
+        /// <summary>Predicates</summary>
         protected IPredicates predicates;
 
+        /// <summary>Voronoi factory</summary>
         protected IVoronoiFactory factory;
 
-        // List of infinite half-edges, i.e. half-edges that start at circumcenters of triangles
-        // which lie on the domain boundary.
+        /// <summary>
+        /// List of infinite half-edges, i.e. half-edges that start at circumcenters
+        /// of triangles on the domain boundary.
+        /// </summary>
         protected List<HalfEdge> rays;
 
         /// <summary>
@@ -278,6 +282,7 @@ namespace TriangleNet.Voronoi
             }
         }
 
+        /// <inheritdoc />
         protected override IEnumerable<IEdge> EnumerateEdges()
         {
             var edges = new List<IEdge>(this.edges.Count / 2);