From 516fdb0fa0e1089d513b2038bb83bacdc134a35c Mon Sep 17 00:00:00 2001 From: Emmanuele Bassi Date: Tue, 8 Jun 2021 16:08:50 +0100 Subject: docs: Initial, rough port away from gtk-doc Drop `SECTION` blurbs. Use gi-docgen syntax for internal links. Use summary lines for gi-docgen indices. Use Markdown syntax for code fragments. --- json-glib/json-utils.c | 16 +++++----------- 1 file changed, 5 insertions(+), 11 deletions(-) (limited to 'json-glib/json-utils.c') diff --git a/json-glib/json-utils.c b/json-glib/json-utils.c index 5fc8496..dda4602 100644 --- a/json-glib/json-utils.c +++ b/json-glib/json-utils.c @@ -17,14 +17,6 @@ * License along with this library. If not, see . */ -/** - * SECTION:json-utils - * @Title: Utility API - * @Short_description: Various utility functions - * - * Various utility functions. - */ - #include "config.h" #include "json-utils.h" @@ -37,12 +29,14 @@ * @error: return location for a #GError * * Parses the string in @str and returns a #JsonNode representing - * the JSON tree. If @str is empty, this function will return %NULL. + * the JSON tree. + * + * If @str is empty, this function will return %NULL. * * In case of parsing error, this function returns %NULL and sets * @error appropriately. * - * Returns: (transfer full) (nullable): a #JsonNode, or %NULL + * Returns: (transfer full) (nullable): the root node of the JSON tree * * Since: 1.2 */ @@ -77,7 +71,7 @@ json_from_string (const char *str, * Generates a stringified JSON representation of the contents of * the passed @node. * - * Returns: (transfer full): the string representation of the #JsonNode + * Returns: (transfer full): the string representation of the node * * Since: 1.2 */ -- cgit v1.2.1