[json-glib/doc-check] Add a test for the documentation state




commit fbd70e647ae3a152e95bdccc0110e31f834d92c0
Author: Emmanuele Bassi <ebassi gnome org>
Date:   Fri Jun 11 13:57:55 2021 +0100

    Add a test for the documentation state
    
    Ensure that we immediately fail if a symbol sneaks in without proper
    documentation.

 doc/json-glib.toml.in | 19 +++++++++++++++++++
 doc/meson.build       | 15 +++++++++++++++
 2 files changed, 34 insertions(+)
---
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)


[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]