[Docs] Add gtk-doc comments to hb-icu.

This commit is contained in:
Nathan Willis 2019-05-20 17:38:13 +01:00
parent 9126a5ff07
commit 0a5a8fcbce
1 changed files with 34 additions and 1 deletions

View File

@ -46,10 +46,23 @@
* @short_description: ICU integration * @short_description: ICU integration
* @include: hb-icu.h * @include: hb-icu.h
* *
* Functions for using HarfBuzz with the ICU library to provide Unicode data. * Functions for using HarfBuzz with the International Components for Unicode
* (ICU) library. HarfBuzz supports using ICU to provide Unicode data, by attaching
* ICU functions to the virtual methods in a #hb_unicode_funcs_t function
* structure.
**/ **/
/**
* hb_icu_script_to_script:
* @script: The UScriptCode identifier to query
*
* Fetches the #hb_script_t script that corresponds to the
* specified UScriptCode identifier.
*
* Return value: the #hb_script_t script found
*
**/
hb_script_t hb_script_t
hb_icu_script_to_script (UScriptCode script) hb_icu_script_to_script (UScriptCode script)
{ {
@ -59,6 +72,16 @@ hb_icu_script_to_script (UScriptCode script)
return hb_script_from_string (uscript_getShortName (script), -1); return hb_script_from_string (uscript_getShortName (script), -1);
} }
/**
* hb_icu_script_from_script:
* @script: The #hb_script_t script to query
*
* Fetches the UScriptCode identifier that corresponds to the
* specified #hb_script_t script.
*
* Return value: the UScriptCode identifier found
*
**/
UScriptCode UScriptCode
hb_icu_script_from_script (hb_script_t script) hb_icu_script_from_script (hb_script_t script)
{ {
@ -343,6 +366,16 @@ void free_static_icu_funcs ()
} }
#endif #endif
/**
* hb_icu_get_unicode_funcs:
*
* Fetches a Unicode-functions structure that is populated
* with the appropriate ICU function for each method.
*
* Return value: (transfer full): a pointer to the #hb_unicode_funcs_t Unicode-functions structure
*
* Since: 0.9.38
**/
hb_unicode_funcs_t * hb_unicode_funcs_t *
hb_icu_get_unicode_funcs () hb_icu_get_unicode_funcs ()
{ {