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

CGAL::Nef_polyhedron_3 description is imprecise #8787

Open
efifogel opened this issue Mar 17, 2025 · 0 comments
Open

CGAL::Nef_polyhedron_3 description is imprecise #8787

efifogel opened this issue Mar 17, 2025 · 0 comments

Comments

@efifogel
Copy link
Member

The description of CGAL::Nef_polyhedron_3 in the class template reference page is imprecise

  1. The class template is listed as having 2 template parameters (CGAL::Nef_polyhedron_3< Nef_polyhedronTraits_3, Nef_polyhedronItems_3 >), but then it is written, and I quote: "The second parameter and the third parameter are for future considerations. ". in fact the class template has 3 template parameters (CGAL::Nef_polyhedron_3< Nef_polyhedronTraits_3, Nef_polyhedronItems_3, Mark>). The last 2 parameters have default values. So, either add the 3rd missing parameter or drop the mentioning of the third parameter. I personally, prefer the former (true advertisement).
  2. The constructor: Nef_polyhedron_3 (Polyhedron &P) is a function template, and its signature is missing the template<class Polyhedron> part.
  3. This is minor (even more than the above...), but while at it we can improve the text. The sentence "The first parameter requires one of the following exact kernels: ...." should be made formal: "When the class template is instantiated, the first template parameter can be substituted by one of the following exact kernels: ...."

Source Code

Environment

  • Operating system (Windows/Mac/Linux, 32/64 bits):
  • Compiler:
  • Release or debug mode:
  • Specific flags used (if any):
  • CGAL version:
  • Boost version:
  • Other libraries versions if used (Eigen, TBB, etc.):
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant