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

This commit is contained in:
Nathan Willis 2019-05-20 17:38:38 +01:00
parent 0a5a8fcbce
commit d00a20bedc
2 changed files with 23 additions and 3 deletions

View File

@ -41,7 +41,11 @@
* @short_description: Graphite2 integration
* @include: hb-graphite2.h
*
* Functions for using HarfBuzz with the Graphite2 fonts.
* Functions for using HarfBuzz with fonts that include Graphite2 features.
*
* For Graphite2 features to work, you must be sure that HarfBuzz was compiled
* with the `graphite2` shaping engine enabled. Currently, the default is to
* not enable `graphite2` shaping.
**/
@ -174,7 +178,15 @@ _hb_graphite2_shaper_face_data_destroy (hb_graphite2_face_data_t *data)
free (data);
}
/*
/**
* hb_graphite2_face_get_gr_face:
* @face: @hb_face_t to query
*
* Fetches the Graphite2 gr_face corresponding to the specified
* #hb_face_t face object.
*
* Return value: the gr_face found
*
* Since: 0.9.10
*/
gr_face *

View File

@ -32,7 +32,15 @@
HB_BEGIN_DECLS
/**
* HB_GRAPHITE2_TAG_SILF:
*
* The #hb_tag_t tag for the `Silf` table, which holds Graphite2
* features.
*
* For more information, see http://graphite.sil.org/
*
**/
#define HB_GRAPHITE2_TAG_SILF HB_TAG('S','i','l','f')