Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Surface Mesh Approxination, non documented variables #8557

Closed
albert-github opened this issue Oct 17, 2024 · 2 comments
Closed

Surface Mesh Approxination, non documented variables #8557

albert-github opened this issue Oct 17, 2024 · 2 comments

Comments

@albert-github
Copy link
Contributor

When generating the documentation with GENERATED_XML=YES we get the warnings:

.../Surface_mesh_approximation/include/CGAL/Variational_shape_approximation.h:1531: warning: The following parameter of CGAL::Variational_shape_approximation::find_edges(const FT subdivision_ratio, const FT boundary_subdivision_ratio, const bool relative_to_chord, const bool with_dihedral_angle) is not documented:
  parameter 'boundary_subdivision_ratio'
.../Surface_mesh_approximation/include/CGAL/Variational_shape_approximation.h:1853: warning: The following parameter of CGAL::Variational_shape_approximation::subdivide_chord(const Boundary_chord_iterator &chord_begin, const Boundary_chord_iterator &chord_end, const FT subdivision_ratio, const FT boundary_subdivision_ratio, const bool relative_to_chord, const bool with_dihedral_angle) is not documented:
  parameter 'boundary_subdivision_ratio'

in the "normal" documentation run we don't see these messages.

@sloriot
Copy link
Member

sloriot commented Oct 17, 2024

Note that these are in private function so they shouldn't be reported. I fixed them nonetheless.

@albert-github
Copy link
Contributor Author

Closed as completed by #8555

@lrineau lrineau added this to the 6.0.1 milestone Oct 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants