search

rapidfuzz / rapidfuzz-cpp

Rapid fuzzy string matching in C++ using the Levenshtein Distance
https://rapidfuzz.github.io/rapidfuzz-cpp
MIT License
238 stars 37 forks source link

doxygen warnings about fuzz.hpp: argument 's1' of command @param is not found... #114

Closed juliangilbey closed 7 months ago

juliangilbey commented 7 months ago

I get 10 similar errors from running doxygen about the file fuzz.hpp; here is the first:

<BUILDDIR>/rapidfuzz-cpp-3.0.0/rapidfuzz/fuzz.hpp:137: warning: argument 's1' of command @param is not found in the argument list of rapidfuzz::fuzz::partial_ratio(InputIt1 first1, InputIt1 last1, InputIt2 first2, InputIt2 last2, double score_cutoff=0)
<BUILDDIR>/rapidfuzz-cpp-3.0.0/rapidfuzz/fuzz.hpp:137: warning: argument 's2' of command @param is not found in the argument list of rapidfuzz::fuzz::partial_ratio(InputIt1 first1, InputIt1 last1, InputIt2 first2, InputIt2 last2, double score_cutoff=0)
<BUILDDIR>/rapidfuzz-cpp-3.0.0/rapidfuzz/fuzz.hpp:137: warning: The following parameters of rapidfuzz::fuzz::partial_ratio(InputIt1 first1, InputIt1 last1, InputIt2 first2, InputIt2 last2, double score_cutoff=0) are not documented:
  parameter 'first1'
  parameter 'last1'
  parameter 'first2'
  parameter 'last2'

I presume it's a copy-paste error.

Best wishes,

Julian

maxbachmann commented 7 months ago

Thanks for reporting. I fixed the warnings in version 3.0.1 (https://github.com/rapidfuzz/rapidfuzz-cpp/commit/03e2dfe6a9a9858ca62b98ea9df60cbf1ca8f804). Note that the documentation is pretty useless in it's current state though. Honestly right now people are probably better off reading the headers :sweat_smile:

I still plan to improve this at some point, but not sure when I will get around to it.