Skip to content

Conversation

@albert-github
Copy link
Contributor

The overnight documentation build gives a warning (with the doxygen master version):

/home/cgal-testsuite/cgal_doc_build/CGAL-6.2-Ic-24/include/CGAL/Frechet_distance/Neighbor_search.h:106: warning: no matching class member found for
  template < PointRange, Traits >
  std::vector< std::size_t > CGAL::Frechet_distance::Neighbor_search< PointRange, Traits >::get_close_curves(const PointRange &curve, double distance, Sequential_tag) ->std::vector< std::size_t >
Possible candidates:
  'template < ConcurrencyTag >
  std::vector< std::size_t > CGAL::Frechet_distance::Neighbor_search< PointRange, Traits >::get_close_curves(const PointRange &query, double distance)' at line 79 of file /home/cgal-testsuite/cgal_doc_build/CGAL-6.2-Ic-24/include/CGAL/Frechet_distance/Neighbor_search.h
  'std::vector< std::size_t > CGAL::Frechet_distance::Neighbor_search< PointRange, Traits >::get_close_curves(const PointRange &query, double distance, Sequential_tag)' at line 90 of file /home/cgal-testsuite/cgal_doc_build/CGAL-6.2-Ic-24/include/CGAL/Frechet_distance/Neighbor_search.h

In principle the code is correct but due to the double usage of std::vector< std::size_t > doxygen has a small problem (since the integration of the fix for doxygen/doxygen#11787). The workaround as used by CGAL is not necessary.

(tested documentation against doxygen master version and dixygen 1.9.6)

The overnight documentation build gives a warning (with the doxygen master version):
```
/home/cgal-testsuite/cgal_doc_build/CGAL-6.2-Ic-24/include/CGAL/Frechet_distance/Neighbor_search.h:106: warning: no matching class member found for
  template < PointRange, Traits >
  std::vector< std::size_t > CGAL::Frechet_distance::Neighbor_search< PointRange, Traits >::get_close_curves(const PointRange &curve, double distance, Sequential_tag) ->std::vector< std::size_t >
Possible candidates:
  'template < ConcurrencyTag >
  std::vector< std::size_t > CGAL::Frechet_distance::Neighbor_search< PointRange, Traits >::get_close_curves(const PointRange &query, double distance)' at line 79 of file /home/cgal-testsuite/cgal_doc_build/CGAL-6.2-Ic-24/include/CGAL/Frechet_distance/Neighbor_search.h
  'std::vector< std::size_t > CGAL::Frechet_distance::Neighbor_search< PointRange, Traits >::get_close_curves(const PointRange &query, double distance, Sequential_tag)' at line 90 of file /home/cgal-testsuite/cgal_doc_build/CGAL-6.2-Ic-24/include/CGAL/Frechet_distance/Neighbor_search.h
```

In principle the code is correct but due to the double usage of `std::vector< std::size_t >` doxygen has a small problem (since the integration of the fix for doxygen/doxygen#11787).
The workaround as used by CGAL is not necessary.

(tested documentation agains doxygen master version and dixygen 1.9.6)
@albert-github
Copy link
Contributor Author

Doxygen master version does not throw a warning anymore as a patch doxygen/doxygen@1de51f9 has been made.
The DOXYGEN_RUNNING construct is not necessary (as far as I can tell), so it would anyway be good to apply this proposed pull request (at least when there are no failing tests)

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

Successfully merging this pull request may close these issues.

1 participant