Fixed documentation compliance (#132)

BHoM · Mar 26, 2024 · 06b99de · 06b99de
2 parents 33ee874 + 239e075
commit 06b99de
Show file tree

Hide file tree

Showing 4 changed files with 9 additions and 9 deletions.
diff --git a/TriangleNet_Engine/Compute/DelaunayTriangulation.cs b/TriangleNet_Engine/Compute/DelaunayTriangulation.cs
@@ -39,12 +39,12 @@ public static partial class Compute
         /****      public Methods                       ****/
         /***************************************************/
 
-        [Description("Create a Delaunay mesh from an outline and holes")]
-        [Input("outerCurve", "A BHoM Polyline representing the mesh boundary")]
-        [Input("innerCurves", "A list of holes to \"punch\" through the mesh generated mesh")]
-        [Input("offsetDistance", "Offset distance for innerCurves which have coincident edges - needs to be a negative value for inwards based offsetting, default -0.001", typeof(Length))]
-        [Input("conformingDelaunay", "Choose whether or not to have the resulting triangulation conform to Delaunay principles. This will give a higher detail triangulation. Default true")]
-        [Output("curve", "A list of BHoM Polylines")]
+        [Description("Create a Delaunay mesh from an outline and holes.")]
+        [Input("outerCurve", "A BHoM Polyline representing the mesh boundary.")]
+        [Input("innerCurves", "A list of holes to \"punch\" through the mesh generated mesh.")]
+        [Input("offsetDistance", "Offset distance for innerCurves which have coincident edges - needs to be a negative value for inwards based offsetting, default -0.001.", typeof(Length))]
+        [Input("conformingDelaunay", "Choose whether or not to have the resulting triangulation conform to Delaunay principles. This will give a higher detail triangulation. Default true.")]
+        [Output("curve", "A list of BHoM Polylines.")]
         public static List<Polyline> DelaunayTriangulation(this Polyline outerCurve, List<Polyline> innerCurves = null, double offsetDistance = -0.001, bool conformingDelaunay = true)
         {
             if (outerCurve == null)

diff --git a/TriangleNet_Engine/Compute/VoronoiRegions.cs b/TriangleNet_Engine/Compute/VoronoiRegions.cs
@@ -45,8 +45,8 @@ public static partial class Compute
         [Description("Creates a voronoi diagram from a list of coplanar, non-duplicate points. The returned polylines cells will correspond to the input points by index.")]
         [Input("points", "The coplanar points to use to generate the voronoi diagram. The algorithm can currently not handle colinear points.")]
         [Input("plane", "Optional plane for the voronoi. If provided, all points must be complanar with the plane. If nothing provided, a best fit plane will be calculated. For colinear points, if nothing no plane provided, a plane aligned with the global Z-axis will be created.")]
-        [Input("tolerance", "Tolerance to be used in the method.", typeof(Length))]
         [Input("boundarySize", "To handle problems at boundaries, extra points are added outside the bounds of the provided points for the generation of the voronoi and then culled away. This value controls how far off these points should be created. If a zero or negative value is provided, this value will be calculated automatically, based on the size of the boundingbox of the provided points.", typeof(Length))]
+        [Input("tolerance", "Tolerance to be used in the method.", typeof(Length))]
         [Output("regions", "Voronoi regions calculated by the method. The position in the list will correspond to the position in the list of the provided points.")]
         public static List<Polyline> VoronoiRegions(List<Point> points, Plane plane = null, double boundarySize = -1, double tolerance = Tolerance.Distance)
         {

diff --git a/TriangleNet_Engine/Modify/Representation/RenderMesh/SetRendermesh.cs b/TriangleNet_Engine/Modify/Representation/RenderMesh/SetRendermesh.cs
@@ -37,7 +37,7 @@ public static partial class Modify
     {
         [Description("Sets a RenderMesh in the Fragments of the BHoMObject.\n" +
            "If specified, the `meshRepresentation` should contain a valid mesh representation for the BHoMObject." +
-           "If meshRepresentation is null, attempts to compute a Rendermesh for the object. ")]
+           "If meshRepresentation is null, attempts to compute a Rendermesh for the object.")]
         [Input("bHoMObject", "BHoMObject to set the representation for.")]
         [Input("meshRepresentation", "A valid mesh representation for the BHoMObject.")]
         public static IBHoMObject ISetRendermesh(this IBHoMObject bHoMObject, object meshRepresentation = null, RenderMeshOptions renderMeshOptions = null)

diff --git a/TriangleNet_Engine/Query/Representation/RenderMesh/TryGetRendermesh.cs b/TriangleNet_Engine/Query/Representation/RenderMesh/TryGetRendermesh.cs
@@ -36,7 +36,7 @@ namespace BH.Engine.Representation
 {
     public static partial class Query
     {
-        [Description("Retrieves a representation from the specified IBHoMObject's Fragments, if present. Returns it as a RenderMesh.\n")]
+        [Description("Retrieves a representation from the specified IBHoMObject's Fragments, if present. Returns it as a RenderMesh.")]
         public static bool TryGetRendermesh(this IBHoMObject bHoMObject, out RenderMesh renderMesh)
         {
             renderMesh = null;