Add a test case for references' scope

Author: Julow

test/xref2/references_scope.t/a.mli

@@ -0,0 +1,19 @@
+(** Text attached to references are written as single words to have a more
+    readable output.
+    References from the first comment (which is the doc of the entire module):
+    {{!B.C}Doc-relative}
+    {{!A.B.C}Doc-absolute} *)
+
+(** References from inside the module's signature:
+    {{!B.C}Defined-below}
+    {{!A.B.C}Defined-below-but-absolute} *)
+
+module B : sig
+  module C : sig end
+end
+
+module D : sig
+  open B
+
+  (** {{!C}Through-open} *)
+end

test/xref2/references_scope.t/run.t

@@ -0,0 +1,14 @@
+# Testing the scope of references
+
+  $ compile a.mli
+
+  $ jq_scan_references() { jq -c '.. | .["`Reference"]? | select(.)'; }
+
+The references from a.mli, see the attached text to recognize them:
+
+  $ odoc_print a.odocl | jq_scan_references
+  [{"`Dot":[{"`Root":["B","`TUnknown"]},"C"]},[{"`Word":"Doc-relative"}]]
+  [{"`Resolved":{"`Module":[{"`Module":[{"`Identifier":{"`Root":[{"`RootPage":"test"},"A"]}},"B"]},"C"]}},[{"`Word":"Doc-absolute"}]]
+  [{"`Resolved":{"`Module":[{"`Identifier":{"`Module":[{"`Root":[{"`RootPage":"test"},"A"]},"B"]}},"C"]}},[{"`Word":"Defined-below"}]]
+  [{"`Resolved":{"`Module":[{"`Module":[{"`Identifier":{"`Root":[{"`RootPage":"test"},"A"]}},"B"]},"C"]}},[{"`Word":"Defined-below-but-absolute"}]]
+  [{"`Root":["C","`TUnknown"]},[{"`Word":"Through-open"}]]