start some docstrings

Author: sjkelly

src/distmeshnd.jl

@@ -35,7 +35,12 @@ function distmesh(fdist::Function,
     distmesh(fdist, fh, h, setup, o, w, fp, Val(stats), VT)
 end
 
+"""
+    DistMeshResult
 
+A struct returned from the `distmesh` function that includes point, simplex,
+and interation statistics.
+"""
 struct DistMeshResult{PT, TT, STATS}
     points::Vector{PT}
     tetrahedra::Vector{TT}
@@ -183,6 +188,16 @@ function distmesh(fdist::Function,
     end
 end
 
+"""
+    retriangulate!
+
+
+Given a point set, generate a delaunay triangulation, and other requirements.
+This includes:
+    - Spatial sorting of points
+    - Delaunay triangulation
+    - Filtering of invalid tetrahedra outside the boundary
+"""
 function retriangulate!(fdist, result::DistMeshResult, geps, setup, triangulationcount, pt_dists)
     # use hilbert sort to improve cache locality of points
     if setup.sort && iszero(triangulationcount % setup.sort_interval)

src/hilbertsort.jl

@@ -137,5 +137,9 @@ end
 
 #hilbertsort!(a::Array{T,1}) where {T<:AbstractPoint2D} = hilbertsort!(backward, backward, coordinatey, a, 1, length(a))
 #hilbertsort!(a::Array{T,1}, lo::Int64, hi::Int64, lim::Int64) where {T<:AbstractPoint2D} = hilbertsort!(backward, backward, coordinatey, a, lo, hi, lim)
+"""
+Hilbert Sorting. If `carry` is specified, this array will be permuted in line with the
+specified array.
+"""
 hilbertsort!(a::Vector, carry=nothing) = hilbertsort!(backward, backward, backward, coordinatez, a, 1, length(a), 8, carry)
 hilbertsort!(a::Vector, lo::Int64, hi::Int64, lim::Int64) = hilbertsort!(backward, backward, backward, coordinatey, a, lo, hi, lim)