diff --git a/src/Plankton/PlanktonFaceList.cs b/src/Plankton/PlanktonFaceList.cs index 997d401..4d57187 100644 --- a/src/Plankton/PlanktonFaceList.cs +++ b/src/Plankton/PlanktonFaceList.cs @@ -8,7 +8,7 @@ namespace Plankton { /// - /// Provides access to the faces and Face related functionality of a Mesh. + /// Provides access to the faces and related functionality of a Mesh. /// public class PlanktonFaceList : IEnumerable { @@ -19,7 +19,7 @@ public class PlanktonFaceList : IEnumerable /// Initializes a new instance of the class. /// Should be called from the mesh constructor. /// - /// The mesh to which this list of half-edges belongs. + /// The to which this list of half-edges belongs. internal PlanktonFaceList(PlanktonMesh owner) { this._list = new List(); @@ -303,7 +303,7 @@ public void RemoveFace(int index) } /// - /// Returns the face at the given index. + /// Returns the at the given index. /// /// /// Index of face to get. diff --git a/src/Plankton/PlanktonHalfedgeList.cs b/src/Plankton/PlanktonHalfedgeList.cs index f66ea6d..83e696d 100644 --- a/src/Plankton/PlanktonHalfedgeList.cs +++ b/src/Plankton/PlanktonHalfedgeList.cs @@ -6,7 +6,7 @@ namespace Plankton { /// - /// Provides access to the halfedges and Halfedge related functionality of a Mesh. + /// Provides access to the halfedges and related functionality of a Mesh. /// public class PlanktonHalfEdgeList : IEnumerable { @@ -17,7 +17,7 @@ public class PlanktonHalfEdgeList : IEnumerable /// Initializes a new instance of the class. /// Should be called from the mesh constructor. /// - /// The mesh to which this list of halfedges belongs. + /// The to which this list of halfedges belongs. internal PlanktonHalfEdgeList(PlanktonMesh owner) { this._list = new List(); @@ -100,7 +100,7 @@ internal void RemovePairHelper(int index) } /// - /// Returns the halfedge at the given index. + /// Returns the at the given index. /// /// /// Index of halfedge to get. diff --git a/src/Plankton/PlanktonMesh.cs b/src/Plankton/PlanktonMesh.cs index 76416a9..679bf03 100644 --- a/src/Plankton/PlanktonMesh.cs +++ b/src/Plankton/PlanktonMesh.cs @@ -1,12 +1,11 @@ -//using Rhino.Geometry; -using System; +using System; using System.Collections.Generic; using System.Linq; namespace Plankton { /// - /// Description of PlanktonMesh. + /// This is the main class that describes a plankton mesh. /// public class PlanktonMesh { @@ -15,10 +14,16 @@ public class PlanktonMesh private PlanktonFaceList _faces; #region "constructors" - public PlanktonMesh() //blank constructor + /// + /// Initializes a new (empty) instance of the class. + /// + public PlanktonMesh() { } - + + /// + /// Initializes a new (duplicate) instance of the class. + /// public PlanktonMesh(PlanktonMesh source) { foreach (var v in source.Vertices) @@ -48,7 +53,7 @@ public PlanktonMesh(PlanktonMesh source) #region "properties" /// - /// Gets access to the vertices collection in this mesh. + /// Gets access to the collection in this mesh. /// public PlanktonVertexList Vertices { @@ -56,7 +61,7 @@ public PlanktonVertexList Vertices } /// - /// Gets access to the halfedges collection in this mesh. + /// Gets access to the collection in this mesh. /// public PlanktonHalfEdgeList Halfedges { @@ -64,7 +69,7 @@ public PlanktonHalfEdgeList Halfedges } /// - /// Gets access to the faces collection in this mesh. + /// Gets access to the collection in this mesh. /// public PlanktonFaceList Faces { diff --git a/src/Plankton/PlanktonVertexList.cs b/src/Plankton/PlanktonVertexList.cs index 1614c55..cb056be 100644 --- a/src/Plankton/PlanktonVertexList.cs +++ b/src/Plankton/PlanktonVertexList.cs @@ -6,7 +6,7 @@ namespace Plankton { /// - /// Provides access to the vertices and Vertex related functionality of a Mesh. + /// Provides access to the vertices and related functionality of a Mesh. /// public class PlanktonVertexList : IEnumerable { @@ -17,7 +17,7 @@ public class PlanktonVertexList : IEnumerable /// Initializes a new instance of the class. /// Should be called from the mesh constructor. /// - /// The mesh to which this list of vertices belongs. + /// The to which this list of vertices belongs. internal PlanktonVertexList(PlanktonMesh owner) { this._list = new List(); @@ -97,7 +97,7 @@ public int[] AddVertices(IEnumerable vertices) } /// - /// Returns the vertex at the given index. + /// Returns the at the given index. /// /// /// Index of vertex to get.