Test for undocumented names, update docs

Author: j-fu

CHANGELOG.md

@@ -9,6 +9,7 @@ All notable changes to this project since V1.0 will be documented in this file.
   The RawTetGenIO based API is not affected. Users who
   rely on the RawTetGenIO based API can use  `TetGen="1,2"` 
   in their `[compat]` section.
+- Breaking: remove deprecated `tetunsuitable`. Use `tetunsuitable!` instead
 
 ## [1.5.1] - 2024-02-27
 

README.md

@@ -64,7 +64,7 @@ Plotted with Makie:
 ```julia
 using TetGen
 let
-    tetunsuitable() do pa,pb,pc,pd
+    tetunsuitable!() do pa,pb,pc,pd
         vol=det(hcat(pb-pa,pc-pa,pd-pa))/6
         center=0.25*(pa+pb+pc+pd)-[0.5,0.5,0.5]
         vol> 0.05*norm(center)^2.5

docs/make.jl

@@ -4,7 +4,6 @@ function make_all()
     makedocs(;
              sitename = "TetGen.jl",
              modules = [TetGen],
-             warnonly = true,
              clean = false,
              doctest = false,
              authors = "Simon Danisch, Juergen Fuhrmann",

docs/src/index.md

@@ -14,6 +14,8 @@ Modules = [TetGen]
 Pages = ["api.jl"]
 ```
 
+
+
 ## Raw API
 This API is closer to TetGen's C++ API in the sense that
 input and output are described using arrays of integers
@@ -40,3 +42,8 @@ tetunsuitable!
   Link to preprint  [here](http://doi.org/10.20347/WIAS.PREPRINT.1762). 
 
 
+## Internal API
+```@autodocs
+Modules = [TetGen]
+Pages = ["meshes.jl", "jltetgenio.jl", "cpptetgenio.jl"]
+```

src/TetGen.jl

@@ -1,3 +1,8 @@
+"""
+    TetGen
+
+$(read(joinpath(@__DIR__,"..","README.md"),String))
+"""
 module TetGen
 using DocStringExtensions: DocStringExtensions, SIGNATURES, TYPEDEF,
                            TYPEDFIELDS, TYPEDSIGNATURES
@@ -17,7 +22,7 @@ include("meshes.jl")
 include("api.jl")
 
 export tetrahedralize
-export tetunsuitable!, tetunsuitable
+export tetunsuitable!
 export TetGenError
 export RawTetGenIO, facetlist!, RawFacet
 export numberofpoints, numberoftetrahedra, numberoftrifaces, numberofedges

src/api.jl

@@ -1,5 +1,5 @@
 """
-$(SIGNATURES)
+    voronoi(points::Vector{Point{3, T}})  where {T <: AbstractFloat}
 
 Create voronoi diagram of point set.    
 
@@ -14,7 +14,14 @@ end
 $(SIGNATURES)
 
 Tetrahedralize a mesh of polygons with optional facet markers.
-Returns a mesh of tetrahdra.
+Returns a mesh of tetrahdra. 
+
+With `GeometryBasics` version 0.4, the input mesh has to be a `GeometryBasics.Mesh` with
+possible metadata. With `GeometryBasics` version 0.5, the input mesh has to be a `GeometryBasics.MetaMesh`.
+
+Default command is "Qp", creating the Delaunay
+triangulation of the point set. See the list of
+possible flags in the documentation of [`tetrahedralize(::RawTetGenIO, flags)`](@ref).
 """
 function TetGen.tetrahedralize(mesh, command = "Qp";
                                marker = :markers, holes = Point{3, Float64}[])

src/cpptetgenio.jl

@@ -149,5 +149,3 @@ function tetunsuitable!(unsuitable::Function; check_signature = true)
     c_wrap_tetunsuitable = @cfunction(jl_wrap_tetunsuitable, Cint, (Ptr{Cdouble}, Ptr{Cdouble}, Ptr{Cdouble}, Ptr{Cdouble}))
     ccall((:tetunsuitable_callback, libtet), Cvoid, (Ptr{Cvoid},), c_wrap_tetunsuitable)
 end
-
-@deprecate tetunsuitable(unsuitable::Function; kwargs...) tetunsuitable!(unsuitable::Function; kwargs...)

test/runtests.jl

@@ -287,3 +287,9 @@ end
 @testset "Aqua" begin
     Aqua.test_all(TetGen)
 end
+
+if isdefined(Docs, :undocumented_names)
+    @testset "UndocumentedNames" begin
+        @test isempty(Docs.undocumented_names(TetGen))
+    end
+end