From 376be58d04b4af9525f32b06b43fecfb209d5f42 Mon Sep 17 00:00:00 2001
From: Simon Josefsson <simon@josefsson.org>
Date: Sun, 21 Nov 2004 13:17:23 +0000
Subject: [PATCH] Doc fix.

---
 lib/idna.c                | 20 ++++++++++----------
 lib/pr29.c                |  6 +++---
 lib/strerror-idna.c       |  2 +-
 lib/strerror-pr29.c       |  2 +-
 lib/strerror-stringprep.c |  2 +-
 lib/strerror-tld.c        |  2 +-
 lib/stringprep.c          |  8 ++++----
 lib/tld.c                 | 24 ++++++++++++------------
 lib/toutf8.c              |  8 ++++----
 lib/version.c             |  2 +-
 10 files changed, 38 insertions(+), 38 deletions(-)

diff --git a/lib/idna.c b/lib/idna.c
index 9bc9e0d..ed91d34 100644
--- a/lib/idna.c
+++ b/lib/idna.c
@@ -36,7 +36,7 @@
 /* Core functions */
 
 /**
- * idna_to_ascii_4i
+ * idna_to_ascii_4i - convert Unicode domain name label to text
  * @in: input array with unicode code points.
  * @inlen: length of input array with unicode code points.
  * @out: output zero terminated string that must have room for at
@@ -377,7 +377,7 @@ step3:
 }
 
 /**
- * idna_to_unicode_44i
+ * idna_to_unicode_44i - convert domain name label to Unicode
  * @in: input array with unicode code points.
  * @inlen: length of input array with unicode code points.
  * @out: output array with unicode code points.
@@ -439,7 +439,7 @@ idna_to_unicode_44i (const uint32_t * in, size_t inlen,
 /* Wrappers that handle several labels */
 
 /**
- * idna_to_ascii_4z:
+ * idna_to_ascii_4z - convert Unicode domain name label to text
  * @input: zero terminated input Unicode string.
  * @output: pointer to newly allocated output string.
  * @flags: an #Idna_flags value, e.g., %IDNA_ALLOW_UNASSIGNED or
@@ -535,7 +535,7 @@ idna_to_ascii_4z (const uint32_t * input, char **output, int flags)
 }
 
 /**
- * idna_to_ascii_8z:
+ * idna_to_ascii_8z - convert Unicode domain name label to text
  * @input: zero terminated input UTF-8 string.
  * @output: pointer to newly allocated output string.
  * @flags: an #Idna_flags value, e.g., %IDNA_ALLOW_UNASSIGNED or
@@ -567,7 +567,7 @@ idna_to_ascii_8z (const char *input, char **output, int flags)
 }
 
 /**
- * idna_to_ascii_lz:
+ * idna_to_ascii_lz - convert Unicode domain name label to text
  * @input: zero terminated input string encoded in the current locale's
  *   character set.
  * @output: pointer to newly allocated output string.
@@ -598,7 +598,7 @@ idna_to_ascii_lz (const char *input, char **output, int flags)
 }
 
 /**
- * idna_to_unicode_4z4z:
+ * idna_to_unicode_4z4z - convert domain name label to Unicode
  * @input: zero-terminated Unicode string.
  * @output: pointer to newly allocated output Unicode string.
  * @flags: an #Idna_flags value, e.g., %IDNA_ALLOW_UNASSIGNED or
@@ -674,7 +674,7 @@ idna_to_unicode_4z4z (const uint32_t * input, uint32_t ** output, int flags)
 }
 
 /**
- * idna_to_unicode_8z4z:
+ * idna_to_unicode_8z4z - convert domain name label to Unicode
  * @input: zero-terminated UTF-8 string.
  * @output: pointer to newly allocated output Unicode string.
  * @flags: an #Idna_flags value, e.g., %IDNA_ALLOW_UNASSIGNED or
@@ -705,7 +705,7 @@ idna_to_unicode_8z4z (const char *input, uint32_t ** output, int flags)
 }
 
 /**
- * idna_to_unicode_8z8z:
+ * idna_to_unicode_8z8z - convert domain name label to Unicode
  * @input: zero-terminated UTF-8 string.
  * @output: pointer to newly allocated output UTF-8 string.
  * @flags: an #Idna_flags value, e.g., %IDNA_ALLOW_UNASSIGNED or
@@ -735,7 +735,7 @@ idna_to_unicode_8z8z (const char *input, char **output, int flags)
 }
 
 /**
- * idna_to_unicode_8zlz:
+ * idna_to_unicode_8zlz - convert domain name label to Unicode
  * @input: zero-terminated UTF-8 string.
  * @output: pointer to newly allocated output string encoded in the
  *   current locale's character set.
@@ -766,7 +766,7 @@ idna_to_unicode_8zlz (const char *input, char **output, int flags)
 }
 
 /**
- * idna_to_unicode_lzlz:
+ * idna_to_unicode_lzlz - convert domain name label to Unicode
  * @input: zero-terminated string encoded in the current locale's
  *   character set.
  * @output: pointer to newly allocated output string encoded in the
diff --git a/lib/pr29.c b/lib/pr29.c
index 89d94a0..5b4341f 100644
--- a/lib/pr29.c
+++ b/lib/pr29.c
@@ -1220,7 +1220,7 @@ combinationclass (uint32_t c)
 }
 
 /**
- * pr29_4:
+ * pr29_4 - check if input trigger Unicode normalization bugs
  * @in: input array with unicode code points.
  * @len: length of input array with unicode code points.
  *
@@ -1262,7 +1262,7 @@ pr29_4 (const uint32_t * in, size_t len)
 }
 
 /**
- * pr29_4z:
+ * pr29_4z - check if input trigger Unicode normalization bugs
  * @in: zero terminated array of Unicode code points.
  *
  * Check the input to see if it may be normalized into different
@@ -1286,7 +1286,7 @@ pr29_4z (const uint32_t * in)
 }
 
 /**
- * pr29_8z:
+ * pr29_8z - check if input trigger Unicode normalization bugs
  * @in: zero terminated input UTF-8 string.
  *
  * Check the input to see if it may be normalized into different
diff --git a/lib/strerror-idna.c b/lib/strerror-idna.c
index b60498e..3d2a92d 100644
--- a/lib/strerror-idna.c
+++ b/lib/strerror-idna.c
@@ -25,7 +25,7 @@
 #define _(String) dgettext (PACKAGE, String)
 
 /**
- * idna_strerror:
+ * idna_strerror - return string describing idna error code
  * @rc: an #Idna_rc return code.
  *
  * Convert a return code integer to a text string.  This string can be
diff --git a/lib/strerror-pr29.c b/lib/strerror-pr29.c
index c2c0f44..cd9de38 100644
--- a/lib/strerror-pr29.c
+++ b/lib/strerror-pr29.c
@@ -25,7 +25,7 @@
 #define _(String) dgettext (PACKAGE, String)
 
 /**
- * pr29_strerror:
+ * pr29_strerror - return string describing pr29 error code
  * @rc: an #Pr29_rc return code.
  *
  * Convert a return code integer to a text string.  This string can be
diff --git a/lib/strerror-stringprep.c b/lib/strerror-stringprep.c
index e1c80dd..42e4a8e 100644
--- a/lib/strerror-stringprep.c
+++ b/lib/strerror-stringprep.c
@@ -25,7 +25,7 @@
 #define _(String) dgettext (PACKAGE, String)
 
 /**
- * stringprep_strerror:
+ * stringprep_strerror - return string describing stringprep error code
  * @rc: a #Stringprep_rc return code.
  *
  * Convert a return code integer to a text string.  This string can be
diff --git a/lib/strerror-tld.c b/lib/strerror-tld.c
index 53bf734..84b3470 100644
--- a/lib/strerror-tld.c
+++ b/lib/strerror-tld.c
@@ -25,7 +25,7 @@
 #define _(String) dgettext (PACKAGE, String)
 
 /**
- * tld_strerror:
+ * tld_strerror - return string describing tld error code
  * @rc: tld return code
  *
  * Convert a return code integer to a text string.  This string can be
diff --git a/lib/stringprep.c b/lib/stringprep.c
index 1447d2d..6dde04d 100644
--- a/lib/stringprep.c
+++ b/lib/stringprep.c
@@ -104,7 +104,7 @@ stringprep_apply_table_to_string (uint32_t * ucs4,
    ( INVERTED(profileflags) && (profileflags & flags)))
 
 /**
- * stringprep_4i:
+ * stringprep_4i - prepare internationalized string
  * @ucs4: input/output array with string to prepare.
  * @len: on input, length of input array with Unicode code points,
  *   on exit, length of output array with Unicode code points.
@@ -292,7 +292,7 @@ stringprep_4zi_1 (uint32_t * ucs4, size_t ucs4len, size_t maxucs4len,
 }
 
 /**
- * stringprep_4zi:
+ * stringprep_4zi - prepare internationalized string
  * @ucs4: input/output array with zero terminated string to prepare.
  * @maxucs4len: maximum length of input/output array.
  * @flags: a #Stringprep_profile_flags value, or 0.
@@ -329,7 +329,7 @@ stringprep_4zi (uint32_t * ucs4, size_t maxucs4len,
 }
 
 /**
- * stringprep:
+ * stringprep - prepare internationalized string
  * @in: input/ouput array with string to prepare.
  * @maxlen: maximum length of input/output array.
  * @flags: a #Stringprep_profile_flags value, or 0.
@@ -411,7 +411,7 @@ stringprep (char *in,
 }
 
 /**
- * stringprep_profile:
+ * stringprep_profile - prepare internationalized string
  * @in: input array with UTF-8 string to prepare.
  * @out: output variable with pointer to newly allocate string.
  * @profile: name of stringprep profile to use.
diff --git a/lib/tld.c b/lib/tld.c
index 32afe58..205f6b2 100644
--- a/lib/tld.c
+++ b/lib/tld.c
@@ -35,7 +35,7 @@
 extern const Tld_table *_tld_tables[];
 
 /**
- * tld_get_table:
+ * tld_get_table - get table for a TLD name in table
  * @tld: TLD name (e.g. "com") as zero terminated ASCII byte string.
  * @tables: Zero terminated array of #Tld_table info-structures for
  *   TLDs.
@@ -62,7 +62,7 @@ tld_get_table (const char *tld, const Tld_table ** tables)
 }
 
 /**
- * tld_default_table:
+ * tld_default_table - get table for a TLD name
  * @tld: TLD name (e.g. "com") as zero terminated ASCII byte string.
  * @overrides: Additional zero terminated array of #Tld_table
  *   info-structures for TLDs, or %NULL to only use library deault
@@ -96,7 +96,7 @@ tld_default_table (const char *tld, const Tld_table ** overrides)
 		 (c) == 0xFF0E || (c) == 0xFF61)
 
 /**
- * tld_get_4:
+ * tld_get_4 - extract top level domain part in input Unicode string
  * @in: Array of unicode code points to process. Does not need to be
  *   zero terminated.
  * @inlen: Number of unicode code points.
@@ -146,7 +146,7 @@ tld_get_4 (const uint32_t * in, size_t inlen, char **out)
 }
 
 /**
- * tld_get_4z:
+ * tld_get_4z - extract top level domain part in input Unicode string
  * @in: Zero terminated array of unicode code points to process.
  * @out: Zero terminated ascii result string pointer.
  *
@@ -171,7 +171,7 @@ tld_get_4z (const uint32_t * in, char **out)
 }
 
 /**
- * tld_get_z:
+ * tld_get_z - extract top level domain part in input string
  * @in: Zero terminated character array to process.
  * @out: Zero terminated ascii result string pointer.
  *
@@ -206,7 +206,7 @@ tld_get_z (const char *in, char **out)
 }
 
 /*
- * tld_checkchar:
+ * tld_checkchar - verify that character is permitted
  * @ch: 32 bit unicode character to check.
  * @tld: A #Tld_table data structure to check @ch against.
  *
@@ -247,7 +247,7 @@ _tld_checkchar (uint32_t ch, const Tld_table * tld)
 }
 
 /**
- * tld_check_4t
+ * tld_check_4t - verify that characters are permitted
  * @in: Array of unicode code points to process. Does not need to be
  *   zero terminated.
  * @inlen: Number of unicode code points.
@@ -291,7 +291,7 @@ tld_check_4t (const uint32_t * in, size_t inlen, size_t * errpos,
 }
 
 /**
- * tld_check_4tz
+ * tld_check_4tz - verify that characters are permitted
  * @in: Zero terminated array of unicode code points to process.
  * @errpos: Position of offending character is returned here.
  * @tld: A #Tld_table data structure representing the restrictions for
@@ -322,7 +322,7 @@ tld_check_4tz (const uint32_t * in, size_t * errpos, const Tld_table * tld)
 }
 
 /**
- * tld_check_4
+ * tld_check_4 - verify that characters are permitted
  * @in: Array of unicode code points to process. Does not need to be
  *   zero terminated.
  * @inlen: Number of unicode code points.
@@ -374,7 +374,7 @@ tld_check_4 (const uint32_t * in, size_t inlen, size_t * errpos,
 }
 
 /**
- * tld_check_4z
+ * tld_check_4z - verify that characters are permitted
  * @in: Zero-terminated array of unicode code points to process.
  * @errpos: Position of offending character is returned here.
  * @overrides: A #Tld_table array of additional domain restriction
@@ -410,7 +410,7 @@ tld_check_4z (const uint32_t * in, size_t * errpos,
 }
 
 /**
- * tld_check_8z
+ * tld_check_8z - verify that characters are permitted
  * @in: Zero-terminated UTF8 string to process.
  * @errpos: Position of offending character is returned here.
  * @overrides: A #Tld_table array of additional domain restriction
@@ -455,7 +455,7 @@ tld_check_8z (const char *in, size_t * errpos, const Tld_table ** overrides)
 }
 
 /**
- * tld_check_lz
+ * tld_check_lz - verify that characters are permitted
  * @in: Zero-terminated string in the current locales encoding to process.
  * @errpos: Position of offending character is returned here.
  * @overrides: A #Tld_table array of additional domain restriction
diff --git a/lib/toutf8.c b/lib/toutf8.c
index cc2a5a0..18d80cc 100644
--- a/lib/toutf8.c
+++ b/lib/toutf8.c
@@ -48,7 +48,7 @@
 #  define stringprep_locale_charset() nl_langinfo (CODESET)
 # else
 /**
- * stringprep_locale_charset:
+ * stringprep_locale_charset - return charset used in current locale
  *
  * Find out current locale charset.  The function respect the CHARSET
  * environment variable, but typically uses nl_langinfo(CODESET) when
@@ -87,7 +87,7 @@ stringprep_locale_charset (void)
 # endif
 
 /**
- * stringprep_convert:
+ * stringprep_convert - encode string using new character set
  * @str: input zero-terminated string.
  * @to_codeset: name of destination character set.
  * @from_codeset: name of origin character set, as used by @str.
@@ -223,7 +223,7 @@ stringprep_convert (const char *str,
 #endif /* HAVE_ICONV */
 
 /**
- * stringprep_locale_to_utf8:
+ * stringprep_locale_to_utf8 - convert locale encoded string to UTF-8
  * @str: input zero terminated string.
  *
  * Convert string encoded in the locale's character set into UTF-8 by
@@ -239,7 +239,7 @@ stringprep_locale_to_utf8 (const char *str)
 }
 
 /**
- * stringprep_utf8_to_locale:
+ * stringprep_utf8_to_locale - encode UTF-8 string to locale encoding
  * @str: input zero terminated string.
  *
  * Convert string encoded in UTF-8 into the locale's character set by
diff --git a/lib/version.c b/lib/version.c
index de3e0a3..782f4d1 100644
--- a/lib/version.c
+++ b/lib/version.c
@@ -64,7 +64,7 @@ parse_version_string (const char *s, int *major, int *minor, int *micro)
 }
 
 /**
- * stringprep_check_version
+ * stringprep_check_version - check for library version
  * @req_version: Required version number, or NULL.
  *
  * Check that the the version of the library is at minimum the requested one
-- 
2.11.4.GIT