Improve documentation ✍🏻

src/Plankton/PlanktonFaceList.cs

@@ -8,7 +8,7 @@
 namespace Plankton
 {
     /// <summary>
-    /// Provides access to the faces and Face related functionality of a Mesh.
+    /// Provides access to the faces and <see cref="PlanktonFace"/> related functionality of a Mesh.
     /// </summary>
     public class PlanktonFaceList : IEnumerable<PlanktonFace>
     {
@@ -19,7 +19,7 @@ public class PlanktonFaceList : IEnumerable<PlanktonFace>
         /// Initializes a new instance of the <see cref="PlanktonFaceList"/> class.
         /// Should be called from the mesh constructor.
         /// </summary>
-        /// <param name="owner">The mesh to which this list of half-edges belongs.</param>
+        /// <param name="owner">The <see cref="PlanktonMesh"/> to which this list of half-edges belongs.</param>
         internal PlanktonFaceList(PlanktonMesh owner)
         {
             this._list = new List<PlanktonFace>();
@@ -303,7 +303,7 @@ public void RemoveFace(int index)
         }
 
         /// <summary>
-        /// Returns the face at the given index.
+        /// Returns the <see cref="PlanktonFace"/> at the given index.
         /// </summary>
         /// <param name="index">
         /// Index of face to get.

src/Plankton/PlanktonHalfedgeList.cs

@@ -6,7 +6,7 @@
 namespace Plankton
 {
     /// <summary>
-    /// Provides access to the halfedges and Halfedge related functionality of a Mesh.
+    /// Provides access to the halfedges and <see cref="PlanktonHalfedge"/> related functionality of a Mesh.
     /// </summary>
     public class PlanktonHalfEdgeList : IEnumerable<PlanktonHalfedge>
     {
@@ -17,7 +17,7 @@ public class PlanktonHalfEdgeList : IEnumerable<PlanktonHalfedge>
         /// Initializes a new instance of the <see cref="PlanktonHalfedgeList"/> class.
         /// Should be called from the mesh constructor.
         /// </summary>
-        /// <param name="owner">The mesh to which this list of halfedges belongs.</param>
+        /// <param name="owner">The <see cref="PlanktonMesh"/> to which this list of halfedges belongs.</param>
         internal PlanktonHalfEdgeList(PlanktonMesh owner)
         {
             this._list = new List<PlanktonHalfedge>();
@@ -100,7 +100,7 @@ internal void RemovePairHelper(int index)
         }
 
         /// <summary>
-        /// Returns the halfedge at the given index.
+        /// Returns the <see cref="PlanktonHalfedge"/> at the given index.
         /// </summary>
         /// <param name="index">
         /// Index of halfedge to get.

src/Plankton/PlanktonMesh.cs

@@ -1,12 +1,11 @@
-//using Rhino.Geometry;
-using System;
+using System;
 using System.Collections.Generic;
 using System.Linq;
 
 namespace Plankton
 {
     /// <summary>
-    /// Description of PlanktonMesh.
+    /// This is the main class that describes a plankton mesh.
     /// </summary>
     public class PlanktonMesh
     {
@@ -15,10 +14,16 @@ public class PlanktonMesh
         private PlanktonFaceList _faces;
 
         #region "constructors"
-        public PlanktonMesh() //blank constructor
+        /// <summary>
+        /// Initializes a new (empty) instance of the <see cref="PlanktonMesh"/> class.
+        /// </summary>
+        public PlanktonMesh()
         {
         }
-
+
+        /// <summary>
+        /// Initializes a new (duplicate) instance of the <see cref="PlanktonMesh"/> class.
+        /// </summary>
         public PlanktonMesh(PlanktonMesh source)
         {
             foreach (var v in source.Vertices)
@@ -48,23 +53,23 @@ public PlanktonMesh(PlanktonMesh source)
 
         #region "properties"
         /// <summary>
-        /// Gets access to the vertices collection in this mesh.
+        /// Gets access to the <see cref="PlanktonVertexList"/> collection in this mesh.
         /// </summary>
         public PlanktonVertexList Vertices
         {
             get { return _vertices ?? (_vertices = new PlanktonVertexList(this)); }
         }
 
         /// <summary>
-        /// Gets access to the halfedges collection in this mesh.
+        /// Gets access to the <see cref="PlanktonHalfedgeList"/> collection in this mesh.
         /// </summary>
         public PlanktonHalfEdgeList Halfedges
         {
             get { return _halfedges ?? (_halfedges = new PlanktonHalfEdgeList(this)); }
         }
 
         /// <summary>
-        /// Gets access to the faces collection in this mesh.
+        /// Gets access to the <see cref="PlanktonFaceList"/> collection in this mesh.
         /// </summary>
         public PlanktonFaceList Faces
         {

src/Plankton/PlanktonVertexList.cs

@@ -6,7 +6,7 @@
 namespace Plankton
 {
     /// <summary>
-    /// Provides access to the vertices and Vertex related functionality of a Mesh.
+    /// Provides access to the vertices and <see cref="PlanktonVertex"/> related functionality of a Mesh.
     /// </summary>
     public class PlanktonVertexList : IEnumerable<PlanktonVertex>
     {
@@ -17,7 +17,7 @@ public class PlanktonVertexList : IEnumerable<PlanktonVertex>
         /// Initializes a new instance of the <see cref="PlanktonVertexList"/> class.
         /// Should be called from the mesh constructor.
         /// </summary>
-        /// <param name="owner">The mesh to which this list of vertices belongs.</param>
+        /// <param name="owner">The <see cref="PlanktonMesh"/> to which this list of vertices belongs.</param>
         internal PlanktonVertexList(PlanktonMesh owner)
         {
             this._list = new List<PlanktonVertex>();
@@ -97,7 +97,7 @@ public int[] AddVertices(IEnumerable<PlanktonXYZ> vertices)
         }
 
         /// <summary>
-        /// Returns the vertex at the given index.
+        /// Returns the <see cref="PlanktonVertex"/> at the given index.
         /// </summary>
         /// <param name="index">
         /// Index of vertex to get.