luc14n0/glib
1
0
Fork 0
mirror of https://gitlab.gnome.org/GNOME/glib.git synced 2025-01-12 07:26:15 +01:00
Code Issues Packages Projects Releases Wiki Activity

giunioninfo: Port documentation to gi-docgen and update

Browse Source 
Review and update the documentation, making sure it’s complete,
formatted in gi-docgen format, and has all appropriate GIR annotations
and `Since:` lines.

Signed-off-by: Philip Withnall <pwithnall@gnome.org>

Helps: #3155
This commit is contained in:
Philip Withnall 2023-12-13 13:25:56 +00:00
parent fe1270c0c4
commit 2684155ee9
1 changed files with 8 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
girepository/giunioninfo.c
View File

@ -134,9 +134,9 @@ gi_union_info_get_method (GIUnionInfo *info,
* gi_union_info_is_discriminated:
* @info: a #GIUnionInfo
*
* Return true if this union contains a discriminator field.
* Return `TRUE` if this union contains a discriminator field.
*
* Returns: true if this is a discriminated union, false otherwise
* Returns: `TRUE` if this is a discriminated union, `FALSE` otherwise
* Since: 2.80
*/
gboolean
@ -195,8 +195,9 @@ gi_union_info_get_discriminator_type (GIUnionInfo *info)
*
* If the union is not discriminated, `NULL` is returned.
*
* Returns: (transfer full) (nullable): the [type@GIRepository.ConstantInfo],
* free it with [method@GIRepository.BaseInfo.unref] when done.
* Returns: (transfer full) (nullable): The [type@GIRepository.ConstantInfo], or
* `NULL` if the union is not discriminated. Free it with
* [method@GIRepository.BaseInfo.unref] when done.
* Since: 2.80
*/
GIConstantInfo *
@ -230,8 +231,9 @@ gi_union_info_get_discriminator (GIUnionInfo *info,
*
* Obtain the type information for the method named @name.
*
* Returns: (transfer full): the [type@GIRepository.FunctionInfo], free it
* with [method@GIRepository.BaseInfo.unref] when done.
* Returns: (transfer full) (nullable): The [type@GIRepository.FunctionInfo], or
* `NULL` if none was found. Free it with [method@GIRepository.BaseInfo.unref]
* when done.
* Since: 2.80
*/
GIFunctionInfo *