summaryrefslogtreecommitdiff
path: root/json-glib/json-utils.c
diff options
context:
space:
mode:
authorEmmanuele Bassi <ebassi@gnome.org>2021-06-08 16:08:50 +0100
committerEmmanuele Bassi <ebassi@gnome.org>2021-06-08 17:13:50 +0100
commit516fdb0fa0e1089d513b2038bb83bacdc134a35c (patch)
tree351744595d9b78f87e676bd5c9697a5903916951 /json-glib/json-utils.c
parentd3c51db3586aff8444b64ddc7dff432a99c2424b (diff)
downloadjson-glib-516fdb0fa0e1089d513b2038bb83bacdc134a35c.tar.gz
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.
Diffstat (limited to 'json-glib/json-utils.c')
-rw-r--r--json-glib/json-utils.c16
1 files changed, 5 insertions, 11 deletions
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 <http://www.gnu.org/licenses/>.
*/
-/**
- * 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
*/