Add support for element-type to GListModel

GListModel is an interface for creating typed, list-like containers. The
data stored is GObject instances, but it's useful to be able to annotate
the actual type, for both documentation and code generation purposes.

The annotation should be optional, to maintain backward compatibility.

2 files changed, 65 insertions, 0 deletions

diff --git a/tests/scanner/Regress-1.0-Gjs-expected/Regress.test_list_model_none.page b/tests/scanner/Regress-1.0-Gjs-expected/Regress.test_list_model_none.page
new file mode 100644
index 00000000..099232e0
--- /dev/null
+++ b/tests/scanner/Regress-1.0-Gjs-expected/Regress.test_list_model_none.page
@@ -0,0 +1,32 @@
+<?xml version="1.0"?>
+<page id="Regress.test_list_model_none"
+      type="topic"
+      style="function"
+      xmlns="http://projectmallard.org/1.0/"
+      xmlns:api="http://projectmallard.org/experimental/api/"
+      xmlns:ui="http://projectmallard.org/1.0/ui/">
+  <info>
+    <link xref="index" group="function" type="guide"/>
+    <api:function>
+      <api:returns>
+        <api:type>Gio.ListModel({item_type: void})</api:type>
+      </api:returns>
+      <api:name>regress_test_list_model_none</api:name>
+    </api:function>
+  </info>
+  <title>Regress.test_list_model_none</title>
+  <synopsis><code mime="text/x-gjs">
+function test_list_model_none(): Gio.ListModel({item_type: void}) {
+    // Gjs wrapper for regress_test_list_model_none()
+}
+  </code></synopsis>
+  <p>Test GListModel with no annotation.</p>
+
+<terms>
+<item>
+<title><code>Returns</code></title>
+  <p>a GListModel</p>
+</item>
+</terms>
+
+</page>
diff --git a/tests/scanner/Regress-1.0-Gjs-expected/Regress.test_list_model_object.page b/tests/scanner/Regress-1.0-Gjs-expected/Regress.test_list_model_object.page
new file mode 100644
index 00000000..618ca7e3
--- /dev/null
+++ b/tests/scanner/Regress-1.0-Gjs-expected/Regress.test_list_model_object.page
@@ -0,0 +1,33 @@
+<?xml version="1.0"?>
+<page id="Regress.test_list_model_object"
+      type="topic"
+      style="function"
+      xmlns="http://projectmallard.org/1.0/"
+      xmlns:api="http://projectmallard.org/experimental/api/"
+      xmlns:ui="http://projectmallard.org/1.0/ui/">
+  <info>
+    <link xref="index" group="function" type="guide"/>
+    <api:function>
+      <api:returns>
+        <api:type>Gio.ListModel({item_type: Regress.TestObj})</api:type>
+      </api:returns>
+      <api:name>regress_test_list_model_object</api:name>
+    </api:function>
+  </info>
+  <title>Regress.test_list_model_object</title>
+  <synopsis><code mime="text/x-gjs">
+function test_list_model_object(): Gio.ListModel({item_type: Regress.TestObj}) {
+    // Gjs wrapper for regress_test_list_model_object()
+}
+  </code></synopsis>
+  <p>Test GListModel return value with an element type annotation.</p>
+
+<terms>
+<item>
+<title><code>Returns</code></title>
+  <p>a GListModel
+  containing RegressTestObj values</p>
+</item>
+</terms>
+
+</page>