Poisson_surface_reconstruction_3: Incorrect Documentation #6584

Skip to content Dismiss alert {{ message }} CGAL / cgal Public

• Notifications You must be signed in to change notification settings
• Fork 1.5k
• Star 5.7k

• Code
• Issues 511
• Pull requests 157
• Discussions
• Actions
• Projects
• Wiki
• Security

  Uh oh!

  There was an error while loading. Please reload this page.

• Insights

Additional navigation options

Poisson_surface_reconstruction_3: Incorrect documentation #6584New issueCopy linkNew issueCopy linkClosed#6591ClosedPoisson_surface_reconstruction_3: Incorrect documentation#6584#6591Copy linkAssignees LabelsDoc bugPkg::Poisson_surface_reconstruction_3Milestone5.5-beta

Description

albert-githubopened on May 15, 2022Issue body actions

Doing some extra tests on the CGAL documentation (setting GENERATE_XML=YES), the following warning appeared:

.../Poisson_surface_reconstruction_3/include/CGAL/Poisson_reconstruction_function.h:766: warning: Found unknown command '@commentheading' .../Poisson_surface_reconstruction_3/include/CGAL/Poisson_reconstruction_function.h:764: warning: argument 'SparseLinearAlgebraTraits_d' of command @param is not found in the argument list of CGAL::Poisson_reconstruction_function< Gt >::solve_poisson(SparseLinearAlgebraTraits_d solver, double lambda) .../Poisson_surface_reconstruction_3/include/CGAL/Poisson_reconstruction_function.h:764: warning: The following parameter of CGAL::Poisson_reconstruction_function::solve_poisson(SparseLinearAlgebraTraits_d solver, double lambda) is not documented: parameter 'lambda' .../Poisson_surface_reconstruction_3/include/CGAL/Poisson_reconstruction_function.h:1206: warning: Found unknown command '@commentheading' .../Poisson_surface_reconstruction_3/include/CGAL/Poisson_reconstruction_function.h:1206: warning: argument 'SparseLinearAlgebraTraits_d' of command @param is not found in the argument list of CGAL::Poisson_reconstruction_function< Gt >::assemble_poisson_row(typename SparseLinearAlgebraTraits_d::Matrix &A, Vertex_handle vi, typename SparseLinearAlgebraTraits_d::Vector &B, double lambda) .../Poisson_surface_reconstruction_3/include/CGAL/Poisson_reconstruction_function.h:1206: warning: The following parameters of CGAL::Poisson_reconstruction_function::assemble_poisson_row(typename SparseLinearAlgebraTraits_d::Matrix &A, Vertex_handle vi, typename SparseLinearAlgebraTraits_d::Vector &B, double lambda) are not documented: parameter 'A' parameter 'vi' parameter 'B' parameter 'lambda' .../Poisson_surface_reconstruction_3/include/CGAL/Reconstruction_triangulation_3.h:351: warning: Found unknown command '@commentheading' .../Poisson_surface_reconstruction_3/include/CGAL/Reconstruction_triangulation_3.h:349: warning: argument 'InputIterator' of command @param is not found in the argument list of CGAL::Reconstruction_triangulation_3< BaseGt, Gt, Tds_ >::insert(InputIterator first, InputIterator beyond, PointPMap point_pmap, NormalPMap normal_pmap, Visitor visitor) .../Poisson_surface_reconstruction_3/include/CGAL/Reconstruction_triangulation_3.h:349: warning: argument 'PointPMap' of command @param is not found in the argument list of CGAL::Reconstruction_triangulation_3< BaseGt, Gt, Tds_ >::insert(InputIterator first, InputIterator beyond, PointPMap point_pmap, NormalPMap normal_pmap, Visitor visitor) .../Poisson_surface_reconstruction_3/include/CGAL/Reconstruction_triangulation_3.h:349: warning: argument 'NormalPMap' of command @param is not found in the argument list of CGAL::Reconstruction_triangulation_3< BaseGt, Gt, Tds_ >::insert(InputIterator first, InputIterator beyond, PointPMap point_pmap, NormalPMap normal_pmap, Visitor visitor) .../Poisson_surface_reconstruction_3/include/CGAL/Reconstruction_triangulation_3.h:349: warning: The following parameter of CGAL::Reconstruction_triangulation_3::insert(InputIterator first, InputIterator beyond, PointPMap point_pmap, NormalPMap normal_pmap, Visitor visitor) is not documented: parameter 'visitor' .../Poisson_surface_reconstruction_3/include/CGAL/IO/output_surface_facets_to_triangle_soup.h:29: warning: Found unknown command '@commentheading'

Even though the function is not part of the official documentation the documentation of the function should be correct.

Metadata

Metadata

Assignees

• afabri

Labels

Doc bugPkg::Poisson_surface_reconstruction_3

Type

No type

Projects

No projects

Milestone

• 5.5-beta

Relationships

None yet

Development

No branches or pull requests

Issue actions

You can’t perform that action at this time.