summaryrefslogtreecommitdiff
path: root/docs/website/tools/g-ir-scanner.rst
diff options
context:
space:
mode:
authorCorentin Noël <tintou@noel.tf>2023-04-29 23:18:31 +0200
committerCorentin Noël <tintou@noel.tf>2023-04-29 23:25:36 +0200
commitb99435279a281f2c541100b693c96e67d6c1bd62 (patch)
tree804748ffd7a2e609689000996144c84f713a241f /docs/website/tools/g-ir-scanner.rst
parentf9b412e96d5618894158284289cf2a3fe6e7cbfd (diff)
downloadgobject-introspection-tintou/doc-format.tar.gz
Allow to specify the format of the documentationtintou/doc-format
Helps the consumers of the documentation to assume that the documentation is using gtk-doc format or gi-docgen.
Diffstat (limited to 'docs/website/tools/g-ir-scanner.rst')
-rw-r--r--docs/website/tools/g-ir-scanner.rst4
1 files changed, 4 insertions, 0 deletions
diff --git a/docs/website/tools/g-ir-scanner.rst b/docs/website/tools/g-ir-scanner.rst
index 15fe401d..12a14fcb 100644
--- a/docs/website/tools/g-ir-scanner.rst
+++ b/docs/website/tools/g-ir-scanner.rst
@@ -83,6 +83,10 @@ OPTIONS
Headers which should be included in C programs. This option can be
specified multiple times to include more than one header.
+--doc-format=DOC_FORMAT
+ The format of the inline documentation. This option can either be gtk-doc
+ or gi-docgen.
+
-n, --namespace=NAME
The namespace name. This name should be capitalized, eg the first letter
should be upper case. Examples: Gtk, Clutter, WebKit.