From f5da88112667fddb991ee455c051c9453b2542c1 Mon Sep 17 00:00:00 2001 From: Xavier Claessens Date: Tue, 16 Jul 2019 15:50:33 -0400 Subject: gtkdoc: Add 'check' kwarg (#5591) * gtkdoc: Add 'check' kwarg This runs gtkdoc-check in meson tests. Also reorganize the gtkdoc test because we cannot reliably build multiple doc into the same directory. Not all files generated by gtk-doc are prefixed with the target name. --- docs/markdown/snippets/gtkdoc.md | 11 +++++++++++ 1 file changed, 11 insertions(+) create mode 100644 docs/markdown/snippets/gtkdoc.md (limited to 'docs/markdown/snippets') diff --git a/docs/markdown/snippets/gtkdoc.md b/docs/markdown/snippets/gtkdoc.md new file mode 100644 index 0000000..f1f4ed4 --- /dev/null +++ b/docs/markdown/snippets/gtkdoc.md @@ -0,0 +1,11 @@ +## gtkdoc-check support + +`gnome.gtkdoc()` now has a `check` keyword argument. If `true` runs it will run +`gtkdoc-check` when running unit tests. Note that this has the downside of +rebuilding the doc for each build, which is often very slow. It usually should +be enabled only in CI. + +## `gnome.gtkdoc()` returns target object + +`gnome.gtkdoc()` now returns a target object that can be passed as dependency to +other targets using generated doc files (e.g. in `content_files` of another doc). -- cgit v1.1