walkero
/
harfbuzz
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

[paint] Improve the docs

This commit is contained in:
Matthias Clasen 2022-12-19 12:20:07 -05:00 committed by Behdad Esfahbod
parent 3a219cfa6a
commit ddd2039265
1 changed files with 10 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
src/hb-paint.cc
View File

@ -197,7 +197,12 @@ HB_PAINT_FUNCS_IMPLEMENT_CALLBACKS
* hb_paint_funcs_create: * hb_paint_funcs_create:
* *
* Creates a new #hb_paint_funcs_t structure of paint functions. * Creates a new #hb_paint_funcs_t structure of paint functions.
*
* The initial reference count of 1 should be released with hb_paint_funcs_destroy()
* when you are done using the #hb_paint_funcs_t. This function never returns
* `NULL`. If memory cannot be allocated, a special singleton #hb_paint_funcs_t
* object will be returned.
*
* Returns value: (transfer full): the paint-functions structure * Returns value: (transfer full): the paint-functions structure
* *
* Since: REPLACEME * Since: REPLACEME
@ -246,6 +251,9 @@ hb_paint_funcs_get_empty ()
* *
* Increases the reference count on a paint-functions structure. * Increases the reference count on a paint-functions structure.
* *
* This prevents @funcs from being destroyed until a matching
* call to hb_paint_funcs_destroy() is made.
*
* Return value: The paint-functions structure * Return value: The paint-functions structure
* *
* Since: REPLACEME * Since: REPLACEME
@ -293,7 +301,7 @@ hb_paint_funcs_destroy (hb_paint_funcs_t *funcs)
* @destroy: (nullable): A callback to call when @data is not needed anymore * @destroy: (nullable): A callback to call when @data is not needed anymore
* @replace: Whether to replace an existing data with the same key * @replace: Whether to replace an existing data with the same key
* *
* Attaches a user-data key/data pair to the specified paint-functions structure. * Attaches a user-data key/data pair to the specified paint-functions structure.
* *
* Return value: `true` if success, `false` otherwise * Return value: `true` if success, `false` otherwise
* *