diff options
Diffstat (limited to 'docs/markdown')
| -rw-r--r-- | docs/markdown/Gnome-module.md | 6 | ||||
| -rw-r--r-- | docs/markdown/snippets/gtkdoc.md | 11 |
2 files changed, 17 insertions, 0 deletions
diff --git a/docs/markdown/Gnome-module.md b/docs/markdown/Gnome-module.md index dcd843f..9d8029e 100644 --- a/docs/markdown/Gnome-module.md +++ b/docs/markdown/Gnome-module.md @@ -339,10 +339,16 @@ of the module. * `scanobjs_args`: a list of arguments to pass to `gtkdoc-scangobj` * `c_args`: (*Added 0.48.0*) additional compile arguments to pass * `src_dir`: include_directories to include +* `check`: (*Since 0.52.0*) if `true` runs `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. This creates a `$module-doc` target that can be ran to build docs and normally these are only built on install. +*Since 0.52.0* 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). + ### gnome.gtkdoc_html_dir() Takes as argument a module name and returns the path where that 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). |