-
Notifications
You must be signed in to change notification settings - Fork 1.4k
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
Problem with the documentation of Mesh_3 #7767
Comments
All the duplicate definitions should have been removed from |
The PR #7445 indicates that the code in
as here there are 2 files added (and is very unlikely I would add files in the "kernel" of CGAL) i.e.
I locally removed these 2 files and ran the documentation build procedure on the Mesh_3 directory and the documentation looks OK (visual inspection). I also ran my link checker (that actually detected the problem) and also here I didn't see any problems regarding Mesh_3.
|
Sure, feel free to go ahead! |
I've just pushed a proposed patch, pull request #7768 |
issue #7767 Problem with the documenation of Mesh_3
When looking at the documentation of Mesh_3 (https://cgal.geometryfactory.com/CGAL/Manual_doxygen_test/CGAL-6.0-I-80/master/Mesh_3/classCGAL_1_1Polyhedral__mesh__domain__with__features__3.html) we see that a lot of the documentation is duplicated e.g. (but there is more and it is also with the 1.8.13 and 1.9.6 runs)
I just looked at the
detect_borders()
( as I saw here "Detects" and "detect" so easy search) and found these texts in:Mesh_3/doc/Mesh_3/CGAL/Polyhedral_mesh_domain_with_features_3.h
andMesh_3/include/CGAL/Polyhedral_mesh_domain_with_features_3.h
Removing the comment from
Mesh_3/include/CGAL/Polyhedral_mesh_domain_with_features_3.h
already improved the situation, though I think the real problem is conceptual, we have double definitions of the functions (Mesh_3/doc/Mesh_3/CGAL/Polyhedral_mesh_domain_with_features_3.h
andMesh_3/include/CGAL/Polyhedral_mesh_domain_with_features_3.h
) and both parts are added as input as part of theINPUT
for doxygen, see alsodoc/Mesh_3/Doxyfile.in
where quite a list of files is present.The text was updated successfully, but these errors were encountered: