summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorEmmanuele Bassi <ebassi@gnome.org>2021-06-11 13:57:55 +0100
committerEmmanuele Bassi <ebassi@gnome.org>2021-06-11 14:19:29 +0100
commitfbd70e647ae3a152e95bdccc0110e31f834d92c0 (patch)
treef51c050633daf1a34314f4961969e889f4135992
parente9775af6c93dc6137ecdf43f01d88cc628cfebce (diff)
downloadjson-glib-fbd70e647ae3a152e95bdccc0110e31f834d92c0.tar.gz
Add a test for the documentation state
Ensure that we immediately fail if a symbol sneaks in without proper documentation.
-rw-r--r--doc/json-glib.toml.in19
-rw-r--r--doc/meson.build15
2 files changed, 34 insertions, 0 deletions
diff --git a/doc/json-glib.toml.in b/doc/json-glib.toml.in
index 9209538..9987232 100644
--- a/doc/json-glib.toml.in
+++ b/doc/json-glib.toml.in
@@ -46,3 +46,22 @@ hidden = true
[[object]]
name = "UNAVAILABLE"
hidden = true
+
+[[object]]
+name = "ParserError"
+ [[object.function]]
+ name = "quark"
+ check_ignore = true
+
+
+[[object]]
+name = "PathError"
+ [[object.function]]
+ name = "quark"
+ check_ignore = true
+
+[[object]]
+name = "ReaderError"
+ [[object.function]]
+ name = "quark"
+ check_ignore = true
diff --git a/doc/meson.build b/doc/meson.build
index aefc0e8..c4ebf4a 100644
--- a/doc/meson.build
+++ b/doc/meson.build
@@ -42,6 +42,21 @@ if get_option('gtk_doc').enabled()
install: true,
install_dir: json_docdir,
)
+
+ if get_option('tests')
+ test('doc-check',
+ gidocgen,
+ args: [
+ 'check',
+ '--config', json_toml,
+ '--add-include-path=@0@'.format(meson.current_build_dir() / '../json-glib'),
+ json_glib_gir[0],
+ ],
+ depends: json_glib_gir[0],
+ suite: ['docs'],
+ )
+ endif
+
endif
xsltproc = find_program('xsltproc', required: false)