Add documentation for matrix_api_filter_get_json_data()

2016-01-18 17:00:23 +01:00 · 2016-01-18 17:00:23 +01:00 · 090e23efe1
commit 090e23efe1
parent b5c569be55
1 changed files with 9 additions and 0 deletions
--- a/src/matrix-api-types.c
+++ b/src/matrix-api-types.c
@ -1583,6 +1583,15 @@ matrix_api_filter_get_json_node(MatrixAPIFilter *filter)
    return root;
 }

+/**
+ * matrix_api_filter_get_json_data:
+ * @filter: a #MatrixAPIFilter
+ * @datalen: storage for the length of the JSON data, or %NULL
+ *
+ * Get the JSON representation of @filter as a string.
+ *
+ * Returns: (transfer full): the JSON representation of @filter
+ */
 gchar *
 matrix_api_filter_get_json_data(MatrixAPIFilter *filter, gsize *datalen)
 {