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

Kinetic Space Partition: documenting functions #8558

Closed
albert-github opened this issue Oct 17, 2024 · 2 comments · Fixed by #8555
Closed

Kinetic Space Partition: documenting functions #8558

albert-github opened this issue Oct 17, 2024 · 2 comments · Fixed by #8555

Comments

@albert-github
Copy link
Contributor

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

.../Kinetic_space_partition/include/CGAL/Kinetic_space_partition_3.h:1051: warning: The following parameter of CGAL::Kinetic_space_partition_3::faces(std::size_t volume_index, OutputIterator it) const is not documented:
  parameter 'it'
.../Kinetic_space_partition/include/CGAL/Kinetic_space_partition_3.h:1096: warning: argument 'volume_index' of command @param is not found in the argument list of CGAL::Kinetic_space_partition_3< GeomTraits, IntersectionTraits >::vertices(const Index &face_index, OutputIterator it) const
.../Kinetic_space_partition/include/CGAL/Kinetic_space_partition_3.h:1096: warning: The following parameters of CGAL::Kinetic_space_partition_3::vertices(const Index &face_index, OutputIterator it) const are not documented:
  parameter 'face_index'
  parameter 'it'
.../Kinetic_space_partition/include/CGAL/Kinetic_space_partition_3.h:1119: warning: argument 'volume_index' of command @param is not found in the argument list of CGAL::Kinetic_space_partition_3< GeomTraits, IntersectionTraits >::exact_vertices(const Index &face_index, OutputIterator it) const
.../Kinetic_space_partition/include/CGAL/Kinetic_space_partition_3.h:1119: warning: The following parameters of CGAL::Kinetic_space_partition_3::exact_vertices(const Index &face_index, OutputIterator it) const are not documented:
  parameter 'face_index'
  parameter 'it'

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

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

  • This explains why the were not seen by the normal run as here private functions etc. (EXTRACT_PRIVATE=NO) are not taken into consideration but the purpose of the XML output is that the user of the XML output can decide and thus are the private functions etc. included in the XML output.
  • even though they are not used in the "normal" documentation the documentation of these function should, in my opinion, be correct (when they are documented).

@lrineau lrineau linked a pull request Oct 18, 2024 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants