add doc tags

Author: maxbachmann

rapidfuzz/details/common.hpp

@@ -41,12 +41,6 @@ TO opt_static_cast(const FROM& value)
     return static_cast<TO>(value);
 }
 
-/**
- * @defgroup Common Common
- * Common utilities shared among multiple functions
- * @{
- */
-
 static inline double NormSim_to_NormDist(double score_cutoff, double imprecision = 0.00001)
 {
     return std::min(1.0, 1.0 - score_cutoff + imprecision);
@@ -93,8 +87,6 @@ static inline void rf_aligned_free(void* ptr)
 #endif
 }
 
-/**@}*/
-
 } // namespace detail
 } // namespace rapidfuzz
 

rapidfuzz/distance.hpp

@@ -102,6 +102,12 @@ ReturnType opcodes_apply_impl(const Opcodes& ops, InputIt1 first1, InputIt1 last
 
 } // namespace detail
 
+/**
+ * @defgroup Distance Distance Algorithms
+ * @brief tring distance and similarity measurements.
+ * @{
+ */
+
 template <typename CharT, typename InputIt1, typename InputIt2>
 std::basic_string<CharT> editops_apply_str(const Editops& ops, InputIt1 first1, InputIt1 last1,
                                            InputIt2 first2, InputIt2 last2)
@@ -158,4 +164,6 @@ std::vector<CharT> opcodes_apply_vec(const Opcodes& ops, const Sentence1& s1, co
                                                           detail::to_begin(s2), detail::to_end(s2));
 }
 
+/** @} */
+
 } // namespace rapidfuzz

rapidfuzz/distance/DamerauLevenshtein.hpp

@@ -5,6 +5,12 @@
 #include <rapidfuzz/distance/DamerauLevenshtein_impl.hpp>
 
 namespace rapidfuzz {
+
+/**
+ * @addtogroup Distance
+ * @{
+ */
+
 /* the API will require a change when adding custom weights */
 namespace experimental {
 /**
@@ -150,4 +156,7 @@ CachedDamerauLevenshtein(InputIt1 first1, InputIt1 last1) -> CachedDamerauLevens
 #endif
 
 } // namespace experimental
+
+/** @} */
+
 } // namespace rapidfuzz

rapidfuzz/distance/Hamming.hpp

@@ -8,6 +8,11 @@
 
 namespace rapidfuzz {
 
+/**
+ * @addtogroup Distance
+ * @{
+ */
+
 /**
  * @brief Calculates the Hamming distance between two strings.
  *

rapidfuzz/distance/Indel.hpp

@@ -9,6 +9,11 @@
 
 namespace rapidfuzz {
 
+/**
+ * @addtogroup Distance
+ * @{
+ */
+
 template <typename InputIt1, typename InputIt2>
 size_t indel_distance(InputIt1 first1, InputIt1 last1, InputIt2 first2, InputIt2 last2,
                       size_t score_cutoff = std::numeric_limits<size_t>::max())
@@ -190,4 +195,6 @@ template <typename InputIt1>
 CachedIndel(InputIt1 first1, InputIt1 last1) -> CachedIndel<iter_value_t<InputIt1>>;
 #endif
 
+/** @} */
+
 } // namespace rapidfuzz

rapidfuzz/distance/Jaro.hpp

@@ -9,6 +9,11 @@
 
 namespace rapidfuzz {
 
+/**
+ * @addtogroup Distance
+ * @{
+ */
+
 template <typename InputIt1, typename InputIt2>
 double jaro_distance(InputIt1 first1, InputIt1 last1, InputIt2 first2, InputIt2 last2,
                      double score_cutoff = 1.0)
@@ -230,4 +235,6 @@ template <typename InputIt1>
 CachedJaro(InputIt1 first1, InputIt1 last1) -> CachedJaro<iter_value_t<InputIt1>>;
 #endif
 
+/** @} */
+
 } // namespace rapidfuzz

rapidfuzz/distance/JaroWinkler.hpp

@@ -8,6 +8,11 @@
 
 namespace rapidfuzz {
 
+/**
+ * @addtogroup Distance
+ * @{
+ */
+
 template <typename InputIt1, typename InputIt2,
           typename = rapidfuzz::rf_enable_if_t<!std::is_same<InputIt2, double>::value>>
 double jaro_winkler_distance(InputIt1 first1, InputIt1 last1, InputIt2 first2, InputIt2 last2,
@@ -208,4 +213,6 @@ CachedJaroWinkler(InputIt1 first1, InputIt1 last1,
                   double _prefix_weight = 0.1) -> CachedJaroWinkler<iter_value_t<InputIt1>>;
 #endif
 
+/** @} */
+
 } // namespace rapidfuzz

rapidfuzz/distance/LCSseq.hpp

@@ -9,6 +9,11 @@
 
 namespace rapidfuzz {
 
+/**
+ * @addtogroup Distance
+ * @{
+ */
+
 template <typename InputIt1, typename InputIt2>
 size_t lcs_seq_distance(InputIt1 first1, InputIt1 last1, InputIt2 first2, InputIt2 last2,
                         size_t score_cutoff = std::numeric_limits<size_t>::max())
@@ -233,4 +238,6 @@ template <typename InputIt1>
 CachedLCSseq(InputIt1 first1, InputIt1 last1) -> CachedLCSseq<iter_value_t<InputIt1>>;
 #endif
 
+/** @} */
+
 } // namespace rapidfuzz

rapidfuzz/distance/Levenshtein.hpp

@@ -8,6 +8,11 @@
 
 namespace rapidfuzz {
 
+/**
+ * @addtogroup Distance
+ * @{
+ */
+
 /**
  * @brief Calculates the minimum number of insertions, deletions, and substitutions
  * required to change one sequence into the other according to Levenshtein with custom
@@ -491,4 +496,6 @@ CachedLevenshtein(InputIt1 first1, InputIt1 last1,
                   LevenshteinWeightTable aWeights = {1, 1, 1}) -> CachedLevenshtein<iter_value_t<InputIt1>>;
 #endif
 
+/** @} */
+
 } // namespace rapidfuzz

rapidfuzz/distance/OSA.hpp

@@ -9,6 +9,11 @@
 
 namespace rapidfuzz {
 
+/**
+ * @addtogroup Distance
+ * @{
+ */
+
 /**
  * @brief Calculates the optimal string alignment (OSA) distance between two strings.
  *
@@ -277,6 +282,7 @@ CachedOSA(const Sentence1& s1_) -> CachedOSA<char_type<Sentence1>>;
 template <typename InputIt1>
 CachedOSA(InputIt1 first1, InputIt1 last1) -> CachedOSA<iter_value_t<InputIt1>>;
 #endif
+
 /**@}*/
 
 } // namespace rapidfuzz