From 2684155ee953c0e4c682ef5e54a1b996f9a3008a Mon Sep 17 00:00:00 2001 From: Philip Withnall Date: Wed, 13 Dec 2023 13:25:56 +0000 Subject: [PATCH] giunioninfo: Port documentation to gi-docgen and update MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 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 Helps: #3155 --- girepository/giunioninfo.c | 14 ++++++++------ 1 file changed, 8 insertions(+), 6 deletions(-) diff --git a/girepository/giunioninfo.c b/girepository/giunioninfo.c index bab59db6b..890145232 100644 --- a/girepository/giunioninfo.c +++ b/girepository/giunioninfo.c @@ -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 *