Skip to content

CGAL::Nef_polyhedron_3 description is imprecise #8787

@efifogel

Description

@efifogel

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.):

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions