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
{
+ ///
+ /// Interface used to indicate support for file formats in the .
+ ///
public interface IFileFormat
{
+ ///
+ /// Test whether the given file is supported.
+ ///
+ /// The file to read.
+ /// Returns true if the file can be read.
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;
///
- /// Implements geometry and mesh file formats of the the original Triangle code.
+ /// Implements geometry and mesh file formats of the original Triangle project.
///
public class TriangleFormat : IPolygonFormat, IMeshFormat
{
- ///
- /// Returns a value indicating whether the given file is supported by this format.
- ///
- ///
- ///
+ ///
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
///
/// The quality constraints.
///
- /// A value indicating, if the refined mesh should be Conforming Delaunay.
+ /// A value indicating, whether the refined mesh should be Conforming Delaunay.
///
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).
/// Maximum edge count of faces (default = 0 means skip check).
///
+ ///
+ /// The 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 to 0 (default).
+ ///
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; }
}
+ ///
+ /// Enumerates the edges of the Voronoi diagram.
+ ///
public IEnumerable Edges
{
get { return EnumerateEdges(); }
}
///
- /// Gets the Voronoi diagram as raw output data.
+ /// Generate the Voronoi diagram.
///
- ///
- ///
///
/// 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
///
public abstract class VoronoiBase : DcelMesh
{
+ /// Predicates
protected IPredicates predicates;
+ /// Voronoi factory
protected IVoronoiFactory factory;
- // List of infinite half-edges, i.e. half-edges that start at circumcenters of triangles
- // which lie on the domain boundary.
+ ///
+ /// List of infinite half-edges, i.e. half-edges that start at circumcenters
+ /// of triangles on the domain boundary.
+ ///
protected List rays;
///
@@ -278,6 +282,7 @@ namespace TriangleNet.Voronoi
}
}
+ ///
protected override IEnumerable EnumerateEdges()
{
var edges = new List(this.edges.Count / 2);