perlapi: Combine all forms of ibcmp() into one entry

Perl · Jun 25, 2024 · 8bebe08 · 8bebe08
1 parent e7d4c1c
commit 8bebe08
Showing 1 changed file with 7 additions and 9 deletions.
diff --git a/util.h b/util.h
@@ -34,17 +34,15 @@
 /*
 =for apidoc_section $string
 
-=for apidoc ibcmp
+=for apidoc      ibcmp
+=for apidoc_item ibcmp_locale
+=for apidoc_item ibcmp_utf8
 
-This is a synonym for S<C<(! foldEQ())>>
+These return the complement of C<L</foldEQ>>, C<L</foldEQ_locale>>, and
+C<L</foldEQ_utf8>> respectively.  Those other names are preferred, as being
+clearer.
 
-=for apidoc ibcmp_locale
-
-This is a synonym for S<C<(! foldEQ_locale())>>
-
-=for apidoc ibcmp_utf8
-
-This is a synonym for S<C<(! foldEQ_utf8())>>
+Hence, for example, C<ibcmp()> is S<C<(! foldEQ())>>
 
 =cut
 */