summaryrefslogtreecommitdiff
path: root/docs/gir-1.2.rnc
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/gir-1.2.rnc
parentf9b412e96d5618894158284289cf2a3fe6e7cbfd (diff)
downloadgobject-introspection-b99435279a281f2c541100b693c96e67d6c1bd62.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/gir-1.2.rnc')
-rw-r--r--docs/gir-1.2.rnc12
1 files changed, 11 insertions, 1 deletions
diff --git a/docs/gir-1.2.rnc b/docs/gir-1.2.rnc
index 57e7baf7..1f224a4a 100644
--- a/docs/gir-1.2.rnc
+++ b/docs/gir-1.2.rnc
@@ -19,7 +19,8 @@ grammar {
(Include*
& CInclude*
& Package*
- & Namespace*)
+ & Namespace*
+ & DocFormat*)
}
## Namespace which maps metadata entries to C functionality. This a similar concept to namespace in C++, but for GObject-based C libraries
@@ -71,6 +72,15 @@ grammar {
empty
}
+ DocFormat =
+ ## Format used for the included documentation.
+ element doc:format {
+ ## Name of the documentation format. For example, 'gi-docgen' or 'gtk-doc'.
+ attribute name { xsd:string },
+
+ empty
+ }
+
Include =
## Dependant namespace to include with the current namespace. For example, Gtk will need the namespace GLib
element include {