Clarify documentation.

diff --git a/gettext-tools/src/ChangeLog b/gettext-tools/src/ChangeLog
index a7abf49e942c17f192dcf8c51deca9b360e7429f..68e3bd515cfe6e0fc885bb82db56f1b7d052044e 100644 (file)
--- a/gettext-tools/src/ChangeLog
+++ b/gettext-tools/src/ChangeLog
@@ -1,5 +1,8 @@
 2008-09-14  Bruno Haible  <bruno@clisp.org>
 
+       * message.h (message_list_search_fuzzy, FUZZY_THRESHOLD): Clarify
+       documentation.
+
        * msgmerge.c (struct definitions_ty): Rename field 'findex' to
        'comp_findex', and 'findex_init_lock' to 'comp_findex_init_lock'.
        (definitions_init): Update.

diff --git a/gettext-tools/src/message.h b/gettext-tools/src/message.h
index 763ef34a581e95a94a6892ce70f74eec9f7a4b92..c052696d159438c1dd6b323bcf5a05c13d852b72 100644 (file)
--- a/gettext-tools/src/message.h
+++ b/gettext-tools/src/message.h
@@ -233,6 +233,10 @@ extern message_list_ty *
 extern message_ty *
        message_list_search (message_list_ty *mlp,
                            const char *msgctxt, const char *msgid);
+/* Return the message in MLP which maximizes the fuzzy_search_goal_function.
+   Only messages with a fuzzy_search_goal_function > FUZZY_THRESHOLD are
+   considered.  In case of several messages with the same goal function value,
+   the one with the smaller index is returned.  */
 extern message_ty *
        message_list_search_fuzzy (message_list_ty *mlp,
                                  const char *msgctxt, const char *msgid);
@@ -326,7 +330,8 @@ extern double
                                   double lower_bound);
 
 /* The threshold for fuzzy-searching.
-   A message is considered only if  fstrcmp (msg, given) > FUZZY_THRESHOLD.  */
+   A message is considered only if
+   fuzzy_search_goal_function (mp, given, 0.0) > FUZZY_THRESHOLD.  */
 #define FUZZY_THRESHOLD 0.6