You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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.
The text was updated successfully, but these errors were encountered:
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).
When generating the documentation with
GENERATED_XML=YES
we get the warnings:in the "normal" documentation run we don't see these messages.
The text was updated successfully, but these errors were encountered: