aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorJussi Pakkanen <jpakkane@gmail.com>2017-07-17 16:50:53 +0200
committerGitHub <noreply@github.com>2017-07-17 16:50:53 +0200
commit2009fdbd434279f0feddccc610067dedb7a26133 (patch)
treedbf40d31a0aa4818fc3850c03267b2bf13d09bf8 /docs
parentaab7ada356e02033e4030143cf363d06d975283b (diff)
parenta0bd896b2fcee3f9a0fc30df6775e2e325294024 (diff)
downloadmeson-2009fdbd434279f0feddccc610067dedb7a26133.zip
meson-2009fdbd434279f0feddccc610067dedb7a26133.tar.gz
meson-2009fdbd434279f0feddccc610067dedb7a26133.tar.bz2
Merge pull request #2072 from centricular/fix-gtkdoc-rpath
Various gtkdoc fixes
Diffstat (limited to 'docs')
-rw-r--r--docs/markdown/Gnome-module.md4
1 files changed, 2 insertions, 2 deletions
diff --git a/docs/markdown/Gnome-module.md b/docs/markdown/Gnome-module.md
index e709fd5..d01deaf 100644
--- a/docs/markdown/Gnome-module.md
+++ b/docs/markdown/Gnome-module.md
@@ -136,14 +136,14 @@ Note that very old versions of yelp may not support symlinked media; At least 3.
### gnome.gtkdoc()
-Compiles and installs gtkdoc documentation. Takes one positional arguments; The name of the module.
+Compiles and installs gtkdoc documentation into `prefix/share/gtk-doc/html`. Takes one positional argument: The name of the module.
* `main_xml`: specifies the main XML file
* `main_sgml`: equal to `main_xml`
* `src_dir`: include_directories to include
* `dependencies`: a list of dependencies
* `install`: if true, installs the generated docs
-* `install_dir`: the directory to install the generated docs
+* `install_dir`: the directory to install the generated docs relative to the gtk-doc html dir or an absolute path (default: module name)
* `scan_args`: a list of arguments to pass to `gtkdoc-scan`
* `scanobjs_args`: a list of arguments to pass to `gtkdoc-scangobj`
* `gobject_typesfile`: a list of type files