docs(doxygen): 100% public-API coverage (228 → 0 undocumented)
Completes the work begun in the previous commit on this branch. Every
public symbol under code/include/ now carries a brief Doxygen comment
(0 undocumented per scripts/doxygen-coverage.sh, with the `detail::`
implementation namespaces excluded as before).
Trajectory on this branch:
start (after Doxyfile fix): 24.0 % (165 / 437 in the no-detail set
was 105 / 437 when detail counted)
after PR #17 base commit : 42.4 % (165 / 396)
this commit : 100.0 % (396 / 396)
Files touched (all .hpp / .h headers under code/include/):
* cgal/Conformal_map_traits.h
* clausen.hpp, conformal_mesh.hpp, constants.hpp (already docd)
* cp_euclidean_functional.hpp, cut_graph.hpp, discrete_elliptic_utility.hpp
* euclidean_functional.hpp, euclidean_geometry.hpp, euclidean_hessian.hpp
* fundamental_domain.hpp, gauss_bonnet.hpp
* hyper_ideal_{functional,geometry,hessian,utility,visualization_utility}.hpp
* inversive_distance_functional.hpp, layout.hpp
* matrix_utility.hpp, mesh_builder.hpp, mesh_io.hpp
* newton_solver.hpp, p2_utility.hpp, period_matrix.hpp, projective_math.hpp
* serialization.hpp, spherical_functional.hpp, spherical_geometry.hpp
* spherical_hessian.hpp, viewer_utils.h
CI:
.gitea/workflows/doxygen-pages.yml now enforces
`scripts/doxygen-coverage.sh --threshold 100`, so any future regression
(a new public function landed without a `///` brief) fails the build
before the Doxygen HTML is published to Codeberg Pages.
Doxygen warnings remain at 0.
Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
This commit is contained in:
@@ -12,9 +12,9 @@
|
||||
|
||||
namespace conformallab {
|
||||
|
||||
// Volume of a generalized hyperbolic tetrahedron with dihedral angles A..F.
|
||||
// Formula: Meyerhoff / Ushijima (Springer 2006).
|
||||
// Corresponds to Java HyperIdealUtility.calculateTetrahedronVolume().
|
||||
/// Volume of a generalized hyperbolic tetrahedron with dihedral
|
||||
/// angles `A,…,F` via the Meyerhoff / Ushijima 2006 formula.
|
||||
/// Same as Java `HyperIdealUtility.calculateTetrahedronVolume()`.
|
||||
inline double calculateTetrahedronVolume(double A, double B, double C,
|
||||
double D, double E, double F) {
|
||||
// PI from constants.hpp (conformallab::PI)
|
||||
@@ -73,11 +73,9 @@ inline double calculateTetrahedronVolume(double A, double B, double C,
|
||||
return (U(z1) - U(z2)) / 2.0;
|
||||
}
|
||||
|
||||
// Volume of a hyperideal tetrahedron with one ideal vertex (at gamma).
|
||||
// Dihedral angles at the ideal vertex: gamma1, gamma2, gamma3.
|
||||
// Dihedral angles at opposite edges: alpha23, alpha31, alpha12.
|
||||
// Formula: Kolpakov–Mednykh (arxiv math/0603097).
|
||||
// Corresponds to Java HyperIdealUtility.calculateTetrahedronVolumeWithIdealVertexAtGamma().
|
||||
/// Volume of a hyperideal tetrahedron with one ideal vertex at γ via
|
||||
/// the Kolpakov-Mednykh formula (arxiv math/0603097). Same as Java
|
||||
/// `HyperIdealUtility.calculateTetrahedronVolumeWithIdealVertexAtGamma()`.
|
||||
inline double calculateTetrahedronVolumeWithIdealVertexAtGamma(
|
||||
double gamma1, double gamma2, double gamma3,
|
||||
double alpha23, double alpha31, double alpha12)
|
||||
|
||||
Reference in New Issue
Block a user