开源软件构建与测试

_service:tar_scm:gi-docgen.spec Changed

_service:tar_scm:gi-docgen-2021.8-no-web-fonts.patch Deleted

@@ -1,239 +0,0 @@
-diff -Naur gi-docgen-2021.8-original/gidocgen/templates/basic/basic.toml gi-docgen-2021.8/gidocgen/templates/basic/basic.toml
---- gi-docgen-2021.8-original/gidocgen/templates/basic/basic.toml	2021-10-21 08:02:00.000000000 -0400
-+++ gi-docgen-2021.8/gidocgen/templates/basic/basic.toml	2021-10-21 11:36:23.194672634 -0400
-@@ -42,35 +42,4 @@
-   "solarized-light.css",
-   "solarized-dark.css",
-   "search.js",
--  "RedHatDisplay-Black.woff",
--  "RedHatDisplay-Black.woff2",
--  "RedHatDisplay-BlackItalic.woff",
--  "RedHatDisplay-BlackItalic.woff2",
--  "RedHatDisplay-Bold.woff",
--  "RedHatDisplay-Bold.woff2",
--  "RedHatDisplay-BoldItalic.woff",
--  "RedHatDisplay-BoldItalic.woff2",
--  "RedHatDisplay-Italic.woff",
--  "RedHatDisplay-Italic.woff2",
--  "RedHatDisplay-Medium.woff",
--  "RedHatDisplay-Medium.woff2",
--  "RedHatDisplay-MediumItalic.woff",
--  "RedHatDisplay-MediumItalic.woff2",
--  "RedHatDisplay-Regular.woff",
--  "RedHatDisplay-Regular.woff2",
--  "RedHatText-Bold.woff",
--  "RedHatText-Bold.woff2",
--  "RedHatText-BoldItalic.woff",
--  "RedHatText-BoldItalic.woff2",
--  "RedHatText-Italic.woff",
--  "RedHatText-Italic.woff2",
--  "RedHatText-Medium.woff",
--  "RedHatText-Medium.woff2",
--  "RedHatText-MediumItalic.woff",
--  "RedHatText-MediumItalic.woff2",
--  "RedHatText-Regular.woff",
--  "RedHatText-Regular.woff2",
--  "SourceCodePro-It.ttf.woff",
--  "SourceCodePro-Regular.ttf.woff",
--  "SourceCodePro-Semibold.ttf.woff",
- 
-diff -Naur gi-docgen-2021.8-original/gidocgen/templates/basic/fonts.css gi-docgen-2021.8/gidocgen/templates/basic/fonts.css
---- gi-docgen-2021.8-original/gidocgen/templates/basic/fonts.css	2021-10-21 08:02:00.000000000 -0400
-+++ gi-docgen-2021.8/gidocgen/templates/basic/fonts.css	2021-10-21 11:36:23.194672634 -0400
-@@ -14,9 +14,7 @@
- 
- @font-face {
-   font-family: "Red Hat Display";
--  src: local('RedHatDisplayWeb'),
--       url("RedHatDisplay-Regular.woff2") format("woff2"),
--       url("RedHatDisplay-Regular.woff") format("woff");
-+  src: local('RedHatDisplay-Regular');
-   font-style: normal;
-   font-weight: 400;
-   font-display: fallback;
-@@ -24,9 +22,7 @@
- 
- @font-face {
-   font-family: "Red Hat Display";
--  src: local('RedHatDisplayWeb'),
--       url("RedHatDisplay-RegularItalic.woff2") format("woff2"),
--       url("RedHatDisplay-RegularItalic.woff") format("woff");
-+  src: local('RedHatDisplay-RegularItalic');
-   font-style: italic;
-   font-weight: 400;
-   font-display: fallback;
-@@ -34,9 +30,7 @@
- 
- @font-face {
-   font-family: "Red Hat Display";
--  src: local('RedHatDisplayWeb'),
--       url("RedHatDisplay-Medium.woff2") format("woff2"),
--       url("RedHatDisplay-Medium.woff") format("woff");
-+  src: local('RedHatDisplay-Medium');
-   font-style: normal;
-   font-weight: 500;
-   font-display: fallback;
-@@ -44,9 +38,7 @@
- 
- @font-face {
-   font-family: "Red Hat Display";
--  src: local('RedHatDisplayWeb'),
--       url("RedHatDisplay-MediumItalic.woff2") format("woff2"),
--       url("RedHatDisplay-MediumItalic.woff") format("woff");
-+  src: local('RedHatDisplay-MediumItalic');
-   font-style: italic;
-   font-weight: 500;
-   font-display: fallback;
-@@ -54,9 +46,7 @@
- 
- @font-face {
-   font-family: "Red Hat Display";
--  src: local('RedHatDisplayWeb'),
--       url("RedHatDisplay-Bold.woff2") format("woff2"),
--       url("RedHatDisplay-Bold.woff") format("woff");
-+  src: local('RedHatDisplay-Bold');
-   font-style: normal;
-   font-weight: 700;
-   font-display: fallback;
-@@ -64,9 +54,7 @@
- 
- @font-face {
-   font-family: "Red Hat Display";
--  src: local('RedHatDisplayWeb'),
--       url("RedHatDisplay-BoldItalic.woff2") format("woff2"),
--       url("RedHatDisplay-BoldItalic.woff") format("woff");
-+  src: local('RedHatDisplay-BoldItalic');
-   font-style: italic;
-   font-weight: 700;
-   font-display: fallback;
-@@ -75,9 +63,7 @@
- 
- @font-face {
-   font-family: "Red Hat Display";
--  src: local('RedHatDisplayWeb'),
--       url("RedHatDisplay-Black.woff2") format("woff2"),
--       url("RedHatDisplay-Black.woff") format("woff");
-+  src: local('RedHatDisplay-Black');
-   font-style: normal;
-   font-weight: 900;
-   font-display: fallback;
-@@ -85,9 +71,7 @@
- 
- @font-face {
-   font-family: "Red Hat Display";
--  src: local('RedHatDisplayWeb'),
--       url("RedHatDisplay-BlackItalic.woff2") format("woff2"),
--       url("RedHatDisplay-BlackItalic.woff") format("woff");
-+  src: local('RedHatDisplay-BlackItalic');
-   font-style: italic;
-   font-weight: 900;
-   font-display: fallback;
-@@ -95,9 +79,7 @@
- 
- @font-face {
-   font-family: "Red Hat Text";
--  src: local('RedHatTextWeb'),
--       url("RedHatText-Regular.woff2") format("woff2"),
--       url("RedHatText-Regular.woff") format("woff");
-+  src: local('RedHatText-Regular');
-   font-style: normal;
-   font-weight: 400;
-   font-display: fallback;
-@@ -105,9 +87,7 @@
- 
- @font-face {
-   font-family: "Red Hat Text";
--  src: local('RedHatTextWeb'),
--       url("RedHatText-Italic.woff2") format("woff2"),
--       url("RedHatText-Italic.woff") format("woff");
-+  src: local('RedHatText-Italic');
-   font-style: italic;
-   font-weight: 400;
-   font-display: fallback;
-@@ -115,9 +95,7 @@
- 
- @font-face {
-   font-family: "Red Hat Text";
--  src: local('RedHatTextWeb'),
--       url("RedHatText-Medium.woff2") format("woff2"),
--       url("RedHatText-Medium.woff") format("woff");
-+  src: local('RedHatText-Medium');
-   font-style: normal;
-   font-weight: 700;
-   font-display: fallback;
-@@ -125,9 +103,7 @@
- 
- @font-face {
-   font-family: "Red Hat Text";
--  src: local('RedHatTextWeb'),
--       url("RedHatText-MediumItalic.woff2") format("woff2"),
--       url("RedHatText-MediumItalic.woff") format("woff");
-+  src: local('RedHatText-MediumItalic');
-   font-style: italic;
-   font-weight: 700;
-   font-display: fallback;
-@@ -135,9 +111,7 @@
- 
- @font-face {
-   font-family: "Red Hat Text";
--  src: local('RedHatTextWeb'),
--       url("RedHatText-Bold.woff2") format("woff2"),
--       url("RedHatText-Bold.woff") format("woff");
-+  src: local('RedHatText-Bold');
-   font-style: normal;
-   font-weight: 900;
-   font-display: fallback;
-@@ -145,22 +119,17 @@
- 
- @font-face {
-   font-family: "Red Hat Text";
--  src: local('RedHatTextWeb'),
--       url("RedHatText-BoldItalic.woff2") format("woff2"),
--       url("RedHatText-BoldItalic.woff") format("woff");
-+  src: local('RedHatText-BoldItalic');
-   font-style: italic;
-   font-weight: 900;
-   font-display: fallback;
- }
- 
--/* Do not fall back to locally installed SourceCodePro, as there are

_service:tar_scm:gi-docgen-2022.2-no-web-fonts.patch Added

@@ -0,0 +1,239 @@
+diff -Naur gi-docgen-2022.2-original/gidocgen/templates/basic/basic.toml gi-docgen-2022.2/gidocgen/templates/basic/basic.toml
+--- gi-docgen-2022.2-original/gidocgen/templates/basic/basic.toml	2022-11-07 09:50:06.000000000 -0500
++++ gi-docgen-2022.2/gidocgen/templates/basic/basic.toml	2022-11-11 08:23:51.069820380 -0500
+@@ -42,35 +42,4 @@
+   "solarized-light.css",
+   "solarized-dark.css",
+   "search.js",
+-  "RedHatDisplay-Black.woff",
+-  "RedHatDisplay-Black.woff2",
+-  "RedHatDisplay-BlackItalic.woff",
+-  "RedHatDisplay-BlackItalic.woff2",
+-  "RedHatDisplay-Bold.woff",
+-  "RedHatDisplay-Bold.woff2",
+-  "RedHatDisplay-BoldItalic.woff",
+-  "RedHatDisplay-BoldItalic.woff2",
+-  "RedHatDisplay-Italic.woff",
+-  "RedHatDisplay-Italic.woff2",
+-  "RedHatDisplay-Medium.woff",
+-  "RedHatDisplay-Medium.woff2",
+-  "RedHatDisplay-MediumItalic.woff",
+-  "RedHatDisplay-MediumItalic.woff2",
+-  "RedHatDisplay-Regular.woff",
+-  "RedHatDisplay-Regular.woff2",
+-  "RedHatText-Bold.woff",
+-  "RedHatText-Bold.woff2",
+-  "RedHatText-BoldItalic.woff",
+-  "RedHatText-BoldItalic.woff2",
+-  "RedHatText-Italic.woff",
+-  "RedHatText-Italic.woff2",
+-  "RedHatText-Medium.woff",
+-  "RedHatText-Medium.woff2",
+-  "RedHatText-MediumItalic.woff",
+-  "RedHatText-MediumItalic.woff2",
+-  "RedHatText-Regular.woff",
+-  "RedHatText-Regular.woff2",
+-  "SourceCodePro-It.ttf.woff",
+-  "SourceCodePro-Regular.ttf.woff",
+-  "SourceCodePro-Semibold.ttf.woff",
+ 
+diff -Naur gi-docgen-2022.2-original/gidocgen/templates/basic/fonts.css gi-docgen-2022.2/gidocgen/templates/basic/fonts.css
+--- gi-docgen-2022.2-original/gidocgen/templates/basic/fonts.css	2022-11-07 09:50:06.000000000 -0500
++++ gi-docgen-2022.2/gidocgen/templates/basic/fonts.css	2022-11-11 08:23:51.069820380 -0500
+@@ -14,9 +14,7 @@
+ 
+ @font-face {
+   font-family: "Red Hat Display";
+-  src: local('RedHatDisplayWeb'),
+-       url("RedHatDisplay-Regular.woff2") format("woff2"),
+-       url("RedHatDisplay-Regular.woff") format("woff");
++  src: local('RedHatDisplay-Regular');
+   font-style: normal;
+   font-weight: 400;
+   font-display: fallback;
+@@ -24,9 +22,7 @@
+ 
+ @font-face {
+   font-family: "Red Hat Display";
+-  src: local('RedHatDisplayWeb'),
+-       url("RedHatDisplay-RegularItalic.woff2") format("woff2"),
+-       url("RedHatDisplay-RegularItalic.woff") format("woff");
++  src: local('RedHatDisplay-RegularItalic');
+   font-style: italic;
+   font-weight: 400;
+   font-display: fallback;
+@@ -34,9 +30,7 @@
+ 
+ @font-face {
+   font-family: "Red Hat Display";
+-  src: local('RedHatDisplayWeb'),
+-       url("RedHatDisplay-Medium.woff2") format("woff2"),
+-       url("RedHatDisplay-Medium.woff") format("woff");
++  src: local('RedHatDisplay-Medium');
+   font-style: normal;
+   font-weight: 500;
+   font-display: fallback;
+@@ -44,9 +38,7 @@
+ 
+ @font-face {
+   font-family: "Red Hat Display";
+-  src: local('RedHatDisplayWeb'),
+-       url("RedHatDisplay-MediumItalic.woff2") format("woff2"),
+-       url("RedHatDisplay-MediumItalic.woff") format("woff");
++  src: local('RedHatDisplay-MediumItalic');
+   font-style: italic;
+   font-weight: 500;
+   font-display: fallback;
+@@ -54,9 +46,7 @@
+ 
+ @font-face {
+   font-family: "Red Hat Display";
+-  src: local('RedHatDisplayWeb'),
+-       url("RedHatDisplay-Bold.woff2") format("woff2"),
+-       url("RedHatDisplay-Bold.woff") format("woff");
++  src: local('RedHatDisplay-Bold');
+   font-style: normal;
+   font-weight: 700;
+   font-display: fallback;
+@@ -64,9 +54,7 @@
+ 
+ @font-face {
+   font-family: "Red Hat Display";
+-  src: local('RedHatDisplayWeb'),
+-       url("RedHatDisplay-BoldItalic.woff2") format("woff2"),
+-       url("RedHatDisplay-BoldItalic.woff") format("woff");
++  src: local('RedHatDisplay-BoldItalic');
+   font-style: italic;
+   font-weight: 700;
+   font-display: fallback;
+@@ -75,9 +63,7 @@
+ 
+ @font-face {
+   font-family: "Red Hat Display";
+-  src: local('RedHatDisplayWeb'),
+-       url("RedHatDisplay-Black.woff2") format("woff2"),
+-       url("RedHatDisplay-Black.woff") format("woff");
++  src: local('RedHatDisplay-Black');
+   font-style: normal;
+   font-weight: 900;
+   font-display: fallback;
+@@ -85,9 +71,7 @@
+ 
+ @font-face {
+   font-family: "Red Hat Display";
+-  src: local('RedHatDisplayWeb'),
+-       url("RedHatDisplay-BlackItalic.woff2") format("woff2"),
+-       url("RedHatDisplay-BlackItalic.woff") format("woff");
++  src: local('RedHatDisplay-BlackItalic');
+   font-style: italic;
+   font-weight: 900;
+   font-display: fallback;
+@@ -95,9 +79,7 @@
+ 
+ @font-face {
+   font-family: "Red Hat Text";
+-  src: local('RedHatTextWeb'),
+-       url("RedHatText-Regular.woff2") format("woff2"),
+-       url("RedHatText-Regular.woff") format("woff");
++  src: local('RedHatText-Regular');
+   font-style: normal;
+   font-weight: 400;
+   font-display: fallback;
+@@ -105,9 +87,7 @@
+ 
+ @font-face {
+   font-family: "Red Hat Text";
+-  src: local('RedHatTextWeb'),
+-       url("RedHatText-Italic.woff2") format("woff2"),
+-       url("RedHatText-Italic.woff") format("woff");
++  src: local('RedHatText-Italic');
+   font-style: italic;
+   font-weight: 400;
+   font-display: fallback;
+@@ -115,9 +95,7 @@
+ 
+ @font-face {
+   font-family: "Red Hat Text";
+-  src: local('RedHatTextWeb'),
+-       url("RedHatText-Medium.woff2") format("woff2"),
+-       url("RedHatText-Medium.woff") format("woff");
++  src: local('RedHatText-Medium');
+   font-style: normal;
+   font-weight: 700;
+   font-display: fallback;
+@@ -125,9 +103,7 @@
+ 
+ @font-face {
+   font-family: "Red Hat Text";
+-  src: local('RedHatTextWeb'),
+-       url("RedHatText-MediumItalic.woff2") format("woff2"),
+-       url("RedHatText-MediumItalic.woff") format("woff");
++  src: local('RedHatText-MediumItalic');
+   font-style: italic;
+   font-weight: 700;
+   font-display: fallback;
+@@ -135,9 +111,7 @@
+ 
+ @font-face {
+   font-family: "Red Hat Text";
+-  src: local('RedHatTextWeb'),
+-       url("RedHatText-Bold.woff2") format("woff2"),
+-       url("RedHatText-Bold.woff") format("woff");
++  src: local('RedHatText-Bold');
+   font-style: normal;
+   font-weight: 900;
+   font-display: fallback;
+@@ -145,22 +119,17 @@
+ 
+ @font-face {
+   font-family: "Red Hat Text";
+-  src: local('RedHatTextWeb'),
+-       url("RedHatText-BoldItalic.woff2") format("woff2"),
+-       url("RedHatText-BoldItalic.woff") format("woff");
++  src: local('RedHatText-BoldItalic');
+   font-style: italic;
+   font-weight: 900;
+   font-display: fallback;
+ }
+ 
+-/* Do not fall back to locally installed SourceCodePro, as there are

_service Changed

_service:tar_scm:gi-docgen-2022.1.tar.xz/gidocgen/porter.py Deleted

@@ -1,408 +0,0 @@
-# SPDX-FileCopyrightText:  Copyright 2001 Vivake Gupta <v@nano.com>
-# SPDX-License-Identifier: CC0-1.0
-
-"""
-Porter Stemming Algorithm
-
-This is the Porter stemming algorithm, ported to Python from the
-version coded up in ANSI C by the author. It may be be regarded
-as canonical, in that it follows the algorithm presented in
-
-Porter, 1980, An algorithm for suffix stripping, Program, Vol. 14,
-no. 3, pp 130-137,
-
-only differing from it at the points maked --DEPARTURE-- below.
-
-See also https://tartarus.org/martin/PorterStemmer/
-
-The algorithm as described in the paper could be exactly replicated
-by adjusting the points of DEPARTURE, but this is barely necessary,
-because (a) the points of DEPARTURE are definitely improvements, and
-(b) no encoding of the Porter stemmer I have seen is anything like
-as exact as this version, even with the points of DEPARTURE!
-
-Release 1: January 2001
-
-:license: Public Domain ("can be used free of charge for any purpose").
-"""
-
-
-class PorterStemmer:
-
-    def __init__(self) -> None:
-        """The main part of the stemming algorithm starts here.
-        b is a buffer holding a word to be stemmed. The letters are in bk0,
-        bk0+1 ... ending at bk. In fact k0 = 0 in this demo program. k is
-        readjusted downwards as the stemming progresses. Zero termination is
-        not in fact used in the algorithm.
-
-        Note that only lower case sequences are stemmed. Forcing to lower case
-        should be done before stem(...) is called.
-        """
-
-        self.b = ""     # buffer for word to be stemmed
-        self.k = 0
-        self.k0 = 0
-        self.j = 0      # j is a general offset into the string
-
-    def cons(self, i: int) -> int:
-        """cons(i) is TRUE <=> bi is a consonant."""
-        if self.bi == 'a' or self.bi == 'e' or self.bi == 'i' \
-           or self.bi == 'o' or self.bi == 'u':
-            return 0
-        if self.bi == 'y':
-            if i == self.k0:
-                return 1
-            else:
-                return (not self.cons(i - 1))
-        return 1
-
-    def m(self) -> int:
-        """m() measures the number of consonant sequences between k0 and j.
-        if c is a consonant sequence and v a vowel sequence, and <..>
-        indicates arbitrary presence,
-
-           <c><v>       gives 0
-           <c>vc<v>     gives 1
-           <c>vcvc<v>   gives 2
-           <c>vcvcvc<v> gives 3
-           ....
-        """
-        n = 0
-        i = self.k0
-        while 1:
-            if i > self.j:
-                return n
-            if not self.cons(i):
-                break
-            i = i + 1
-        i = i + 1
-        while 1:
-            while 1:
-                if i > self.j:
-                    return n
-                if self.cons(i):
-                    break
-                i = i + 1
-            i = i + 1
-            n = n + 1
-            while 1:
-                if i > self.j:
-                    return n
-                if not self.cons(i):
-                    break
-                i = i + 1
-            i = i + 1
-
-    def vowelinstem(self) -> int:
-        """vowelinstem() is TRUE <=> k0,...j contains a vowel"""
-        for i in range(self.k0, self.j + 1):
-            if not self.cons(i):
-                return 1
-        return 0
-
-    def doublec(self, j: int) -> int:
-        """doublec(j) is TRUE <=> j,(j-1) contain a double consonant."""
-        if j < (self.k0 + 1):
-            return 0
-        if (self.bj != self.bj - 1):
-            return 0
-        return self.cons(j)
-
-    def cvc(self, i: int) -> int:
-        """cvc(i) is TRUE <=> i-2,i-1,i has the form
-             consonant - vowel - consonant
-        and also if the second c is not w,x or y. this is used when trying to
-        restore an e at the end of a short  e.g.
-
-           cav(e), lov(e), hop(e), crim(e), but
-           snow, box, tray.
-        """
-        if i < (self.k0 + 2) or not self.cons(i) or self.cons(i - 1) \
-           or not self.cons(i - 2):
-            return 0
-        ch = self.bi
-        if ch == 'w' or ch == 'x' or ch == 'y':
-            return 0
-        return 1
-
-    def ends(self, s: str) -> int:
-        """ends(s) is TRUE <=> k0,...k ends with the string s."""
-        length = len(s)
-        if slength - 1 != self.bself.k:  # tiny speed-up
-            return 0
-        if length > (self.k - self.k0 + 1):
-            return 0
-        if self.bself.k - length + 1:self.k + 1 != s:
-            return 0
-        self.j = self.k - length
-        return 1
-
-    def setto(self, s: str) -> None:
-        """setto(s) sets (j+1),...k to the characters in the string s,
-        readjusting k."""
-        length = len(s)
-        self.b = self.b:self.j + 1 + s + self.bself.j + length + 1:
-        self.k = self.j + length
-
-    def r(self, s: str) -> None:
-        """r(s) is used further down."""
-        if self.m() > 0:
-            self.setto(s)
-
-    def step1ab(self) -> None:
-        """step1ab() gets rid of plurals and -ed or -ing. e.g.
-
-           caresses  ->  caress
-           ponies    ->  poni
-           ties      ->  ti
-           caress    ->  caress
-           cats      ->  cat
-
-           feed      ->  feed
-           agreed    ->  agree
-           disabled  ->  disable
-
-           matting   ->  mat
-           mating    ->  mate
-           meeting   ->  meet
-           milling   ->  mill
-           messing   ->  mess
-
-           meetings  ->  meet
-        """
-        if self.bself.k == 's':
-            if self.ends("sses"):
-                self.k = self.k - 2
-            elif self.ends("ies"):
-                self.setto("i")
-            elif self.bself.k - 1 != 's':
-                self.k = self.k - 1
-        if self.ends("eed"):
-            if self.m() > 0:
-                self.k = self.k - 1
-        elif (self.ends("ed") or self.ends("ing")) and self.vowelinstem():
-            self.k = self.j
-            if self.ends("at"):
-                self.setto("ate")
-            elif self.ends("bl"):
-                self.setto("ble")
-            elif self.ends("iz"):
-                self.setto("ize")
-            elif self.doublec(self.k):
-                self.k = self.k - 1
-                ch = self.bself.k
-                if ch == 'l' or ch == 's' or ch == 'z':
-                    self.k = self.k + 1
-            elif (self.m() == 1 and self.cvc(self.k)):
-                self.setto("e")
-

_service:tar_scm:gi-docgen-2022.1.tar.xz/.editorconfig -> _service:tar_scm:gi-docgen-2023.1.tar.bz2/.editorconfig Changed

_service:tar_scm:gi-docgen-2022.1.tar.xz/.gitlab-ci.yml -> _service:tar_scm:gi-docgen-2023.1.tar.bz2/.gitlab-ci.yml Changed

@@ -7,36 +7,49 @@
   - check
   - deploy
 
-#meson-build:
-#  stage: build
-#  needs: 
-#  script:
-#    - dnf install -y meson ninja-build pytest python3-flake8 python3-mypy python3-markdown python3-jinja2 python3-toml python3-typogrify
-#    - meson _build .
-#    - meson test -C _build
-#
-#pip-build:
-#  stage: build
-#  needs: 
-#  script:
-#    - dnf install -y python3-pip
-#    - python3 -m pip install --user -e .
-
 .pip:
+  image: fedora:latest
   before_script:
     - export PATH="$HOME/.local/bin:$PATH"
     - dnf install -y python3-pip
 
+meson-build:
+  image: fedora:latest
+  stage: build
+  needs: 
+  script:
+    - dnf install -y meson ninja-build pytest python3-markdown python3-jinja2 python3-pygments python3-typogrify python3-flake8 python3-mypy
+    - meson _build .
+    - meson test -C _build
+
+pip-build:
+  extends: .pip
+  stage: build
+  needs: 
+  script:
+    - python3 -m pip install --user -e .
+
 pytest:
   stage: check
   needs: 
+  image: fedora:latest
+  script:
+    - dnf install -y pytest python3-markdown python3-jinja2 python3-pygments python3-typogrify
+    - pytest --verbose
+
+pytest-tomli:
+  # Validates that tomli configuration works correctly
+  stage: check
+  needs: 
+  image: fedora:36
   script:
-    - dnf install -y pytest python3-markdown python3-jinja2 python3-pygments python3-toml python3-typogrify
+    - dnf install -y pytest python3-markdown python3-jinja2 python3-pygments python3-tomli python3-typogrify
     - pytest --verbose
 
 flake8:
   stage: check
   needs: 
+  image: fedora:latest
   script:
     - dnf install -y python3-flake8
     - flake8 --ignore E501,E402,F405,W503 --show-source gidocgen
@@ -44,6 +57,7 @@
 mypy:
   stage: check
   needs: 
+  image: fedora:latest
   script:
     - dnf install -y python3-mypy
     - mypy --ignore-missing-imports --disallow-incomplete-defs gidocgen

_service:tar_scm:gi-docgen-2022.1.tar.xz/.reuse/dep5 -> _service:tar_scm:gi-docgen-2023.1.tar.bz2/.reuse/dep5 Changed

_service:tar_scm:gi-docgen-2023.1.tar.bz2/CHANGES.md Added

_service:tar_scm:gi-docgen-2022.1.tar.xz/MANIFEST.in -> _service:tar_scm:gi-docgen-2023.1.tar.bz2/MANIFEST.in Changed

_service:tar_scm:gi-docgen-2022.1.tar.xz/README.md -> _service:tar_scm:gi-docgen-2023.1.tar.bz2/README.md Changed

_service:tar_scm:gi-docgen-2022.1.tar.xz/docs/gi-docgen.1 -> _service:tar_scm:gi-docgen-2023.1.tar.bz2/docs/gi-docgen.1 Changed

_service:tar_scm:gi-docgen-2022.1.tar.xz/docs/tools/index.rst -> _service:tar_scm:gi-docgen-2023.1.tar.bz2/docs/tools/index.rst Changed

_service:tar_scm:gi-docgen-2023.1.tar.bz2/docs/tools/serve.rst Added

_service:tar_scm:gi-docgen-2022.1.tar.xz/gidocgen/config.py -> _service:tar_scm:gi-docgen-2023.1.tar.bz2/gidocgen/config.py Changed

@@ -3,11 +3,43 @@
 
 import os
 import re
-import toml
+
+toml_module = None
+try:
+    import tomllib as toml_lib
+    toml_module = 'tomlib'
+except ImportError:
+    try:
+        import tomli as toml_lib
+        toml_module = 'tomli'
+    except ImportError:
+        import toml as toml_lib
+        toml_module = 'toml'
 
 from urllib.parse import urljoin
 
-from . import log, utils
+from . import core, log, utils
+
+
+class TomlConfig:
+    """Wrapper class for TOML loading"""
+
+    @staticmethod
+    def load(toml):
+        log.debug(f"Using TOML module: {toml_module}")
+        if toml_module is None:
+            log.error("No toml module found")
+        elif toml_module in 'tomlib', 'tomli':
+            try:
+                with open(toml, "rb") as f:
+                    return toml_lib.load(f)
+            except toml_lib.TOMLDecodeError as err:
+                log.error(f"Invalid configuration file: {toml}: {err}")
+        elif toml_module in 'toml':
+            try:
+                return toml_lib.load(toml)
+            except toml_lib.TomlDecodeError as err:
+                log.error(f"Invalid configuration file: {toml}: {err}")
 
 
 class GIDocConfig:
@@ -17,11 +49,8 @@
 
         self._config = {}
         if self._config_file is not None:
-            try:
-                log.debug(f"Reading configuration file: {self._config_file}")
-                self._config = toml.load(self._config_file)
-            except toml.TomlDecodeError as err:
-                log.error(f"Invalid configuration file: {self._config_file}: {err}")
+            log.debug(f"Reading configuration file: {self._config_file}")
+            self._config = TomlConfig.load(self._config_file)
 
     @property
     def library(self):
@@ -208,6 +237,30 @@
             return True
         return self.match_object(name, 'check_ignore', category, key)
 
+    def is_unstable(self, version):
+        if not version:
+            return False
+        cur_version = self.library.get('version')
+        if cur_version is None:
+            return False
+        library_version = cur_version.split('.')
+        symbol_version = version.split('.')
+        if len(library_version) < 2 or len(symbol_version) < 2:
+            return False
+        if int(symbol_version0) > int(library_version0):
+            return True
+        elif int(symbol_version0) == int(library_version0):
+            if int(symbol_version1) > int(library_version1):
+                return True
+            else:
+                return False
+        else:
+            return False
+
+    @property
+    def generator(self):
+        return f"{core.version}"
+
 
 class GITemplateConfig:
     """Load and represent the template configuration"""
@@ -217,11 +270,8 @@
         self._config_file = os.path.join(templates_dir, template_name, f"{template_name}.toml")
 
         self._config = {}
-        try:
-            log.debug(f"Reading template configuration file: {self._config_file}")
-            self._config = toml.load(self._config_file)
-        except toml.TomlDecodeError as err:
-            log.error(f"Invalid template configuration file: {self._config_file}: {err}")
+        log.debug(f"Reading template configuration file: {self._config_file}")
+        self._config = TomlConfig.load(self._config_file)
 
     @property
     def name(self):

_service:tar_scm:gi-docgen-2022.1.tar.xz/gidocgen/core.py -> _service:tar_scm:gi-docgen-2023.1.tar.bz2/gidocgen/core.py Changed

_service:tar_scm:gi-docgen-2022.1.tar.xz/gidocgen/gdgenerate.py -> _service:tar_scm:gi-docgen-2023.1.tar.bz2/gidocgen/gdgenerate.py Changed

@@ -68,6 +68,7 @@
     'call': 'The callback arguments are valid during the call.',
     'notified': 'The callback arguments are valid until the notify function is called.',
     'async': 'The callback arguments are valid until the asynchronous call is completed.',
+    'forever': 'The callback arguments are valid until the process is terminated',
 }
 
 SIGNAL_WHEN = {
@@ -188,12 +189,14 @@
         ns = ancestor_type.namespace or namespace.name
     res = namespace.repository.find_class(ancestor_name, ns)
     if res is not None:
-        ancestor_ns = res0.name
+        ancestor_ns_name = res0.name
         ancestor_ctype = res1.base_ctype
+        ancestor_ns = res0
         ancestor = res1
     else:
-        ancestor_ns = ancestor_type.namespace or namespace.name
+        ancestor_ns_name = ancestor_type.namespace or namespace.name
         ancestor_ctype = ancestor_type.base_ctype
+        ancestor_ns = None
         ancestor = None
     n_methods = 0
     methods = 
@@ -213,19 +216,19 @@
         if n_methods > 0 and n_methods < 24:
             for m in ancestor.methods:
                 if not config.is_hidden(ancestor_name, "method", m.name):
-                    methods.append(gen_index_func(m, namespace, md))
+                    methods.append(gen_index_func(m, ancestor_ns, md))
         for p in ancestor.properties.values():
             if not config.is_hidden(ancestor_name, "property", p.name):
                 n_properties += 1
-                properties.append(gen_index_property(p, namespace, md))
+                properties.append(gen_index_property(p, ancestor_ns, md))
         for s in ancestor.signals.values():
             if not config.is_hidden(ancestor_name, "signal", s.name):
                 n_signals += 1
-                signals.append(gen_index_signal(s, namespace, md))
+                signals.append(gen_index_signal(s, ancestor_ns, md))
     return {
-        "namespace": ancestor_ns,
+        "namespace": ancestor_ns_name,
         "name": ancestor_name,
-        "fqtn": f"{ancestor_ns}.{ancestor_name}",
+        "fqtn": f"{ancestor_ns_name}.{ancestor_name}",
         "type_cname": ancestor_ctype,
         "properties": properties,
         "n_properties": n_properties,
@@ -244,12 +247,14 @@
         ns = iface_type.namespace or namespace.name
     res = namespace.repository.find_interface(iface_name, ns)
     if res is not None:
-        iface_ns = res0.name
+        iface_ns_name = res0.name
         iface_ctype = res1.base_ctype
+        iface_ns = res0
         iface = res1
     else:
-        iface_ns = iface_type.namespace or namespace.name
+        iface_ns_name = iface_type.namespace or namespace.name
         iface_ctype = iface_type.base_ctype
+        iface_ns = None
         iface = None
     n_methods = 0
     methods = 
@@ -267,17 +272,17 @@
         if n_methods > 0 and n_methods < 24:
             for m in iface.methods:
                 if not config.is_hidden(iface_name, "method", m.name):
-                    methods.append(gen_index_func(m, namespace, md))
+                    methods.append(gen_index_func(m, iface_ns, md))
         for p in iface.properties.values():
             if not config.is_hidden(iface_name, "property", p.name):
                 n_properties += 1
-                properties.append(gen_index_property(p, namespace, md))
+                properties.append(gen_index_property(p, iface_ns, md))
         for s in iface.signals.values():
             if not config.is_hidden(iface.name, "signal", s.name):
                 n_signals += 1
-                signals.append(gen_index_signal(s, namespace, md))
+                signals.append(gen_index_signal(s, iface_ns, md))
     return {
-        "namespace": iface_ns,
+        "namespace": iface_ns_name,
         "name": iface_name,
         "fqtn": f"{iface_ns}.{iface_name}",
         "type_cname": iface_ctype,
@@ -344,6 +349,7 @@
     def __init__(self, namespace, const):
         self.value = const.value
         self.identifier = const.ctype
+        self.type_name = const.target.name
         self.type_cname = const.target.ctype
         self.namespace = namespace.name
         self.name = const.name
@@ -377,6 +383,9 @@
 
     @property
     def c_decl(self):
+        # String constants are unquoted in the GIR
+        if self.type_name in "utf8", "filename":
+            return utils.code_highlight(f'#define {self.identifier} "{self.value}"')
         return utils.code_highlight(f"#define {self.identifier} {self.value}")
 
 
@@ -1244,6 +1253,16 @@
         self.requires_fqtn = f"{self.requires_namespace}.{self.requires_name}"
         log.debug(f"Preqrequisite for {self.fqtn}: {self.requires_fqtn}")
 
+        def prereq_link_fragment(_ns: gir.Namespace, ns: str, name: str) -> str:
+            if _ns.repository.find_class(name, ns) is not None:
+                return "class"
+            elif _ns.repository.find_interface(name, ns) is not None:
+                return "iface"
+            else:
+                log.error(f"Invalid prerequisite type {ns}.{name}")
+
+        self.requires_link_fragment = prereq_link_fragment(namespace, self.requires_namespace, self.requires_name)
+
         self.symbol_prefix = f"{namespace.symbol_prefix0}_{interface.symbol_prefix}"
         self.type_cname = interface.base_ctype
 
@@ -1279,13 +1298,15 @@
 
         self.class_struct = namespace.find_record(interface.type_struct)
         if self.class_struct is not None:
+            if self.class_struct.doc:
+                self.class_description = utils.preprocess_docs(self.class_struct.doc.content, namespace, md=md)
+            else:
+                self.class_description = MISSING_DESCRIPTION
             self.class_fields = 
-            self.class_methods = 
-
             for field in self.class_struct.fields:
                 if not field.private:
                     self.class_fields.append(TemplateField(namespace, field))
-
+            self.class_methods = 
             for method in self.class_struct.methods:
                 self.class_methods.append(gen_index_func(method, namespace, md))
 
@@ -1457,13 +1478,15 @@
 
         if self.class_struct is not None:
             self.class_ctype = self.class_struct.ctype
+            if self.class_struct.doc:
+                self.class_description = utils.preprocess_docs(self.class_struct.doc.content, namespace, md=md)
+            else:
+                self.class_description = MISSING_DESCRIPTION
             self.class_fields = 
-            self.class_methods = 
-
             for field in self.class_struct.fields:
                 if not field.private:
                     self.class_fields.append(TemplateField(namespace, field))
-
+            self.class_methods = 
             for method in self.class_struct.methods:
                 self.class_methods.append(gen_index_func(method, namespace, md))
 
@@ -2662,7 +2685,12 @@
     def dump_tree(node, out):
         for k in node:
             if '.' in k:
-                out.append(f'<li class="type"><code>{k}</code>')
+                ns, name = k.split('.', 2)
+                data_ns = f'data-namespace="{ns}"'
+                data_link = f'data-link="class.{name}.html"'
+                href = 'href="javascript:void(0)"'
+                css_class = 'class="external"'
+                out.append(f'<li class="type"><a {data_ns} {data_link} {href} {css_class}><code>{k}</code></a>')
             else:
                 out.append(f'<li class="type"><a href="class.{k}.html"><code>{k}</code></a>')
             if len(nodek) != 0:
@@ -2674,7 +2702,7 @@
     if len(objects_tree) != 0:
         res += "<div class=\"docblock\">"
         res += "<ul class=\"type root\">"
-        res += " <li class=\"type\"><code>GObject</code></li><ul class=\"type\">"
+        res += " <li class=\"type\"><a data-namespace=\"GObject\" data-link=\"class.Object.html\" href=\"javascript:void(0)\" class=\"external\"><code>GObject.Object</code></a></li><ul class=\"type\">"  # noqa: E501
         dump_tree(objects_tree, res)
         res += " </ul></li>"
         res += "</ul>"
@@ -2683,7 +2711,7 @@
     if len(typed_tree) != 0:
         res += "<div class=\"docblock\">"
         res += "<ul class=\"type root\">"
-        res += " <li class=\"type\"><code>GTypeInstance</code></li><ul class=\"type\">"
+        res += " <li class=\"type\"><a data-namespace=\"GObject\" data-link=\"struct.TypeInstance.html\" href=\"javascript:void(0)\" class=\"external\"><code>GObject.TypeInstance</code></li><ul class=\"type\">"  # noqa: E501
         dump_tree(typed_tree, res)
         res += " </ul></li>"
         res += "</ul>"
@@ -2793,7 +2821,7 @@
                 keyword = etree.SubElement(functions, "keyword")
                 keyword.set("type", "constant")
                 keyword.set("name", t.identifier)
-                keyword.set("link", f"constant.{t.name}.html")
+                keyword.set("link", f"const.{t.name}.html")

_service:tar_scm:gi-docgen-2022.1.tar.xz/gidocgen/gdgenindices.py -> _service:tar_scm:gi-docgen-2023.1.tar.bz2/gidocgen/gdgenindices.py Changed

@@ -6,7 +6,7 @@
 import os
 import sys
 
-from . import config, core, gir, log, porter, utils
+from . import config, core, gir, log, utils
 
 
 HELP_MSG = "Generates the symbol indices for search"
@@ -14,22 +14,13 @@
 MISSING_DESCRIPTION = "No description available."
 
 
-def add_index_terms(index, terms, docid):
-    for term in terms:
-        docs = index.setdefault(term, )
-        if docid not in docs:
-            docs.append(docid)
-
-
-def _gen_aliases(config, stemmer, index, repository, symbols):
+def _gen_aliases(config, index, repository, symbols):
     index_symbols = index"symbols"
-    index_terms = index"terms"
 
     for alias in symbols:
         if config.is_hidden(alias.name):
             log.debug(f"Skipping hidden type {alias.name}")
             continue
-        idx = len(index_symbols)
         if alias.doc is not None:
             description = alias.doc.content
         else:
@@ -40,20 +31,15 @@
             "ctype": alias.base_ctype,
             "summary": utils.preprocess_docs(description, repository.namespace, summary=True, plain=True),
         })
-        add_index_terms(index_terms, alias.base_ctype.lower(), idx)
-        add_index_terms(index_terms, utils.index_identifier(alias.name, stemmer), idx)
-        add_index_terms(index_terms, utils.index_description(description, stemmer), idx)
 
 
-def _gen_bitfields(config, stemmer, index, repository, symbols):
+def _gen_bitfields(config, index, repository, symbols):
     index_symbols = index"symbols"
-    index_terms = index"terms"
 
     for bitfield in symbols:
         if config.is_hidden(bitfield.name):
             log.debug(f"Skipping hidden type {bitfield.name}")
             continue
-        idx = len(index_symbols)
         if bitfield.doc is not None:
             description = bitfield.doc.content
         else:
@@ -64,17 +50,8 @@
             "ctype": bitfield.base_ctype,
             "summary": utils.preprocess_docs(description, repository.namespace, summary=True, plain=True),
         })
-        add_index_terms(index_terms, bitfield.base_ctype.lower(), idx)
-        add_index_terms(index_terms, utils.index_identifier(bitfield.name, stemmer), idx)
-        add_index_terms(index_terms, utils.index_description(description, stemmer), idx)
-
-        for member in bitfield.members:
-            add_index_terms(index_terms, member.name, idx)
-            if member.doc is not None:
-                add_index_terms(index_terms, utils.index_description(member.doc.content, stemmer), idx)
 
         for func in bitfield.functions:
-            func_idx = len(index_symbols)
             if func.doc is not None:
                 func_desc = func.doc.content
             else:
@@ -86,20 +63,15 @@
                 "ident": func.identifier,
                 "summary": utils.preprocess_docs(func_desc, repository.namespace, summary=True, plain=True)
             })
-            add_index_terms(index_terms, func.identifier, func_idx)
-            add_index_terms(index_terms, utils.index_symbol(func.name, stemmer), func_idx)
-            add_index_terms(index_terms, utils.index_description(func_desc, stemmer), func_idx)
 
 
-def _gen_callbacks(config, stemmer, index, repository, symbols):
+def _gen_callbacks(config, index, repository, symbols):
     index_symbols = index"symbols"
-    index_terms = index"terms"
 
     for callback in symbols:
         if config.is_hidden(callback.name):
             log.debug(f"Skipping hidden callback {callback.name}")
             continue
-        idx = len(index_symbols)
         if callback.doc is not None:
             cb_desc = callback.doc.content
         else:
@@ -110,22 +82,16 @@
             "ctype": callback.base_ctype,
             "summary": utils.preprocess_docs(cb_desc, repository.namespace, summary=True, plain=True),
         })
-        add_index_terms(index_terms, callback.base_ctype.lower(), idx)
-        add_index_terms(index_terms, utils.index_identifier(callback.name, stemmer), idx)
-        add_index_terms(index_terms, utils.index_description(cb_desc, stemmer), idx)
 
 
-def _gen_classes(config, stemmer, index, repository, symbols):
+def _gen_classes(config, index, repository, symbols):
     namespace = repository.namespace
-
     index_symbols = index"symbols"
-    index_terms = index"terms"
 
     for cls in symbols:
         if config.is_hidden(cls.name):
             log.debug(f"Skipping hidden type {cls.name}")
             continue
-        idx = len(index_symbols)
         if cls.doc is not None:
             cls_desc = cls.doc.content
         else:
@@ -136,12 +102,8 @@
             "ctype": cls.base_ctype,
             "summary": utils.preprocess_docs(cls_desc, repository.namespace, summary=True, plain=True),
         })
-        add_index_terms(index_terms, cls.base_ctype.lower(), idx)
-        add_index_terms(index_terms, utils.index_identifier(cls.name, stemmer), idx)
-        add_index_terms(index_terms, utils.index_description(cls_desc, stemmer), idx)
 
         for ctor in cls.constructors:
-            ctor_idx = len(index_symbols)
             if ctor.doc is not None:
                 ctor_desc = ctor.doc.content
             else:
@@ -153,12 +115,8 @@
                 "ident": ctor.identifier,
                 "summary": utils.preprocess_docs(ctor_desc, repository.namespace, summary=True, plain=True),
             })
-            add_index_terms(index_terms, ctor.identifier, ctor_idx)
-            add_index_terms(index_terms, utils.index_symbol(ctor.name, stemmer), ctor_idx)
-            add_index_terms(index_terms, utils.index_description(ctor_desc, stemmer), ctor_idx)
 
         for method in cls.methods:
-            method_idx = len(index_symbols)
             if method.doc is not None:
                 method_desc = method.doc.content
             else:
@@ -170,12 +128,8 @@
                 "ident": method.identifier,
                 "summary": utils.preprocess_docs(method_desc, repository.namespace, summary=True, plain=True),
             })
-            add_index_terms(index_terms, method.identifier, method_idx)
-            add_index_terms(index_terms, utils.index_symbol(method.name, stemmer), method_idx)
-            add_index_terms(index_terms, utils.index_description(method_desc, stemmer), method_idx)
 
         for func in cls.functions:
-            func_idx = len(index_symbols)
             if func.doc is not None:
                 func_desc = func.doc.content
             else:
@@ -187,15 +141,11 @@
                 "ident": func.identifier,
                 "summary": utils.preprocess_docs(func_desc, repository.namespace, summary=True, plain=True),
             })
-            add_index_terms(index_terms, func.identifier, func_idx)
-            add_index_terms(index_terms, utils.index_symbol(func.name, stemmer), func_idx)
-            add_index_terms(index_terms, utils.index_description(func_desc, stemmer), func_idx)
 
         for prop_name, prop in cls.properties.items():
             if config.is_hidden(cls.name, 'property', prop_name):
                 log.debug(f"Skipping hidden property {cls.name}.{prop_name}")
                 continue
-            prop_idx = len(index_symbols)
             if prop.doc is not None:
                 prop_desc = prop.doc.content
             else:
@@ -206,14 +156,11 @@
                 "type_name": cls.name,
                 "summary": utils.preprocess_docs(prop_desc, repository.namespace, summary=True, plain=True),
             })
-            add_index_terms(index_terms, utils.index_symbol(prop.name, stemmer), prop_idx)
-            add_index_terms(index_terms, utils.index_description(prop_desc, stemmer), prop_idx)
 
         for signal_name, signal in cls.signals.items():
             if config.is_hidden(cls.name, 'signal', signal_name):
                 log.debug(f"Skipping hidden signal {cls.name}.{signal_name}")
                 continue
-            signal_idx = len(index_symbols)
             if signal.doc is not None:
                 signal_desc = signal.doc.content
             else:
@@ -224,11 +171,8 @@
                 "type_name": cls.name,
                 "summary": utils.preprocess_docs(signal_desc, repository.namespace, summary=True, plain=True),
             })
-            add_index_terms(index_terms, utils.index_symbol(signal.name, stemmer), signal_idx)
-            add_index_terms(index_terms, utils.index_description(signal_desc, stemmer), signal_idx)
 
         for vfunc in cls.virtual_methods:
-            vfunc_idx = len(index_symbols)
             if vfunc.doc is not None:
                 vfunc_desc = vfunc.doc.content

_service:tar_scm:gi-docgen-2022.1.tar.xz/gidocgen/gdsearch.py -> _service:tar_scm:gi-docgen-2023.1.tar.bz2/gidocgen/gdsearch.py Changed

@@ -89,6 +89,23 @@
     return None
 
 
+def _gen_constant_result(symbol, namespace):
+    const = namespace.find_real_type(symbol"name")
+
+    if const.doc is not None:
+        summary = utils.preprocess_docs(const.doc.content, namespace, summary=True, plain=True)
+    else:
+        summary = "Missing documentation"
+
+    return {
+        "type": "constant",
+        "name": const.name,
+        "ctype": const.ctype,
+        "summary": summary.split("\n"),
+        "link": f"const.{const.name}.html",
+    }
+
+
 def _gen_ctor_result(symbol, namespace):
     t = namespace.find_real_type(symbol"type_name")
 
@@ -335,6 +352,20 @@
     return None
 
 
+def search_symbols(real_term, symbols):
+    term = real_term.lower()
+
+    matches = 
+    for symbol in symbols:
+        if any(
+            term in symbol.get("name", "").lower(),
+            term in symbol.get("ctype", "").lower(),
+            term in symbol.get("summary", "").lower(),
+        ):
+            matches.append(symbol)
+    return matches
+
+
 def query(repository, terms, index_file):
     if index_file is None:
         index_file = os.path.join(os.getcwd(), "index.json")
@@ -346,7 +377,6 @@
 
     index_meta = index"meta"
     index_symbols = index"symbols"
-    index_terms = index"terms"
 
     if index_meta"ns" != namespace.name or index_meta"version" != namespace.version:
         log.error("Index file does not match the GIR namespace")
@@ -357,6 +387,7 @@
         "callback": _gen_callback_result,
         "class": _gen_class_result,
         "class_method": _gen_class_method_result,
+        "constant": _gen_constant_result,
         "ctor": _gen_ctor_result,
         "domain": _gen_domain_result,
         "enum": _gen_enum_result,
@@ -375,20 +406,22 @@
     results = 
 
     for term in terms:
-        docs = index_terms.get(term, )
-        for doc in docs:
-            symbol = index_symbolsdoc
-
+        symbols = search_symbols(term, index_symbols)
+        for symbol in symbols:
             gen_result = result_types.get(symbol"type")
             if gen_result is None:
                 log.warning(f"Unhandled symbol type {symbol'type'} for '{term}'")
                 continue
 
             res = gen_result(symbol, namespace)
-            results.append(res)
+            if not res:
+                log.debug(f"No details for result {symbol'name'}")
+            else:
+                log.debug(f"Adding results for {symbol'name'}")
+                results.append(res)
 
     prefix = "result:"
-    indent = ''.join(' ' for x in range(len(prefix)))
+    indent = ' ' * len(prefix)
 
     n_results = len(results)
     terms_str = ", ".join(terms)

_service:tar_scm:gi-docgen-2023.1.tar.bz2/gidocgen/gdserver.py Added

@@ -0,0 +1,182 @@
+# SPDX-FileCopyrightText: 2022  Emmanuele Bassi
+# SPDX-License-Identifier: Apache-2.0 OR GPL-3.0-or-later
+
+import os
+import posixpath
+import urllib
+
+from http import server
+
+try:
+    from magic import from_file as magic_from_file
+except ImportError:
+    magic_from_file = None
+
+from . import config, gir, log, gdgenerate, utils
+
+
+HELP_MSG = "Serve the gi-docgen output locally"
+
+
+class GDHTTPRequestHandler(server.SimpleHTTPRequestHandler):
+    SUFFIXES = 
+        '.html',
+        '/index.html',
+        '/',
+        '',
+    
+
+    extensions_map = {
+        **server.SimpleHTTPRequestHandler.extensions_map,
+        ** {
+            ".ttf": "font/ttf",
+            ".woff": "font/woff",
+            ".woff2": "font/woff2",
+        },
+    }
+
+    def translate_path(self, path):
+        path = path.split('?', 1)0
+        path = path.split('#', 1)0
+        trailing_slash = path.rstrip().endswith('/')
+        path = urllib.parse.unquote(path)
+        path = posixpath.normpath(path)
+        words = path.split('/')
+        words = filter(None, words)
+        path = self.base_path
+        for word in words:
+            if os.path.dirname(word) or word in (os.curdir, os.pardir):
+                # Ignore components that are not a simple file/directory name
+                continue
+            path = os.path.join(path, word)
+        if trailing_slash:
+            path += '/'
+        return path
+
+    def do_GET(self):
+        # cut off a query string
+        original_path = self.path.split('?', 1)0
+        # try to find file
+        self.path = self.get_path_that_exists(original_path)
+        if not self.path:
+            return
+        server.SimpleHTTPRequestHandler.do_GET(self)
+
+    def get_path_that_exists(self, original_path):
+        # Try to strip trailing slash
+        trailing_slash = original_path.endswith('/')
+        original_path = original_path.rstrip('/')
+        # Try to detect file by applying various suffixes
+        tries = 
+        for suffix in self.SUFFIXES:
+            if not trailing_slash and suffix == '/':
+                # if original request does not have trailing slash, skip the '/' suffix
+                # so that base class can redirect if needed
+                continue
+            path = original_path + suffix
+            if os.path.exists(self.translate_path(path)):
+                return path
+            tries.append(path)
+        log.warning(f"Unable to find '{original_path}' or variations: {tries}")
+        return None
+
+    def guess_type(self, path):
+        mimetype = server.SimpleHTTPRequestHandler.guess_type(self, path)
+        # If the default guess is too generic, try the python-magic library
+        if mimetype == 'application/octet-stream' and magic_from_file:
+            mimetype = magic_from_file(path, mime=True)
+        return mimetype
+
+    def log_message(self, fmt, *args):
+        log.info(fmt % args)
+
+
+class RootedHTTPServer(server.HTTPServer):
+    def __init__(self, base_path, *args, **kwargs):
+        server.HTTPServer.__init__(self, *args, **kwargs)
+        self.RequestHandlerClass.base_path = base_path
+
+
+def add_args(parser):
+    # Reuse the generate arguments
+    gdgenerate.add_args(parser)
+    # Add the local server arguments
+    parser.add_argument("--bind", "-b", dest="server", default="127.0.0.1",
+                        help="The IP used to serve HTTP requests")
+    parser.add_argument("--port", "-p", dest="port", type=int, default=8080,
+                        help="The port used to serve HTTP requests")
+
+
+def run(options):
+    log.info(f"Loading config file: {options.config}")
+
+    # We need to re-implement gdgenerate.run() here, because the output
+    # directory is computed from the configuration and/or the namespace
+    # of the introspection data; we could reuse gdgenerate.run(), but it
+    # would mean doing the configuration and GIR parsing twice
+    conf = config.GIDocConfig(options.config)
+
+    output_dir = options.output_dir or os.getcwd()
+
+    content_dirs = options.content_dirs
+    if content_dirs == :
+        content_dirs = os.getcwd()
+
+    if options.templates_dir is not None:
+        templates_dir = options.templates_dir
+    else:
+        templates_dir = conf.get_templates_dir()
+        if templates_dir is None:
+            templates_dir = os.path.join(os.path.dirname(__file__), 'templates')
+
+    theme_name = conf.get_theme_name(default=options.theme_name)
+    theme_conf = config.GITemplateConfig(templates_dir, theme_name)
+
+    log.debug(f"Templates directory: {templates_dir}")
+    log.info(f"Theme name: {theme_conf.name}")
+    log.info(f"Output directory: {output_dir}")
+
+    paths = 
+    paths.extend(options.include_paths)
+    paths.extend(utils.default_search_paths())
+    log.debug(f"Search paths: {paths}")
+
+    log.info("Parsing GIR file")
+    parser = gir.GirParser(search_paths=paths)
+    parser.parse(options.infile)
+
+    log.checkpoint()
+    if options.dry_run:
+        return 0
+
+    gdgenerate.gen_reference(conf, options, parser.get_repository(),
+                             templates_dir, theme_conf,
+                             content_dirs, output_dir)
+
+    if options.no_namespace_dir:
+        ns_dir = output_dir
+    else:
+        namespace = parser.get_repository().namespace
+        ns_dir = os.path.join(output_dir, f"{namespace.name}-{namespace.version}")
+
+    RootedHTTPServer.allow_reuse_address = True
+
+    log.checkpoint()
+    try:
+        httpd = RootedHTTPServer(ns_dir,
+                                 (options.server, options.port),
+                                 GDHTTPRequestHandler)
+    except OSError as e:
+        log.error(f"Could not listen on port {options.port}, server {options.server}: {e}")
+        return 1
+    try:
+        log.info(f"Serving site at: http://{options.server}:{options.port} - Press CTRL-C to stop")
+        httpd.serve_forever()
+    except Exception as e:
+        log.warning(f"Error: {e}")
+        return 1
+    except KeyboardInterrupt:
+        log.info("Terminating local server")
+        httpd.socket.close()
+
+    return 0

_service:tar_scm:gi-docgen-2022.1.tar.xz/gidocgen/gidocmain.py -> _service:tar_scm:gi-docgen-2023.1.tar.bz2/gidocgen/gidocmain.py Changed

_service:tar_scm:gi-docgen-2022.1.tar.xz/gidocgen/gir/ast.py -> _service:tar_scm:gi-docgen-2023.1.tar.bz2/gidocgen/gir/ast.py Changed

@@ -36,12 +36,6 @@
         self.value = value
 
 
-class CInclude:
-    """A C include header"""
-    def __init__(self, name: str):
-        self.name = name
-
-
 class Include:
     """A GIR include"""
     def __init__(self, name: str, version: str = None):
@@ -59,12 +53,6 @@
         return f"{self.name}.gir"
 
 
-class Package:
-    """Pkg-config containing the library"""
-    def __init__(self, name: str):
-        self.name = name
-
-
 class Info:
     """Base information for most types"""
     def __init__(self, introspectable: bool = True, deprecated: T.Optionalstr = None,
@@ -933,8 +921,8 @@
 class Repository:
     def __init__(self):
         self.includes: T.Mappingstr, Repository = {}
-        self.packages: T.ListPackage = 
-        self.c_includes: T.ListCInclude = 
+        self.packages: T.Liststr = 
+        self.c_includes: T.Liststr = 
         self.types: T.Mappingstr, T.ListType = {}
         self._namespaces: T.ListNamespace = 
         self.girfile: T.Optionalstr = None

_service:tar_scm:gi-docgen-2022.1.tar.xz/gidocgen/log.py -> _service:tar_scm:gi-docgen-2023.1.tar.bz2/gidocgen/log.py Changed

_service:tar_scm:gi-docgen-2023.1.tar.bz2/gidocgen/py.typed Added

_service:tar_scm:gi-docgen-2022.1.tar.xz/gidocgen/templates/basic/base.html -> _service:tar_scm:gi-docgen-2023.1.tar.bz2/gidocgen/templates/basic/base.html Changed

_service:tar_scm:gi-docgen-2022.1.tar.xz/gidocgen/templates/basic/class.html -> _service:tar_scm:gi-docgen-2023.1.tar.bz2/gidocgen/templates/basic/class.html Changed

@@ -1,9 +1,3 @@
-
-
 {% extends "base.html" %}
 
 {% block title %}{{ namespace.name }}.{{ class.name }}{% endblock %}
@@ -100,6 +94,20 @@
 
   <section>
     <summary>
+      <div class="docblock">
+        <p>
+        {%- if CONFIG.is_unstable(class.available_since) -%}
+        <span class="emblem available-next" title="This type will be available in the next stable release">unstable</span>&nbsp;
+        {%- endif %}
+        {%- if class.deprecated_since -%}
+        <span class="emblem deprecated">deprecated: {{ class.deprecated_since.version }}</span>&nbsp;
+        {%- endif -%}
+        {%- if class.available_since -%}
+        <span class="emblem available">since: {{ class.available_since }}</span>
+        {%- endif -%}
+        </p>
+      </div>
+
       <div class="toggle-wrapper">
         <h4 id="description" style="display:flex;">
           Description
@@ -116,18 +124,22 @@
         </div>
 
         <div class="docblock">
-          <table class="attributes">
-            {% if class.stability %}
-            <tr><td>Stability:</td><td>{{ class.stability }}</td></tr>
-            {% endif %}
-            {% if class.available_since %}
-            <tr><td>Available since:</td><td>{{ class.available_since }}</td></tr>
-            {% endif %}
-            {% if class.deprecated_since %}
-            <tr><td>Deprecated since:</td><td>{{ class.deprecated_since.version }}</td></tr>
-            <tr><td colspan="2">{{ class.deprecated_since.message }}</td></tr>
-            {% endif %}
-          </table>
+          {% if class.stability %}
+          <p>Stability: {{ class.stability }}</p>
+          {% endif %}
+          {% if class.available_since %}
+          <p>Available since: {{ class.available_since }}</p>
+          {% endif %}
+          {% if class.deprecated_since %}
+          {%- if class.deprecated_since.message -%}
+          <div>
+            <p>Deprecated since: {{ class.deprecated_since.version }}</p>
+            {{ class.deprecated_since.message }}
+          </div>
+          {%- else -%}
+          <p>Deprecated since: {{ class.deprecated_since.version }}. Do not use in newly written code.</p>
+          {%- endif -%}
+          {% endif %}
         </div>
 
         {% if class.attributes %}
@@ -220,21 +232,22 @@
       {% for ctor in class.ctors %}
         <div class="{% if ctor.deprecated_since %}deprecated{% endif %}">
           <h6><a href="ctor.{{ class.name }}.{{ ctor.name }}.html">{{ ctor.identifier }}</a></h6>
-
           <div class="docblock">
             {{ ctor.summary }}
           </div>
-
-          {% if ctor.available_since or ctor.deprecated_since -%}
           <div class="docblock">
-          {%- if ctor.available_since -%}
-          <p>Available since: {{ ctor.available_since }}</p>
-          {%- endif -%}
-          {%- if ctor.deprecated_since -%}
-          <p>Deprecated since: {{ ctor.deprecated_since }}</p>
-          {%- endif -%}
+            <p>
+            {%- if CONFIG.is_unstable(ctor.available_since) -%}
+            <span class="emblem available-next" title="This constructor will be available in the next stable release">unstable</span>&nbsp;
+            {%- endif %}
+            {%- if ctor.deprecated_since -%}
+            <span class="emblem deprecated">deprecated: {{ ctor.deprecated_since }}</span>&nbsp;
+            {%- endif -%}
+            {%- if ctor.available_since -%}
+            <span class="emblem available">since: {{ ctor.available_since }}</span>
+            {%- endif -%}
+            </p>
           </div>
-          {%- endif %}
         </div>
       {% endfor %}
       </div>
@@ -252,21 +265,22 @@
       {% for func in class.type_funcs %}
       <div class="{% if func.deprecated_since %}deprecated{% endif %}">
         <h6><a href="type_func.{{ class.name }}.{{ func.name }}.html">{{ func.identifier }}</a></h6>
-
         <div class="docblock">
           {{ func.summary }}
         </div>
-
-        {% if func.available_since or func.deprecated_since -%}
         <div class="docblock">
-        {%- if func.available_since -%}
-        <p>Available since: {{ func.available_since }}</p>
-        {%- endif -%}
-        {%- if func.deprecated_since -%}
-        <p>Deprecated since: {{ func.deprecated_since }}</p>
-        {%- endif -%}
+          <p>
+          {%- if CONFIG.is_unstable(func.available_since) -%}
+          <span class="emblem available-next" title="This function will be available in the next stable release">unstable</span>&nbsp;
+          {%- endif %}
+          {%- if func.deprecated_since -%}
+          <span class="emblem deprecated">deprecated: {{ func.deprecated_since }}</span>&nbsp;
+          {%- endif -%}
+          {%- if func.available_since -%}
+          <span class="emblem available">since: {{ func.available_since }}</span>
+          {%- endif -%}
+          </p>
         </div>
-        {%- endif %}
       </div>
       {% endfor %}
       </div>
@@ -287,16 +301,19 @@
           <div class="docblock">
             {{ method.summary }}
           </div>
-          {% if method.available_since or method.deprecated_since -%}
           <div class="docblock">
-          {%- if method.available_since -%}
-          <p>Available since: {{ method.available_since }}</p>
-          {%- endif -%}
-          {%- if method.deprecated_since -%}
-          <p>Deprecated since: {{ method.deprecated_since }}</p>
-          {%- endif -%}
+            <p>
+            {%- if CONFIG.is_unstable(method.available_since) -%}
+            <span class="emblem available-next" title="This method will be available in the next stable release">unstable</span>&nbsp;
+            {%- endif %}
+            {%- if method.deprecated_since -%}
+            <span class="emblem deprecated">deprecated: {{ method.deprecated_since }}</span>&nbsp;
+            {%- endif -%}
+            {%- if method.available_since -%}
+            <span class="emblem available">since: {{ method.available_since }}</span>
+            {%- endif -%}
+            </p>
           </div>
-          {%- endif %}
         </div>
       {% endfor %}
       </div>
@@ -320,16 +337,19 @@
             <div class="docblock">
               {{ method.summary }}
             </div>
-            {% if method.available_since or method.deprecated_since -%}
             <div class="docblock">
-            {%- if method.available_since -%}
-              <p>Available since: {{ method.available_since }}</p>
-            {%- endif -%}
-            {%- if method.deprecated_since -%}
-              <p>Deprecated since: {{ method.deprecated_since }}</p>
-            {%- endif -%}
+              <p>
+              {%- if CONFIG.is_unstable(method.available_since) -%}
+              <span class="emblem available-next" title="This method will be available in the next stable release">unstable</span>&nbsp;
+              {%- endif %}
+              {%- if method.deprecated_since -%}
+              <span class="emblem deprecated">deprecated: {{ method.deprecated_since }}</span>&nbsp;
+              {%- endif -%}
+              {%- if method.available_since -%}
+              <span class="emblem available">since: {{ method.available_since }}</span>
+              {%- endif -%}
+              </p>
             </div>
-            {%- endif %}
           {% else %}
             <div class="docblock">
               <p>Please see&nbsp;
@@ -365,16 +385,19 @@
             <div class="docblock">
               {{ method.summary }}
             </div>
-            {% if method.available_since or method.deprecated_since -%}
             <div class="docblock">
-            {%- if method.available_since -%}
-              <p>Available since: {{ method.available_since }}</p>
-            {%- endif -%}
-            {%- if method.deprecated_since -%}
-              <p>Deprecated since: {{ method.deprecated_since }}</p>
-            {%- endif -%}

_service:tar_scm:gi-docgen-2022.1.tar.xz/gidocgen/templates/basic/class_method.html -> _service:tar_scm:gi-docgen-2023.1.tar.bz2/gidocgen/templates/basic/class_method.html Changed

@@ -1,16 +1,12 @@
-
-
 {% extends "base.html" %}
 
 {% block title %}{{ namespace.name }}.{{ class.class_name }}.{{ class_method.name }}{% endblock %}
 
 {% block meta_other %}
-<meta name="og:title" content="{{ namespace.name }}.{{ class.class_name }}.{{ class_method.name }}"/>
-<meta name="og:description" content="Reference for {{ namespace.name }}.{{ class.class_name }}.{{ class_method.name }}"/>
+  <meta priority="og:title" content="{{ namespace.name }}.{{ class.class_name }}.{{ class_method.name }}"/>
+  <meta priority="og:description" content="Reference for {{ namespace.name }}.{{ class.class_name }}.{{ class_method.name }}"/>
+  <meta name="og:title" content="{{ namespace.name }}.{{ class.class_name }}.{{ class_method.name }}"/>
+  <meta name="og:description" content="Reference for {{ namespace.name }}.{{ class.class_name }}.{{ class_method.name }}"/>
 {% endblock %}
 
 {% block sidebar %}
@@ -38,6 +34,19 @@
   </header>
 
   <section>
+    <div class="docblock">
+      <p>
+      {%- if CONFIG.is_unstable(class_method.available_since) -%}
+      <span class="emblem available-next" title="This method will be available in the next stable release">unstable</span>&nbsp;
+      {%- endif %}
+      {%- if class_method.deprecated_since -%}
+      <span class="emblem deprecated">deprecated: {{ class_method.deprecated_since.version }}</span>&nbsp;
+      {%- endif -%}
+      {%- if class_method.available_since -%}
+      <span class="emblem available">since: {{ class_method.available_since }}</span>
+      {%- endif -%}
+      </p>
+    </div>
     <div class="declaration">
       <h4 id="declaration" style="display:flex;">
         Declaration
@@ -66,21 +75,25 @@
       </div>
 
       <div class="docblock">
-        <table>
-          {% if class_method.stability %}
-          <tr><td>Stability:</td><td>{{ class_method.stability }}</td></tr>
-          {% endif %}
-          {% if class_method.available_since %}
-          <tr><td>Available since:</td><td>{{ class_method.available_since }}</td></tr>
-          {% endif %}
-          {% if class_method.deprecated_since %}
-          <tr><td>Deprecated since:</td><td>{{ class_method.deprecated_since.version }}</td></tr>
-          <tr><td colspan="2">{{ class_method.deprecated_since.message }}</td></tr>
-          {% endif %}
-          {% if not class_method.introspectable %}
-          <tr><td>This class method is not directly available to language bindings</td></tr>
-          {% endif %}
-        </table>
+        {% if class_method.stability -%}
+        <p>Stability: {{ class_method.stability }}</p>
+        {%- endif %}
+        {% if class_method.available_since -%}
+        <p>Available since: {{ class_method.available_since }}</p>
+        {%- endif %}
+        {% if class_method.deprecated_since -%}
+        <div>
+          {%- if class_method.deprecated_since.message -%}
+          <p>Deprecated since: {{ class_method.deprecated_since.version }}</p>
+          {{ class_method.deprecated_since.message }}
+          {%- else -%}
+          <p>Deprecated since: {{ class_method.deprecated_since.version }}. Do not use in newly written code</p>
+          {%- endif -%}
+        </div>
+        {%- endif %}
+        {% if not class_method.introspectable -%}
+        <p>This method is not directly available to language bindings.</p>
+        {%- endif %}
       </div>
 
       {% if class_method.attributes %}
@@ -102,11 +115,11 @@
       </h4>
 
       <div class="docblock">
-        <table class="arguments">
+        <dl class="arguments">
           {% for arg in class_method.arguments %}
-          <tr class="arg-name">
-            <td><code>{{ arg.name }}</code></td>
-            <td>
+          <dt class="arg-name"><code>{{ arg.name }}</code></dt>
+          <dd class="arg-description">
+            <p><em>Type:</em>&nbsp;
             {%- if arg.is_array -%}An array of&nbsp;{%- endif -%}
             {%- if arg.is_list -%}A list of&nbsp;{%- endif -%}
             {%- if arg.link -%}
@@ -114,33 +127,36 @@
             {%- else -%}
             <code>{{ arg.type_cname }}</code>
             {%- endif -%}
-            </td>
-          </tr>
-          <tr class="arg-description">
-            <td>&nbsp;</td>
-            <td>{{ arg.description|safe }}</td>
-          </tr>
-          {% if arg.direction != "in" %}<tr><td>&nbsp;</td><td title="direction: {{ arg.direction}}">{{ arg.direction_note }}</td></tr>{% endif %}
-          {% if arg.direction == "in" and arg.nullable %}<tr><td>&nbsp;</td><td>The argument can be <code>NULL</code>.</td></tr>{% endif %}
-          {% if arg.direction in "inout", "out" and arg.nullable %}<tr><td>&nbsp;</td><td>The argument can be set to <code>NULL</code>.</td></tr>{% endif %}
-          {% if arg.optional %}<tr><td>&nbsp;</td><td>The argument can be <code>NULL</code>.</td></tr>{% endif %}
-          {% if arg.is_array and arg.zero_terminated %}<tr><td>&nbsp;</td><td>The array must be <code>NULL</code>-terminated.</td></tr>{% endif %}
-          {% if arg.is_array and arg.fixed_size > 0 %}<tr><td>&nbsp;</td><td>The array must have {{ arg.fixed_size }} elements.</td></tr>{% endif %}
-          {% if arg.is_array and arg.len_arg %}<tr><td>&nbsp;</td><td>The length of the array is specified in the <code>{{ arg.len_arg }}</code> argument.</td></tr>{% endif %}
-          {% if arg.is_pointer %}<tr><td>&nbsp;</td><td title="transfer: {{ arg.transfer }}">{{ arg.transfer_note }}</td></tr>{% endif %}
-          {% if arg.string_note %}<tr><td>&nbsp;</td><td>{{ arg.string_note }}</td></tr>{% endif %}
+            </p>
+            <p>{{ arg.description|safe }}</p>
+            <table>
+            {% if arg.direction != "in" %}<tr><td title="direction: {{ arg.direction}}">{{ arg.direction_note }}</td></tr>{% endif %}
+            {% if arg.direction == "in" and arg.nullable %}<tr><td>The argument can be <code>NULL</code>.</td></tr>{% endif %}
+            {% if arg.direction in "inout", "out" and arg.nullable %}<tr><td>The argument can be set to <code>NULL</code> by the class method</td></tr>{% endif %}
+            {% if arg.optional %}<tr><td>The argument can be <code>NULL</code>.</td></tr>{% endif %}
+            {% if arg.is_array and arg.zero_terminated %}<tr><td>The array must be <code>NULL</code>-terminated.</td></tr>{% endif %}
+            {% if arg.is_array and arg.fixed_size > 0 %}<tr><td>The array must have {{ arg.fixed_size }} elements.</td></tr>{% endif %}
+            {% if arg.is_array and arg.len_arg %}<tr><td>The length of the array is specified in the <code>{{ arg.len_arg }}</code> argument.</td></tr>{% endif %}
+            {% if arg.is_pointer %}<tr><td title="transfer: {{ arg.transfer }}">{{ arg.transfer_note }}</td></tr>{% endif %}
+            {% if arg.string_note %}<tr><td>{{ arg.string_note }}</td></tr>{% endif %}
+            </table>
+          </dd>
           {% endfor %}
+
           {% if class_method.throws %}
-          <tr class="arg-name">
-            <td><code>error</code></td>
-            <td><code>GError **</code></td>
-          </tr>
-          <tr class="arg-description">
-            <td>&nbsp;</td>
-            <td>The return location for a <code>GError*</code>, or <code>NULL</code>.</td>
-          </tr>
+          <dt class="arg-name"><code>error</code></dt>
+          <dd class="arg-description">
+            <p><em>Type:</em>&nbsp;<a href="javascript:void(0)" data-namespace="GLib" data-link="struct.Error.html" class="external"><code>GError **</code></a></p>
+            <p>The return location for <a href="https://docs.gtk.org/glib/error-reporting.html#rules-for-use-of-gerror">a recoverable error</a>.</p>
+            <table>
+              <tr><td>The argument can be <code>NULL</code>.</td></tr>
+              <tr><td>If the return location is not <code>NULL</code>, then you must initialize it to a <code>NULL</code> <code>GError*</code>.</td></tr>
+              <tr><td>The argument will left initialized to <code>NULL</code> by the class method if there are no errors.</td></tr>
+              <tr><td>In case of error, the argument will be set to a newly allocated <code>GError</code>; the caller will take ownership of the data, and be responsible for freeing it.</td></tr>
+            </table>
+          </dd>
           {% endif %}
-        </table>
+        </dl>
       </div>
     </div>
     {% endif %}
@@ -153,10 +169,9 @@
       </h4>
 
       <div class="docblock">
-        <table class="returns">
-          <tr class="arg-name">
-            <td>Returns:</td>
-            <td>
+        <div class="returns">
+          <div class="arg-description">
+            <p><em>Type:</em>&nsbp;
             {%- if class_method.return_value.is_array -%}An array of&nbsp;{%- endif -%}
             {%- if class_method.return_value.is_list -%}A list of&nbsp;{%- endif -%}
             {%- if class_method.return_value.is_list_model -%}A list model of&nbsp;{%- endif -%}
@@ -165,19 +180,20 @@
             {%- else -%}
             <code>{{ class_method.return_value.type_cname }}</code>
             {%- endif -%}
-            </td>
-          </tr>
-          <tr class="arg-description">
-            <td>&nbsp;</td>
-            <td>{{ class_method.return_value.description|safe }}</td>
-          </tr>
-          {% if class_method.return_value.is_array and class_method.return_value.zero_terminated %}<tr><td>&nbsp;</td><td>The array is <code>NULL</code>-terminated.</td></tr>{% endif %}
-          {% if class_method.return_value.is_array and class_method.return_value.fixed_size > 0 %}<tr><td>&nbsp;</td><td>The array has {{ class_method.return_value.fixed_size }} elements.</td></tr>{% endif %}
-          {% if class_method.return_value.is_array and class_method.return_value.len_arg %}<tr><td>&nbsp;</td><td>The length of the array is in the <code>{{ class_method.return_value.len_arg }}</code> argument.</td></tr>{% endif %}
-          {% if class_method.return_value.is_pointer %}<tr><td>&nbsp;</td><td title="transfer: {{ class_method.return_value.transfer }}">{{ class_method.return_value.transfer_note }}</td></tr>{% endif %}
-          {% if class_method.return_value.is_pointer and class_method.return_value.nullable %}<tr><td>&nbsp;</td><td>The return value can be <code>NULL</code>.</td></tr>{% endif %}
-          {% if class_method.return_value.string_note %}<tr><td>&nbsp;</td><td>{{ class_method.return_value.string_note }}</td></tr>{% endif %}
-        </table>
+            </p>
+            <p>{{ class_method.return_value.description|safe }}</p>
+          </div>
+          <div>
+            <table>
+            {% if class_method.return_value.is_array and class_method.return_value.zero_terminated %}<tr><td>The array is <code>NULL</code>-terminated.</td></tr>{% endif %}
+            {% if class_method.return_value.is_array and class_method.return_value.fixed_size > 0 %}<tr><td>The array has {{ class_method.return_value.fixed_size }} elements.</td></tr>{% endif %}
+            {% if class_method.return_value.is_array and class_method.return_value.len_arg %}<tr><td>The length of the array is in the <code>{{ class_method.return_value.len_arg }}</code> argument.</td></tr>{% endif %}
+            {% if class_method.return_value.is_pointer %}<tr><td title="transfer: {{ class_method.return_value.transfer }}">{{ class_method.return_value.transfer_note }}</td></tr>{% endif %}
+            {% if class_method.return_value.is_pointer and class_method.return_value.nullable %}<tr><td>The return value can be <code>NULL</code>.</td></tr>{% endif %}

_service:tar_scm:gi-docgen-2022.1.tar.xz/gidocgen/templates/basic/constant.html -> _service:tar_scm:gi-docgen-2023.1.tar.bz2/gidocgen/templates/basic/constant.html Changed

@@ -1,9 +1,3 @@
-
-
 {% extends "base.html" %}
 
 {% block title %}{{ namespace.name }}.{{ constant.name }}{% endblock %}
@@ -32,6 +26,20 @@
   </header>
 
   <section>
+    <div class="docblock">
+      <p>
+      {%- if CONFIG.is_unstable(constant.available_since) -%}
+      <span class="emblem available-next" title="This constant will be available in the next stable release">unstable</span>&nbsp;
+      {%- endif %}
+      {%- if constant.deprecated_since -%}
+      <span class="emblem deprecated">deprecated: {{ constant.deprecated_since.version }}</span>&nbsp;
+      {%- endif -%}
+      {%- if constant.available_since -%}
+      <span class="emblem available">since: {{ constant.available_since }}</span>
+      {%- endif -%}
+      </p>
+    </div>
+
     <div class="declaration toggle-wrapper">
       <h4 id="declaration" style="display:flex;">
         Declaration
@@ -60,18 +68,22 @@
       </div>
 
       <div class="docblock">
-        <table>
-          {% if constant.stability %}
-          <tr><td>Stability:</td><td>{{ constant.stability }}</td></tr>
-          {% endif %}
-          {% if constant.available_since %}
-          <tr><td>Available since:</td><td>{{ constant.available_since }}</td></tr>
-          {% endif %}
-          {% if constant.deprecated_since %}
-          <tr><td>Deprecated since:</td><td>{{ constant.deprecated_since.version }}</td></tr>
-          <tr><td colspan="2">{{ constant.deprecated_since.message }}</td></tr>
-          {% endif %}
-        </table>
+        {% if constant.stability %}
+        <p>Stability: {{ constant.stability }}</p>
+        {% endif %}
+        {% if constant.available_since %}
+        <p>Available since: {{ constant.available_since }}</p>
+        {% endif %}
+        {% if constant.deprecated_since %}
+        {%- if constant.deprecated_since.message -%}
+        <div>
+          <p>Deprecated since: {{ constant.deprecated_since.version }}</p>
+          {{ constant.deprecated_since.message }}
+        </div>
+        {%- else -%}
+        <p>Deprecated since: {{ constant.deprecated_since.version }}. Do not use in newly written code.</p>
+        {%- endif -%}
+        {% endif %}
       </div>
 
       {% if constant.attributes %}

_service:tar_scm:gi-docgen-2022.1.tar.xz/gidocgen/templates/basic/content.html -> _service:tar_scm:gi-docgen-2023.1.tar.bz2/gidocgen/templates/basic/content.html Changed

_service:tar_scm:gi-docgen-2022.1.tar.xz/gidocgen/templates/basic/ctor.html -> _service:tar_scm:gi-docgen-2023.1.tar.bz2/gidocgen/templates/basic/ctor.html Changed

@@ -1,9 +1,3 @@
-
-
 {% extends "base.html" %}
 
 {% block title %}{{ namespace.name }}.{{ class.name }}.{{ type_func.name }}{% endblock %}
@@ -40,6 +34,19 @@
   </header>
 
   <section>
+    <div class="docblock">
+      <p>
+      {%- if CONFIG.is_unstable(type_func.available_since) -%}
+      <span class="emblem available-next" title="This constructor will be available in the next stable release">unstable</span>&nbsp;
+      {%- endif %}
+      {%- if type_func.deprecated_since -%}
+      <span class="emblem deprecated">deprecated: {{ type_func.deprecated_since.version }}</span>&nbsp;
+      {%- endif -%}
+      {%- if type_func.available_since -%}
+      <span class="emblem available">since: {{ type_func.available_since }}</span>
+      {%- endif -%}
+      </p>
+    </div>
     <div class="declaration toggle-wrapper">
       <h4 id="declaration" style="display:flex;">
         Declaration
@@ -68,21 +75,25 @@
       </div>
 
       <div class="docblock">
-        <table>
-          {% if type_func.stability %}
-          <tr><td>Stability:</td><td>{{ type_func.stability }}</td></tr>
-          {% endif %}
-          {% if type_func.available_since %}
-          <tr><td>Available since:</td><td>{{ type_func.available_since }}</td></tr>
-          {% endif %}
-          {% if type_func.deprecated_since %}
-          <tr><td>Deprecated since:</td><td>{{ type_func.deprecated_since.version }}</td></tr>
-          <tr><td colspan="2">{{ type_func.deprecated_since.message }}</td></tr>
-          {% endif %}
-          {% if not type_func.introspectable %}
-          <tr><td>This constructor is not directly available to language bindings</td></tr>
-          {% endif %}
-        </table>
+        {% if type_func.stability -%}
+        <p>Stability: {{ type_func.stability }}</p>
+        {%- endif %}
+        {% if type_func.available_since -%}
+        <p>Available since: {{ type_func.available_since }}</p>
+        {%- endif %}
+        {% if type_func.deprecated_since -%}
+        <div>
+          {%- if type_func.deprecated_since.message -%}
+          <p>Deprecated since: {{ type_func.deprecated_since.version }}</p>
+          {{ type_func.deprecated_since.message }}
+          {%- else -%}
+          <p>Deprecated since: {{ type_func.deprecated_since.version }}. Do not use in newly written code</p>
+          {%- endif -%}
+        </div>
+        {%- endif %}
+        {% if not type_func.introspectable -%}
+        <p>This method is not directly available to language bindings.</p>
+        {%- endif %}
       </div>
 
       {% if type_func.attributes %}
@@ -104,11 +115,11 @@
       </h4>
 
       <div class="docblock">
-        <table class="arguments">
+        <dl class="arguments">
           {% for arg in type_func.arguments %}
-          <tr class="arg-name">
-            <td><code>{{ arg.name }}</code></td>
-            <td>
+          <dt class="arg-name"><code>{{ arg.name }}</code></dt>
+          <dd class="arg-description">
+            <p><em>Type:</em>&nbsp;
             {%- if arg.is_array -%}An array of&nbsp;{%- endif -%}
             {%- if arg.is_list -%}A list of&nbsp;{%- endif -%}
             {%- if arg.link -%}
@@ -116,33 +127,36 @@
             {%- else -%}
             <code>{{ arg.type_cname }}</code>
             {%- endif -%}
-            </td>
-          </tr>
-          <tr class="arg-description">
-            <td>&nbsp;</td>
-            <td>{{ arg.description|safe }}</td>
-          </tr>
-          {% if arg.direction != "in" %}<tr><td>&nbsp;</td><td title="direction: {{ arg.direction}}">{{ arg.direction_note }}</td></tr>{% endif %}
-          {% if arg.direction == "in" and arg.nullable %}<tr><td>&nbsp;</td><td>The argument can be <code>NULL</code>.</td></tr>{% endif %}
-          {% if arg.direction in "inout", "out" and arg.nullable %}<tr><td>&nbsp;</td><td>The argument can be set to <code>NULL</code>.</td></tr>{% endif %}
-          {% if arg.optional %}<tr><td>&nbsp;</td><td>The argument can be <code>NULL</code>.</td></tr>{% endif %}
-          {% if arg.is_array and arg.zero_terminated %}<tr><td>&nbsp;</td><td>The array must be <code>NULL</code>-terminated.</td></tr>{% endif %}
-          {% if arg.is_array and arg.fixed_size > 0 %}<tr><td>&nbsp;</td><td>The array must have {{ arg.fixed_size }} elements.</td></tr>{% endif %}
-          {% if arg.is_array and arg.len_arg %}<tr><td>&nbsp;</td><td>The length of the array is specified in the <code>{{ arg.len_arg }}</code> argument.</td></tr>{% endif %}
-          {% if arg.is_pointer %}<tr><td>&nbsp;</td><td title="transfer: {{ arg.transfer }}">{{ arg.transfer_note }}</td></tr>{% endif %}
-          {% if arg.string_note %}<tr><td>&nbsp;</td><td>{{ arg.string_note }}</td></tr>{% endif %}
+            </p>
+            <p>{{ arg.description|safe }}</p>
+            <table>
+            {% if arg.direction != "in" %}<tr><td title="direction: {{ arg.direction}}">{{ arg.direction_note }}</td></tr>{% endif %}
+            {% if arg.direction == "in" and arg.nullable %}<tr><td>The argument can be <code>NULL</code>.</td></tr>{% endif %}
+            {% if arg.direction in "inout", "out" and arg.nullable %}<tr><td>The argument can be set to <code>NULL</code> by the constructor.</td></tr>{% endif %}
+            {% if arg.optional %}<tr><td>The argument can be <code>NULL</code>.</td></tr>{% endif %}
+            {% if arg.is_array and arg.zero_terminated %}<tr><td>The array must be <code>NULL</code>-terminated.</td></tr>{% endif %}
+            {% if arg.is_array and arg.fixed_size > 0 %}<tr><td>The array must have {{ arg.fixed_size }} elements.</td></tr>{% endif %}
+            {% if arg.is_array and arg.len_arg %}<tr><td>The length of the array is specified in the <code>{{ arg.len_arg }}</code> argument.</td></tr>{% endif %}
+            {% if arg.is_pointer %}<tr><td title="transfer: {{ arg.transfer }}">{{ arg.transfer_note }}</td></tr>{% endif %}
+            {% if arg.string_note %}<tr><td>{{ arg.string_note }}</td></tr>{% endif %}
+            </table>
+          </dd>
           {% endfor %}
+
           {% if type_func.throws %}
-          <tr class="arg-name">
-            <td><code>error</code></td>
-            <td><code>GError **</code></td>
-          </tr>
-          <tr class="arg-description">
-            <td>&nbsp;</td>
-            <td>The return location for a <code>GError*</code>, or <code>NULL</code>.</td>
-          </tr>
+          <dt class="arg-name"><code>error</code></dt>
+          <dd class="arg-description">
+            <p><em>Type:</em>&nbsp;<a href="javascript:void(0)" data-namespace="GLib" data-link="struct.Error.html" class="external"><code>GError **</code></a></p>
+            <p>The return location for <a href="https://docs.gtk.org/glib/error-reporting.html#rules-for-use-of-gerror">a recoverable error</a>.</p>
+            <table>
+              <tr><td>The argument can be <code>NULL</code>.</td></tr>
+              <tr><td>If the return location is not <code>NULL</code>, then you must initialize it to a <code>NULL</code> <code>GError*</code>.</td></tr>
+              <tr><td>The argument will left initialized to <code>NULL</code> by the constructor if there are no errors.</td></tr>
+              <tr><td>In case of error, the argument will be set to a newly allocated <code>GError</code>; the caller will take ownership of the data, and be responsible for freeing it.</td></tr>
+            </table>
+          </dd>
           {% endif %}
-        </table>
+        </dl>
       </div>
     </div>
     {% endif %}
@@ -155,10 +169,9 @@
       </h4>
 
       <div class="docblock">
-        <table class="returns">
-          <tr class="arg-name">
-            <td>Returns:</td>
-            <td>
+        <div class="returns">
+          <div class="arg-description">
+            <p><em>Type:</em>&nbsp;
             {%- if type_func.return_value.is_array -%}An array of&nbsp;{%- endif -%}
             {%- if type_func.return_value.is_list -%}A list of&nbsp;{%- endif -%}
             {%- if type_func.return_value.link -%}
@@ -166,19 +179,20 @@
             {%- else -%}
             <code>{{ type_func.return_value.type_cname }}</code>
             {%- endif -%}
-            </td>
-          </tr>
-          <tr class="arg-description">
-            <td>&nbsp;</td>
-            <td>{{ type_func.return_value.description|safe }}</td>
-          </tr>
-          {% if type_func.return_value.is_array and type_func.return_value.zero_terminated %}<tr><td>&nbsp;</td><td>The array is <code>NULL</code>-terminated.</td></tr>{% endif %}
-          {% if type_func.return_value.is_array and type_func.return_value.fixed_size > 0 %}<tr><td>&nbsp;</td><td>The array has {{ type_func.return_value.fixed_size }} elements.</td></tr>{% endif %}
-          {% if type_func.return_value.is_array and type_func.return_value.len_arg %}<tr><td>&nbsp;</td><td>The length of the array is in the <code>{{ type_func.return_value.len_arg }}</code> argument.</td></tr>{% endif %}
-          {% if type_func.return_value.is_pointer %}<tr><td>&nbsp;</td><td title="transfer: {{ type_func.return_value.transfer }}">{{ type_func.return_value.transfer_note }}</td></tr>{% endif %}
-          {% if type_func.return_value.is_pointer and type_func.return_value.nullable %}<tr><td>&nbsp;</td><td>The return value can be <code>NULL</code>.</td></tr>{% endif %}
-          {% if type_func.return_value.string_note %}<tr><td>&nbsp;</td><td>{{ type_func.return_value.string_note }}</td></tr>{% endif %}
-        </table>
+            </p>
+            <p>{{ type_func.return_value.description|safe }}</p>
+          </div>
+          <div>
+            <table>
+            {% if type_func.return_value.is_array and type_func.return_value.zero_terminated %}<tr><td>The array is <code>NULL</code>-terminated.</td></tr>{% endif %}
+            {% if type_func.return_value.is_array and type_func.return_value.fixed_size > 0 %}<tr><td>The array has {{ type_func.return_value.fixed_size }} elements.</td></tr>{% endif %}
+            {% if type_func.return_value.is_array and type_func.return_value.len_arg %}<tr><td>The length of the array is in the <code>{{ type_func.return_value.len_arg }}</code> argument.</td></tr>{% endif %}
+            {% if type_func.return_value.is_pointer %}<tr><td title="transfer: {{ type_func.return_value.transfer }}">{{ type_func.return_value.transfer_note }}</td></tr>{% endif %}
+            {% if type_func.return_value.is_pointer and type_func.return_value.nullable %}<tr><td>The return value can be <code>NULL</code>.</td></tr>{% endif %}
+            {% if type_func.return_value.string_note %}<tr><td>{{ type_func.return_value.string_note }}</td></tr>{% endif %}
+            </table>
+          </div>
+        </div>
       </div>
     </div>
     {% endif %}

_service:tar_scm:gi-docgen-2022.1.tar.xz/gidocgen/templates/basic/enum.html -> _service:tar_scm:gi-docgen-2023.1.tar.bz2/gidocgen/templates/basic/enum.html Changed

@@ -1,9 +1,3 @@
-
-
 {% extends "base.html" %}
 
 {% block title %}{{ namespace.name }}.{{ enum.name }}{% endblock %}
@@ -67,6 +61,20 @@
   </header>
 
   <section>
+    <div class="docblock">
+      <p>
+      {%- if CONFIG.is_unstable(enum.available_since) -%}
+      <span class="emblem available-next" title="This type will be available in the next stable release">unstable</span>&nbsp;
+      {%- endif %}
+      {%- if enum.deprecated_since -%}
+      <span class="emblem deprecated">deprecated: {{ enum.deprecated_since.version }}</span>&nbsp;
+      {%- endif -%}
+      {%- if enum.available_since -%}
+      <span class="emblem available">since: {{ enum.available_since }}</span>
+      {%- endif -%}
+      </p>
+    </div>
+
     <div class="declaration toggle-wrapper">
       <h4 style="display:flex;" id="declaration">
         Declaration
@@ -95,18 +103,22 @@
       </div>
 
       <div class="docblock">
-        <table class="attributes">
-          {% if enum.stability %}
-          <tr><td>Stability:</td><td>{{ enum.stability }}</td></tr>
-          {% endif %}
-          {% if enum.available_since %}
-          <tr><td>Available since:</td><td>{{ enum.available_since }}</td></tr>
-          {% endif %}
-          {% if enum.deprecated_since %}
-          <tr><td>Deprecated since:</td><td>{{ enum.deprecated_since.version }}</td></tr>
-          <tr><td colspan="2">{{ enum.deprecated_since.message }}</td></tr>
-          {% endif %}
-        </table>
+        {% if enum.stability %}
+        <p>Stability: {{ enum.stability }}</p>
+        {% endif %}
+        {% if enum.available_since %}
+        <p>Available since: {{ enum.available_since }}</p>
+        {% endif %}
+        {% if enum.deprecated_since %}
+        {%- if enum.deprecated_since.message -%}
+        <div>
+          <p>Deprecated since: {{ enum.deprecated_since.version }}</p>
+          {{ enum.deprecated_since.message }}
+        </div>
+        {%- else -%}
+        <p>Deprecated since: {{ enum.deprecated_since.version }}. Do not use in newly written code.</p>
+        {%- endif -%}
+        {% endif %}
       </div>
 
       {% if enum.attributes %}
@@ -166,21 +178,22 @@
       {% for func in enum.type_funcs %}
         <div class="{% if func.deprecated_since %}deprecated{% endif %}">
           <h6><a href="type_func.{{ enum.name }}.{{ func.name }}.html">{{ func.identifier }}</a></h6>
-
           <div class="docblock">
             {{ func.summary }}
           </div>
-
-          {% if func.available_since or func.deprecated_since -%}
           <div class="docblock">
-          {%- if func.available_since -%}
-          <p>Available since: {{ func.available_since }}</p>
-          {%- endif -%}
-          {%- if func.deprecated_since -%}
-          <p>Deprecated since: {{ func.deprecated_since }}</p>
-          {%- endif -%}
+            <p>
+            {%- if CONFIG.is_unstable(func.available_since) -%}
+            <span class="emblem available-next" title="This function will be available in the next stable release">unstable</span>&nbsp;
+            {%- endif %}
+            {%- if func.deprecated_since -%}
+            <span class="emblem deprecated">deprecated: {{ func.deprecated_since }}</span>&nbsp;
+            {%- endif -%}
+            {%- if func.available_since -%}
+            <span class="emblem available">since: {{ func.available_since }}</span>
+            {%- endif -%}
+            </p>
           </div>
-          {%- endif %}
         </div>
       {% endfor %}
     </div>

_service:tar_scm:gi-docgen-2022.1.tar.xz/gidocgen/templates/basic/function.html -> _service:tar_scm:gi-docgen-2023.1.tar.bz2/gidocgen/templates/basic/function.html Changed

@@ -1,9 +1,3 @@
-
-
 {% extends "base.html" %}
 
 {% block title %}{{ namespace.name }}.{{ func.name }}{% endblock %}
@@ -45,6 +39,19 @@
   </header>
 
   <section>
+    <div class="docblock">
+      <p>
+      {%- if CONFIG.is_unstable(func.available_since) -%}
+      <span class="emblem available-next" title="This function will be available in the next stable release">unstable</span>&nbsp;
+      {%- endif %}
+      {%- if func.deprecated_since -%}
+      <span class="emblem deprecated">deprecated: {{ func.deprecated_since.version }}</span>&nbsp;
+      {%- endif -%}
+      {%- if func.available_since -%}
+      <span class="emblem available">since: {{ func.available_since }}</span>
+      {%- endif -%}
+      </p>
+    </div>
     <div class="declaration toggle-wrapper">
       <h4 id="declaration" style="display:flex;">
         Declaration
@@ -73,27 +80,31 @@
       </div>
 
       <div class="docblock">
-        <table>
-          {% if func.stability %}
-          <tr><td>Stability:</td><td>{{ func.stability }}</td></tr>
-          {% endif %}
-          {% if func.available_since %}
-          <tr><td>Available since:</td><td>{{ func.available_since }}</td></tr>
-          {% endif %}
-          {% if func.deprecated_since %}
-          <tr><td>Deprecated since:</td><td>{{ func.deprecated_since.version }}</td></tr>
-          <tr><td colspan="2">{{ func.deprecated_since.message }}</td></tr>
-          {% endif %}
-          {% if not func.introspectable %}
-          <tr><td>This function is not directly available to language bindings</td></tr>
-          {% endif %}
-          {% if func.shadows %}
-          <tr><td>This function is renamed to <a href="func.{{func.shadows}}.html"><code>{{func.shadows_symbol}}()</code></a> in language bindings</td></tr>
-          {% endif %}
-          {% if func.shadowed_by %}
-          <tr><td>The implementation of this function is provided by <a href="func.{{func.shadowed_by}}.html"><code>{{func.shadowed_by_symbol}}()</code></a> in language bindings</td></tr>
-          {% endif %}
-        </table>
+        {% if func.stability -%}
+        <p>Stability: {{ func.stability }}</p>
+        {%- endif %}
+        {% if func.available_since -%}
+        <p>Available since: {{ func.available_since }}</p>
+        {%- endif %}
+        {% if func.deprecated_since -%}
+        <div>
+          {%- if func.deprecated_since.message -%}
+          <p>Deprecated since: {{ func.deprecated_since.version }}</p>
+          {{ func.deprecated_since.message }}
+          {%- else -%}
+          <p>Deprecated since: {{ func.deprecated_since.version }}. Do not use in newly written code</p>
+          {%- endif -%}
+        </div>
+        {%- endif %}
+        {% if not func.introspectable -%}
+        <p>This function is not directly available to language bindings.</p>
+        {%- endif %}
+        {% if func.shadows -%}
+        <p>This method is renamed to <a href="func.{{func.shadows}}.html"><code>{{func.shadows_symbol}}()</code></a> in language bindings</p>
+        {%- endif %}
+        {% if func.shadowed_by -%}
+        <p>The implementation of this method is provided by <a href="func.{{func.shadowed_by}}.html"><code>{{func.shadowed_by_symbol}}()</code></a> in language bindings</p>
+        {%- endif %}
       </div>
 
       {% if func.attributes %}
@@ -115,11 +126,11 @@
       </h4>
 
       <div class="docblock">
-        <table class="arguments">
+        <dl class="arguments">
           {% for arg in func.arguments %}
-          <tr class="arg-name">
-            <td><code>{{ arg.name }}</code></td>
-            <td>
+          <dt class="arg-name"><code>{{ arg.name }}</code></dt>
+          <dd class="arg-description">
+            <p><em>Type:</em>&nbsp;
             {%- if arg.is_array -%}An array of&nbsp;{%- endif -%}
             {%- if arg.is_list -%}A list of&nbsp;{%- endif -%}
             {%- if arg.link -%}
@@ -127,33 +138,36 @@
             {%- else -%}
             <code>{{ arg.type_cname }}</code>
             {%- endif -%}
-            </td>
-          </tr>
-          <tr class="arg-description">
-            <td>&nbsp;</td>
-            <td>{{ arg.description|safe }}</td>
-          </tr>
-          {% if arg.direction != "in" %}<tr><td>&nbsp;</td><td title="direction: {{ arg.direction}}">{{ arg.direction_note }}</td></tr>{% endif %}
-          {% if arg.direction == "in" and arg.nullable %}<tr><td>&nbsp;</td><td>The argument can be <code>NULL</code>.</td></tr>{% endif %}
-          {% if arg.direction in "inout", "out" and arg.nullable %}<tr><td>&nbsp;</td><td>The argument can be set to <code>NULL</code>.</td></tr>{% endif %}
-          {% if arg.optional %}<tr><td>&nbsp;</td><td>The argument can be <code>NULL</code>.</td></tr>{% endif %}
-          {% if arg.is_array and arg.zero_terminated %}<tr><td>&nbsp;</td><td>The array must be <code>NULL</code>-terminated.</td></tr>{% endif %}
-          {% if arg.is_array and arg.fixed_size > 0 %}<tr><td>&nbsp;</td><td>The array must have {{ arg.fixed_size }} elements.</td></tr>{% endif %}
-          {% if arg.is_array and arg.len_arg %}<tr><td>&nbsp;</td><td>The length of the array is specified in the <code>{{ arg.len_arg }}</code> argument.</td></tr>{% endif %}
-          {% if arg.is_pointer %}<tr><td>&nbsp;</td><td title="transfer: {{ arg.transfer }}">{{ arg.transfer_note }}</td></tr>{% endif %}
-          {% if arg.string_note %}<tr><td>&nbsp;</td><td>{{ arg.string_note }}</td></tr>{% endif %}
+            </p>
+            <p>{{ arg.description|safe }}</p>
+            <table>
+            {% if arg.direction != "in" %}<tr><td title="direction: {{ arg.direction}}">{{ arg.direction_note }}</td></tr>{% endif %}
+            {% if arg.direction == "in" and arg.nullable %}<tr><td>The argument can be <code>NULL</code>.</td></tr>{% endif %}
+            {% if arg.direction in "inout", "out" and arg.nullable %}<tr><td>The argument can be set to <code>NULL</code> by the function.</td></tr>{% endif %}
+            {% if arg.optional %}<tr><td>The argument can be <code>NULL</code>.</td></tr>{% endif %}
+            {% if arg.is_array and arg.zero_terminated %}<tr><td>The array must be <code>NULL</code>-terminated.</td></tr>{% endif %}
+            {% if arg.is_array and arg.fixed_size > 0 %}<tr><td>The array must have {{ arg.fixed_size }} elements.</td></tr>{% endif %}
+            {% if arg.is_array and arg.len_arg %}<tr><td>The length of the array is specified in the <code>{{ arg.len_arg }}</code> argument.</td></tr>{% endif %}
+            {% if arg.is_pointer %}<tr><td title="transfer: {{ arg.transfer }}">{{ arg.transfer_note }}</td></tr>{% endif %}
+            {% if arg.string_note %}<tr><td>{{ arg.string_note }}</td></tr>{% endif %}
+            </table>
+          </dd>
           {% endfor %}
+
           {% if func.throws %}
-          <tr class="arg-name">
-            <td><code>error</code></td>
-            <td><code>GError **</code></td>
-          </tr>
-          <tr class="arg-description">
-            <td>&nbsp;</td>
-            <td>The return location for a <code>GError*</code>, or <code>NULL</code>.</td>
-          </tr>
+          <dt class="arg-name"><code>error</code></dt>
+          <dd class="arg-description">
+            <p><em>Type:</em>&nbsp;<a href="javascript:void(0)" data-namespace="GLib" data-link="struct.Error.html" class="external"><code>GError **</code></a></p>
+            <p>The return location for <a href="https://docs.gtk.org/glib/error-reporting.html#rules-for-use-of-gerror">a recoverable error</a>.</p>
+            <table>
+              <tr><td>The argument can be <code>NULL</code>.</td></tr>
+              <tr><td>If the return location is not <code>NULL</code>, then you must initialize it to a <code>NULL</code> <code>GError*</code>.</td></tr>
+              <tr><td>The argument will left initialized to <code>NULL</code> by the function if there are no errors.</td></tr>
+              <tr><td>In case of error, the argument will be set to a newly allocated <code>GError</code>; the caller will take ownership of the data, and be responsible for freeing it.</td></tr>
+            </table>
+          </dd>
           {% endif %}
-        </table>
+        </dl>
       </div>
     </div>
     {% endif %}
@@ -166,10 +180,9 @@
       </h4>
 
       <div class="docblock">
-        <table class="returns">
-          <tr class="arg-name">
-            <td>Returns:</td>
-            <td>
+        <div class="returns">
+          <div class="arg-description">
+            <p><em>Type:</em>&nbsp;
             {%- if func.return_value.is_array -%}An array of&nbsp;{%- endif -%}
             {%- if func.return_value.is_list -%}A list of&nbsp;{%- endif -%}
             {%- if func.return_value.is_list_model -%}A list model of&nbsp;{%- endif -%}
@@ -178,19 +191,20 @@
             {%- else -%}
             <code>{{ func.return_value.type_cname }}</code>
             {%- endif -%}
-            </td>
-          </tr>
-          <tr class="arg-description">
-            <td>&nbsp;</td>
-            <td>{{ func.return_value.description|safe }}</td>
-          </tr>
-          {% if func.return_value.is_array and func.return_value.zero_terminated %}<tr><td>&nbsp;</td><td>The array is <code>NULL</code>-terminated.</td></tr>{% endif %}
-          {% if func.return_value.is_array and func.return_value.fixed_size > 0 %}<tr><td>&nbsp;</td><td>The array has {{ func.return_value.fixed_size }} elements.</td></tr>{% endif %}
-          {% if func.return_value.is_array and func.return_value.len_arg %}<tr><td>&nbsp;</td><td>The length of the array is in the <code>{{ func.return_value.len_arg }}</code> argument.</td></tr>{% endif %}
-          {% if func.return_value.is_pointer %}<tr><td>&nbsp;</td><td title="transfer: {{ func.return_value.transfer }}">{{ func.return_value.transfer_note }}</td></tr>{% endif %}
-          {% if func.return_value.is_pointer and func.return_value.nullable %}<tr><td>&nbsp;</td><td>The return value can be <code>NULL</code>.</td></tr>{% endif %}
-          {% if func.return_value.string_note %}<tr><td>&nbsp;</td><td>{{ func.return_value.string_note }}</td></tr>{% endif %}
-        </table>
+            </p>
+            <p>{{ func.return_value.description|safe }}</td>
+          </div>
+          <div>
+            <table>
+            {% if func.return_value.is_array and func.return_value.zero_terminated %}<tr><td>The array is <code>NULL</code>-terminated.</td></tr>{% endif %}
+            {% if func.return_value.is_array and func.return_value.fixed_size > 0 %}<tr><td>The array has {{ func.return_value.fixed_size }} elements.</td></tr>{% endif %}
+            {% if func.return_value.is_array and func.return_value.len_arg %}<tr><td>The length of the array is in the <code>{{ func.return_value.len_arg }}</code> argument.</td></tr>{% endif %}
+            {% if func.return_value.is_pointer %}<tr><td title="transfer: {{ func.return_value.transfer }}">{{ func.return_value.transfer_note }}</td></tr>{% endif %}

_service:tar_scm:gi-docgen-2022.1.tar.xz/gidocgen/templates/basic/interface.html -> _service:tar_scm:gi-docgen-2023.1.tar.bz2/gidocgen/templates/basic/interface.html Changed

@@ -1,9 +1,3 @@
-
-
 {% extends "base.html" %}
 
 {% block title %}{{ namespace.name }}.{{ interface.name }}{% endblock %}
@@ -89,6 +83,19 @@
 
   <section>
     <summary>
+      <div class="docblock">
+        <p>
+        {%- if CONFIG.is_unstable(interface.available_since) -%}
+        <span class="emblem available-next" title="This type will be available in the next stable release">unstable</span>&nbsp;
+        {%- endif %}
+        {%- if interface.deprecated_since -%}
+        <span class="emblem deprecated">deprecated: {{ interface.deprecated_since.version }}</span>&nbsp;
+        {%- endif -%}
+        {%- if interface.available_since -%}
+        <span class="emblem available">since: {{ interface.available_since }}</span>
+        {%- endif -%}
+        </p>
+      </div>
       <div class="toggle-wrapper">
         <h4 id="description" style="display:flex;">
           Description
@@ -105,18 +112,22 @@
         </div>
 
         <div class="docblock">
-          <table class="attributes">
-            {% if interface.stability %}
-            <tr><td>Stability:</td><td>{{ interface.stability }}</td></tr>
-            {% endif %}
-            {% if interface.available_since %}
-            <tr><td>Available since:</td><td>{{ interface.available_since }}</td></tr>
-            {% endif %}
-            {% if interface.deprecated_since %}
-            <tr><td>Deprecated since:</td><td>{{ interface.deprecated_since.version }}</td></tr>
-            <tr><td colspan="2">{{ interface.deprecated_since.message }}</td></tr>
-            {% endif %}
-          </table>
+          {% if interface.stability %}
+          <p>Stability: {{ interface.stability }}</p>
+          {% endif %}
+          {% if interface.available_since %}
+          <p>Available since: {{ interface.available_since }}</p>
+          {% endif %}
+          {% if interface.deprecated_since %}
+          {%- if interface.deprecated_since.message -%}
+          <div>
+            <p>Deprecated since: {{ interface.deprecated_since.version }}</p>
+            {{ interface.deprecated_since.message }}
+          </div>
+          {%- else -%}
+          <p>Deprecated since: {{ interface.deprecated_since.version }}. Do not use in newly written code.</p>
+          {%- endif -%}
+          {% endif %}
         </div>
 
         {% if interface.attributes %}
@@ -139,10 +150,10 @@
 
       <div class="docblock">
         <p>In order to implement {{ interface.name }}, your type must inherit from
-        {% if interface.requires_namespace == namespace.name -%}
-        <a href="class.{{ interface.requires_name }}.html">
+        {%- if interface.requires_namespace == namespace.name -%}
+        <a href="{{ interface.requires_link_fragment }}.{{ interface.requires_name }}.html">
         {%- else -%}
-        <a data-namespace="{{ interface.requires_namespace }}" data-link="class.{{ interface.requires_name }}.html" href="javascript:void(0)" class="external">
+        <a data-namespace="{{ interface.requires_namespace }}" data-link="{{ interface.requires_link_fragment }}.{{ interface.requires_name }}.html" href="javascript:void(0)" class="external">
         {%- endif -%}
         <code>{{ interface.requires_ctype }}</code></a>.</p>
       </div>
@@ -172,14 +183,22 @@
       {% for func in interface.type_funcs %}
       <div class="{% if func.deprecated_since %}deprecated{% endif %}">
         <h6><a href="type_func.{{ interface.name }}.{{ func.name }}.html">{{ func.identifier }}</a></h6>
-
         <div class="docblock">
           {{ func.summary }}
         </div>
-
-        {% if func.deprecated_since %}
-        <div class="docblock"><p>Deprecated since: {{ func.deprecated_since.version }}</p></div>
-        {% endif %}
+        <div class="docblock">
+          <p>
+          {%- if CONFIG.is_unstable(func.available_since) -%}
+          <span class="emblem available-next" title="This function will be available in the next stable release">unstable</span>&nbsp;
+          {%- endif %}
+          {%- if func.deprecated_since -%}
+          <span class="emblem deprecated">deprecated: {{ func.deprecated_since }}</span>&nbsp;
+          {%- endif -%}
+          {%- if func.available_since -%}
+          <span class="emblem available">since: {{ func.available_since }}</span>
+          {%- endif -%}
+          </p>
+        </div>
       </div>
       {% endfor %}
       </div>
@@ -195,24 +214,25 @@
 
       <div class="docblock">
       {% for method in interface.methods %}
-      <div class="{% if method.deprecated_since %}deprecated{% endif %}">
-        <h6><a href="method.{{ interface.name}}.{{ method.name }}.html">{{ method.identifier }}</a></h6>
-
-        <div class="docblock">
-          {{ method.summary }}
+        <div class="{% if method.deprecated_since %}deprecated{% endif %}">
+          <h6><a href="method.{{ interface.name}}.{{ method.name }}.html">{{ method.identifier }}</a></h6>
+          <div class="docblock">
+            {{ method.summary }}
+          </div>
+          <div class="docblock">
+            <p>
+            {%- if CONFIG.is_unstable(method.available_since) -%}
+            <span class="emblem available-next" title="This method will be available in the next stable release">unstable</span>&nbsp;
+            {%- endif %}
+            {%- if method.deprecated_since -%}
+            <span class="emblem deprecated">deprecated: {{ method.deprecated_since }}</span>&nbsp;
+            {%- endif -%}
+            {%- if method.available_since -%}
+            <span class="emblem available">since: {{ method.available_since }}</span>
+            {%- endif -%}
+            </p>
+          </div>
         </div>
-
-        {% if method.available_since or method.deprecated_since -%}
-        <div class="docblock">
-        {%- if method.available_since -%}
-        <p>Available since: {{ method.available_since }}</p>
-        {%- endif -%}
-        {%- if method.deprecated_since -%}
-        <p>Deprecated since: {{ method.deprecated_since }}</p>
-        {%- endif -%}
-        </div>
-        {%- endif %}
-      </div>
       {% endfor %}
       </div>
 
@@ -228,24 +248,25 @@
 
       <div class="docblock">
       {% for property in interface.properties %}
-      <div class="{% if property.deprecated_since %}deprecated{% endif %}">
-        <h6><a href="property.{{ interface.name }}.{{ property.name }}.html">{{ interface.fqtn }}:{{ property.name }}</a></h6>
-
-        <div class="docblock">
-          {{ property.summary }}
+        <div class="{% if property.deprecated_since %}deprecated{% endif %}">
+          <h6><a href="property.{{ interface.name }}.{{ property.name }}.html">{{ interface.fqtn }}:{{ property.name }}</a></h6>
+          <div class="docblock">
+            {{ property.summary }}
+          </div>
+          <div class="docblock">
+            <p>
+            {%- if CONFIG.is_unstable(property.available_since) -%}
+            <span class="emblem available-next" title="This property will be available in the next stable release">unstable</span>&nbsp;
+            {%- endif %}
+            {%- if property.deprecated_since -%}
+            <span class="emblem deprecated">deprecated: {{ property.deprecated_since }}</span>&nbsp;
+            {%- endif -%}
+            {%- if property.available_since -%}
+            <span class="emblem available">since: {{ property.available_since }}</span>
+            {%- endif -%}
+            </p>
+          </div>
         </div>
-
-        {% if property.available_since or property.deprecated_since -%}
-        <div class="docblock">
-        {%- if property.available_since -%}
-        <p>Available since: {{ property.available_since }}</p>
-        {%- endif -%}
-        {%- if property.deprecated_since -%}
-        <p>Deprecated since: {{ property.deprecated_since }}</p>
-        {%- endif -%}
-        </div>
-        {%- endif %}
-      </div>
       {% endfor %}
       </div>
 
@@ -261,24 +282,25 @@
 
       <div class="docblock">
       {% for signal in interface.signals %}
-      <div class="{% if signal.deprecated_since %}deprecated{% endif %}">
-        <h6><a href="signal.{{ interface.name }}.{{ signal.name }}.html">{{ interface.fqtn }}::{{ signal.name }}</a></h6>
-

_service:tar_scm:gi-docgen-2022.1.tar.xz/gidocgen/templates/basic/method.html -> _service:tar_scm:gi-docgen-2023.1.tar.bz2/gidocgen/templates/basic/method.html Changed

@@ -1,9 +1,3 @@
-
-
 {% extends "base.html" %}
 
 {% block title %}{{ namespace.name }}.{{ class.name }}.{{ method.name }}{% endblock %}
@@ -40,6 +34,20 @@
   </header>
 
   <section>
+    <div class="docblock">
+      <p>
+      {%- if CONFIG.is_unstable(method.available_since) -%}
+      <span class="emblem available-next" title="This method will be available in the next stable release">unstable</span>&nbsp;
+      {%- endif %}
+      {%- if method.deprecated_since -%}
+      <span class="emblem deprecated">deprecated: {{ method.deprecated_since.version }}</span>&nbsp;
+      {%- endif -%}
+      {%- if method.available_since -%}
+      <span class="emblem available">since: {{ method.available_since }}</span>
+      {%- endif -%}
+      </p>
+    </div>
+
     <div class="declaration toggle-wrapper">
       <h4 style="display:flex;" id="declaration">
         Declaration
@@ -68,27 +76,31 @@
       </div>
 
       <div class="docblock">
-        <table>
-          {% if method.stability %}
-          <tr><td>Stability:</td><td>{{ method.stability }}</td></tr>
-          {% endif %}
-          {% if method.available_since %}
-          <tr><td>Available since:</td><td>{{ method.available_since }}</td></tr>
-          {% endif %}
-          {% if method.deprecated_since %}
-          <tr><td>Deprecated since:</td><td>{{ method.deprecated_since.version }}</td></tr>
-          <tr><td colspan="2">{{ method.deprecated_since.message|safe }}</td></tr>
-          {% endif %}
-          {% if not method.introspectable %}
-          <tr><td>This method is not directly available to language bindings.</td></tr>
-          {% endif %}
-          {% if method.shadows %}
-          <tr><td>This method is renamed to <a href="method.{{class.name}}.{{method.shadows}}.html"><code>{{method.shadows_symbol}}()</code></a> in language bindings</td></tr>
-          {% endif %}
-          {% if method.shadowed_by %}
-          <tr><td>The implementation of this method is provided by <a href="method.{{class.name}}.{{method.shadowed_by}}.html"><code>{{method.shadowed_by_symbol}}()</code></a> in language bindings</td></tr>
-          {% endif %}
-        </table>
+        {% if method.stability -%}
+        <p>Stability: {{ method.stability }}</p>
+        {%- endif %}
+        {% if method.available_since -%}
+        <p>Available since: {{ method.available_since }}</p>
+        {%- endif %}
+        {% if method.deprecated_since -%}
+        <div>
+          {%- if method.deprecated_since.message -%}
+          <p>Deprecated since: {{ method.deprecated_since.version }}</p>
+          {{ method.deprecated_since.message }}
+          {%- else -%}
+          <p>Deprecated since: {{ method.deprecated_since.version }}. Do not use in newly written code</p>
+          {%- endif -%}
+        </div>
+        {%- endif %}
+        {% if not method.introspectable -%}
+        <p>This method is not directly available to language bindings.</p>
+        {%- endif %}
+        {% if method.shadows -%}
+        <p>This method is renamed to <a href="method.{{class.name}}.{{method.shadows}}.html"><code>{{method.shadows_symbol}}()</code></a> in language bindings</p>
+        {%- endif %}
+        {% if method.shadowed_by -%}
+        <p>The implementation of this method is provided by <a href="method.{{class.name}}.{{method.shadowed_by}}.html"><code>{{method.shadowed_by_symbol}}()</code></a> in language bindings</p>
+        {%- endif %}
       </div>
 
       {% if method.attributes %}
@@ -110,11 +122,11 @@
       </h4>
 
       <div class="docblock">
-        <table class="arguments">
+        <dl class="arguments">
           {% for arg in method.arguments %}
-          <tr class="arg-name">
-            <td><code>{{ arg.name }}</code></td>
-            <td>
+          <dt class="arg-name"><code>{{ arg.name }}</code></dt>
+          <dd class="arg-description">
+            <p><em>Type:</em>&nbsp;
             {%- if arg.is_array -%}An array of&nbsp;{%- endif -%}
             {%- if arg.is_list -%}A list of&nbsp;{%- endif -%}
             {%- if arg.link -%}
@@ -122,33 +134,36 @@
             {%- else -%}
             <code>{{ arg.type_cname }}</code>
             {%- endif -%}
-            </td>
-          </tr>
-          <tr class="arg-description">
-            <td>&nbsp;</td>
-            <td>{{ arg.description|safe }}</td>
-          </tr>
-          {% if arg.direction != "in" %}<tr><td>&nbsp;</td><td title="direction: {{ arg.direction}}">{{ arg.direction_note }}</td></tr>{% endif %}
-          {% if arg.direction == "in" and arg.nullable %}<tr><td>&nbsp;</td><td>The argument can be <code>NULL</code>.</td></tr>{% endif %}
-          {% if arg.direction in "inout", "out" and arg.nullable %}<tr><td>&nbsp;</td><td>The argument can be set to <code>NULL</code>.</td></tr>{% endif %}
-          {% if arg.optional %}<tr><td>&nbsp;</td><td>The argument can be <code>NULL</code>.</td></tr>{% endif %}
-          {% if arg.is_array and arg.zero_terminated %}<tr><td>&nbsp;</td><td>The array must be <code>NULL</code>-terminated.</td></tr>{% endif %}
-          {% if arg.is_array and arg.fixed_size > 0 %}<tr><td>&nbsp;</td><td>The array must have {{ arg.fixed_size }} elements.</td></tr>{% endif %}
-          {% if arg.is_array and arg.len_arg %}<tr><td>&nbsp;</td><td>The length of the array is specified in the <code>{{ arg.len_arg }}</code> argument.</td></tr>{% endif %}
-          {% if arg.is_pointer %}<tr><td>&nbsp;</td><td title="transfer: {{ arg.transfer }}">{{ arg.transfer_note }}</td></tr>{% endif %}
-          {% if arg.string_note %}<tr><td>&nbsp;</td><td>{{ arg.string_note }}</td></tr>{% endif %}
+            </p>
+            <p>{{ arg.description|safe }}</p>
+            <table>
+            {% if arg.direction != "in" %}<tr><td title="direction: {{ arg.direction}}">{{ arg.direction_note }}</td></tr>{% endif %}
+            {% if arg.direction == "in" and arg.nullable %}<tr><td>The argument can be <code>NULL</code>.</td></tr>{% endif %}
+            {% if arg.direction in "inout", "out" and arg.nullable %}<tr><td>The argument can be set to <code>NULL</code> by the method.</td></tr>{% endif %}
+            {% if arg.optional %}<tr><td>The argument can be <code>NULL</code>.</td></tr>{% endif %}
+            {% if arg.is_array and arg.zero_terminated %}<tr><td>The array must be <code>NULL</code>-terminated.</td></tr>{% endif %}
+            {% if arg.is_array and arg.fixed_size > 0 %}<tr><td>The array must have {{ arg.fixed_size }} elements.</td></tr>{% endif %}
+            {% if arg.is_array and arg.len_arg %}<tr><td>The length of the array is specified in the <code>{{ arg.len_arg }}</code> argument.</td></tr>{% endif %}
+            {% if arg.is_pointer %}<tr><td title="transfer: {{ arg.transfer }}">{{ arg.transfer_note }}</td></tr>{% endif %}
+            {% if arg.string_note %}<tr><td>{{ arg.string_note }}</td></tr>{% endif %}
+            </table>
+          </dd>
           {% endfor %}
+
           {% if method.throws %}
-          <tr class="arg-name">
-            <td><code>error</code></td>
-            <td><code>GError **</code></td>
-          </tr>
-          <tr class="arg-description">
-            <td>&nbsp;</td>
-            <td>The return location for a <code>GError*</code>, or <code>NULL</code>.</td>
-          </tr>
+          <dt class="arg-name"><code>error</code></dt>
+          <dd class="arg-description">
+            <p><em>Type:</em>&nbsp;<a href="javascript:void(0)" data-namespace="GLib" data-link="struct.Error.html" class="external"><code>GError **</code></a></p>
+            <p>The return location for <a href="https://docs.gtk.org/glib/error-reporting.html#rules-for-use-of-gerror">a recoverable error</a>.</p>
+            <table>
+              <tr><td>The argument can be <code>NULL</code>.</td></tr>
+              <tr><td>If the return location is not <code>NULL</code>, then you must initialize it to a <code>NULL</code> <code>GError*</code>.</td></tr>
+              <tr><td>The argument will left initialized to <code>NULL</code> by the method if there are no errors.</td></tr>
+              <tr><td>In case of error, the argument will be set to a newly allocated <code>GError</code>; the caller will take ownership of the data, and be responsible for freeing it.</td></tr>
+            </table>
+          </dd>
           {% endif %}
-        </table>
+        </dl>
       </div>
     </div>
     {% endif %}
@@ -161,10 +176,9 @@
       </h4>
 
       <div class="docblock">
-        <table class="returns">
-          <tr class="arg-name">
-            <td>Returns:</td>
-            <td>
+        <div class="returns">
+          <div class="arg-description">
+            <p><em>Type:</em>&nbsp;
             {%- if method.return_value.is_array -%}An array of&nbsp;{%- endif -%}
             {%- if method.return_value.is_list -%}A list of&nbsp;{%- endif -%}
             {%- if method.return_value.is_list_model -%}A list model of&nbsp;{%- endif -%}
@@ -173,19 +187,20 @@
             {%- else -%}
             <code>{{ method.return_value.type_cname }}</code>
             {%- endif -%}
-            </td>
-          </tr>
-          <tr class="arg-description">
-            <td>&nbsp;</td>
-            <td>{{ method.return_value.description|safe }}</td>
-          </tr>
-          {% if method.return_value.is_array and method.return_value.zero_terminated %}<tr><td>&nbsp;</td><td>The array is <code>NULL</code>-terminated.</td></tr>{% endif %}
-          {% if method.return_value.is_array and method.return_value.fixed_size > 0 %}<tr><td>&nbsp;</td><td>The array has {{ method.return_value.fixed_size }} elements.</td></tr>{% endif %}
-          {% if method.return_value.is_array and method.return_value.len_arg %}<tr><td>&nbsp;</td><td>The length of the array is in the <code>{{ method.return_value.len_arg }}</code> argument.</td></tr>{% endif %}
-          {% if method.return_value.is_pointer %}<tr><td>&nbsp;</td><td title="transfer: {{ method.return_value.transfer }}">{{ method.return_value.transfer_note }}</td></tr>{% endif %}
-          {% if method.return_value.is_pointer and method.return_value.nullable %}<tr><td>&nbsp;</td><td>The return value can be <code>NULL</code>.</td></tr>{% endif %}
-          {% if method.return_value.string_note %}<tr><td>&nbsp;</td><td>{{ method.return_value.string_note }}</td></tr>{% endif %}
-        </table>
+            </p>
+            <p>{{ method.return_value.description|safe }}</p>
+          </div>
+          <div>
+            <table>
+            {% if method.return_value.is_array and method.return_value.zero_terminated %}<tr><td>The array is <code>NULL</code>-terminated.</td></tr>{% endif %}
+            {% if method.return_value.is_array and method.return_value.fixed_size > 0 %}<tr><td>The array has {{ method.return_value.fixed_size }} elements.</td></tr>{% endif %}
+            {% if method.return_value.is_array and method.return_value.len_arg %}<tr><td>The length of the array is in the <code>{{ method.return_value.len_arg }}</code> argument.</td></tr>{% endif %}

_service:tar_scm:gi-docgen-2022.1.tar.xz/gidocgen/templates/basic/namespace.html -> _service:tar_scm:gi-docgen-2023.1.tar.bz2/gidocgen/templates/basic/namespace.html Changed

@@ -1,9 +1,3 @@
-
-
 {% extends "base.html" %}
 
 {% block title %}{{ namespace.name }} &ndash; {{ namespace.version }}{% endblock %}
@@ -172,7 +166,20 @@
           <tr class="section-item">
             <td><a title="{{ element.name }}" class="symbol" href="{{ section_fragment }}.{{ element.name }}.html">{{ element.name }}</a></td>
             {% if CONFIG.show_index_summary %}
-            <td class="docblock-summary">{{ element.summary }}</td>
+            <td class="docblock-summary">
+            {{ element.summary }}
+            <p>
+            {%- if CONFIG.is_unstable(element.available_since) -%}
+            <span class="emblem available-next" title="This symbol will be available in the next stable release">unstable</span>&nbsp;
+            {%- endif %}
+            {%- if element.deprecated_since -%}
+            <span class="emblem deprecated">deprecated: {{ element.deprecated_since.version }}</span>&nbsp;
+            {%- endif -%}
+            {%- if element.available_since -%}
+            <span class="emblem available">since: {{ element.available_since }}</span>
+            {%- endif -%}
+            </p>
+            </td>
             {% endif %}
           </tr>
           {% endfor %}

_service:tar_scm:gi-docgen-2022.1.tar.xz/gidocgen/templates/basic/property.html -> _service:tar_scm:gi-docgen-2023.1.tar.bz2/gidocgen/templates/basic/property.html Changed

_service:tar_scm:gi-docgen-2022.1.tar.xz/gidocgen/templates/basic/signal.html -> _service:tar_scm:gi-docgen-2023.1.tar.bz2/gidocgen/templates/basic/signal.html Changed

@@ -1,9 +1,3 @@
-
-
 {% extends "base.html" %}
 
 {% block title %}{{ namespace.name }}.{{ class.name }}::{{ signal.name }}{% endblock %}
@@ -40,6 +34,19 @@
   </header>
 
   <section>
+    <div class="docblock">
+      <p>
+      {%- if CONFIG.is_unstable(signal.available_since) -%}
+      <span class="emblem available-next" title="This signal will be available in the next stable release">unstable</span>&nbsp;
+      {%- endif %}
+      {%- if signal.deprecated_since -%}
+      <span class="emblem deprecated">deprecated: {{ signal.deprecated_since.version }}</span>&nbsp;
+      {%- endif -%}
+      {%- if signal.available_since -%}
+      <span class="emblem available">since: {{ signal.available_since }}</span>
+      {%- endif -%}
+      </p>
+    </div>
     <div class="declaration toggle-wrapper">
       <h4 id="declaration">
         Declaration
@@ -66,28 +73,28 @@
 
       <div class="docblock">
         <table>
-          <tr><td>Default handler:</td><td> {{ signal.when }}</td></tr>
+          <tr><td>Default handler: {{ signal.when }}</td></tr>
           {% if signal.no_recurse %}
-          <tr><td colspan="2">Signal emission will restart instead of recursing</td></tr>
+          <tr><td>Signal emission will restart instead of recursing</td></tr>
           {% endif %}
           {% if signal.is_action %}
-          <tr><td colspan="2">The signal can be emitted directly</td></tr>
+          <tr><td>The signal can be emitted directly</td></tr>
           {% endif %}
           {% if signal.is_detailed %}
-          <tr><td colspan="2">The signal can be detailed</td></tr>
+          <tr><td>The signal can be detailed</td></tr>
           {% endif %}
           {% if signal.no_hooks %}
-          <tr><td colspan="2">Hooks are disabled for this signal</td></tr>
+          <tr><td>Hooks are disabled for this signal</td></tr>
           {% endif %}
           {% if signal.stability %}
-          <tr><td>Stability:</td><td>{{ signal.stability }}</td></tr>
+          <tr><td>Stability: {{ signal.stability }}</td></tr>
           {% endif %}
           {% if signal.available_since %}
-          <tr><td>Available since:</td><td>{{ signal.available_since }}</td></tr>
+          <tr><td>Available since: {{ signal.available_since }}</td></tr>
           {% endif %}
           {% if signal.deprecated_since %}
-          <tr><td>Deprecated since:</td><td>{{ signal.deprecated_since.version }}</td></tr>
-          <tr><td colspan="2">{{ signal.deprecated_since.message }}</td></tr>
+          <tr><td>Deprecated since: {{ signal.deprecated_since.version }}</td></tr>
+          <tr><td>{{ signal.deprecated_since.message }}</td></tr>
           {% endif %}
         </table>
       </div>
@@ -111,11 +118,11 @@
       </h4>
 
       <div class="docblock">
-        <table class="arguments">
+        <dl class="arguments">
           {% for arg in signal.arguments %}
-          <tr class="arg-name">
-            <td><code>{{ arg.name }}</code></td>
-            <td>
+          <dt class="arg-name"><code>{{ arg.name }}</code></dt>
+          <dd class="arg-description">
+            <p><em>Type:</em>&nbsp;
             {%- if arg.is_array -%}An array of&nbsp;{%- endif -%}
             {%- if arg.is_list -%}A list of&nbsp;{%- endif -%}
             {%- if arg.link -%}
@@ -123,33 +130,36 @@
             {%- else -%}
             <code>{{ arg.type_cname }}</code>
             {%- endif -%}
-            </td>
-          </tr>
-          <tr class="arg-description">
-            <td>&nbsp;</td>
-            <td>{{ arg.description|safe }}</td>
-          </tr>
-          {% if arg.direction != "in" %}<tr><td>&nbsp;</td><td title="direction: {{ arg.direction}}">{{ arg.direction_note }}</td></tr>{% endif %}
-          {% if arg.direction == "in" and arg.nullable %}<tr><td>&nbsp;</td><td>The argument can be <code>NULL</code>.</td></tr>{% endif %}
-          {% if arg.direction in "inout", "out" and arg.nullable %}<tr><td>&nbsp;</td><td>The argument can be set to <code>NULL</code>.</td></tr>{% endif %}
-          {% if arg.optional %}<tr><td>&nbsp;</td><td>The argument can be <code>NULL</code>.</td></tr>{% endif %}
-          {% if arg.is_array and arg.zero_terminated %}<tr><td>&nbsp;</td><td>The array must be <code>NULL</code>-terminated.</td></tr>{% endif %}
-          {% if arg.is_array and arg.fixed_size > 0 %}<tr><td>&nbsp;</td><td>The array must have {{ arg.fixed_size }} elements.</td></tr>{% endif %}
-          {% if arg.is_array and arg.len_arg %}<tr><td>&nbsp;</td><td>The length of the array is specified in the <code>{{ arg.len_arg }}</code> argument.</td></tr>{% endif %}
-          {% if arg.is_pointer %}<tr><td>&nbsp;</td><td title="transfer: {{ arg.transfer }}">{{ arg.transfer_note }}</td></tr>{% endif %}
-          {% if arg.string_note %}<tr><td>&nbsp;</td><td>{{ arg.string_note }}</td></tr>{% endif %}
+            </p>
+            <p>{{ arg.description|safe }}</p>
+            <table>
+            {% if arg.direction != "in" %}<tr><td title="direction: {{ arg.direction}}">{{ arg.direction_note }}</td></tr>{% endif %}
+            {% if arg.direction == "in" and arg.nullable %}<tr><td>The argument can be <code>NULL</code>.</td></tr>{% endif %}
+            {% if arg.direction in "inout", "out" and arg.nullable %}<tr><td>The argument can be set to <code>NULL</code> by the signal handler.</td></tr>{% endif %}
+            {% if arg.optional %}<tr><td>The argument can be <code>NULL</code>.</td></tr>{% endif %}
+            {% if arg.is_array and arg.zero_terminated %}<tr><td>The array must be <code>NULL</code>-terminated.</td></tr>{% endif %}
+            {% if arg.is_array and arg.fixed_size > 0 %}<tr><td>The array must have {{ arg.fixed_size }} elements.</td></tr>{% endif %}
+            {% if arg.is_array and arg.len_arg %}<tr><td>The length of the array is specified in the <code>{{ arg.len_arg }}</code> argument.</td></tr>{% endif %}
+            {% if arg.is_pointer %}<tr><td title="transfer: {{ arg.transfer }}">{{ arg.transfer_note }}</td></tr>{% endif %}
+            {% if arg.string_note %}<tr><td>{{ arg.string_note }}</td></tr>{% endif %}
+            </table>
+          </dd>
           {% endfor %}
+
           {% if signal.throws %}
-          <tr class="arg-name">
-            <td><code>error</code></td>
-            <td><code>GError **</code></td>
-          </tr>
-          <tr class="arg-description">
-            <td>&nbsp;</td>
-            <td>The return location for a <code>GError*</code>, or <code>NULL</code>.</td>
-          </tr>
+          <dt class="arg-name"><code>error</code></dt>
+          <dd class="arg-description">
+            <p><em>Type:</em>&nbsp;<code>GError **</code></p>
+            <p>The return location for <a href="https://docs.gtk.org/glib/error-reporting.html#rules-for-use-of-gerror">a recoverable error</a>.</p>
+            <table>
+              <tr><td>The argument can be <code>NULL</code>.</td></tr>
+              <tr><td>If the return location is not <code>NULL</code>, then you must initialize it to a <code>NULL</code> <code>GError*</code>.</td></tr>
+              <tr><td>The argument will left initialized to <code>NULL</code> by the signal handler if there are no errors.</td></tr>
+              <tr><td>In case of error, the argument will be set to a newly allocated <code>GError</code>; the caller will take ownership of the data, and be responsible for freeing it.</td></tr>
+            </table>
+          </dd>
           {% endif %}
-        </table>
+        </dl>
       </div>
     </div>
     {% endif %}
@@ -162,10 +172,9 @@
       </h4>
 
       <div class="docblock">
-        <table class="returns">
-          <tr class="arg-name">
-            <td>Returns:</td>
-            <td>
+        <div class="returns">
+          <div class="arg-description">
+            <p><em>Type:</em>&nbsp;
             {%- if signal.return_value.is_array -%}An array of&nbsp;{%- endif -%}
             {%- if signal.return_value.is_list -%}A list of&nbsp;{%- endif -%}
             {%- if signal.return_value.is_list_model -%}A list model of&nbsp;{%- endif -%}
@@ -174,19 +183,20 @@
             {%- else -%}
             <code>{{ signal.return_value.type_cname }}</code>
             {%- endif -%}
-            </td>
-          </tr>
-          <tr class="arg-description">
-            <td>&nbsp;</td>
-            <td>{{ signal.return_value.description|safe }}</td>
-          </tr>
-          {% if signal.return_value.is_array and signal.return_value.zero_terminated %}<tr><td>&nbsp;</td><td>The array is <code>NULL</code>-terminated.</td></tr>{% endif %}
-          {% if signal.return_value.is_array and signal.return_value.fixed_size > 0 %}<tr><td>&nbsp;</td><td>The array has {{ signal.return_value.fixed_size }} elements.</td></tr>{% endif %}
-          {% if signal.return_value.is_array and signal.return_value.len_arg %}<tr><td>&nbsp;</td><td>The length of the array is in the <code>{{ signal.return_value.len_arg }}</code> argument.</td></tr>{% endif %}
-          {% if signal.return_value.is_pointer %}<tr><td>&nbsp;</td><td title="transfer: {{ signal.return_value.transfer }}">{{ signal.return_value.transfer_note }}</td></tr>{% endif %}
-          {% if signal.return_value.is_pointer and signal.return_value.nullable %}<tr><td>&nbsp;</td><td>The return value can be <code>NULL</code>.</td></tr>{% endif %}
-          {% if signal.return_value.string_note %}<tr><td>&nbsp;</td><td>{{ signal.return_value.string_note }}</td></tr>{% endif %}
-        </table>
+            </p>
+            <p>{{ signal.return_value.description|safe }}</p>
+          </div>
+          <div>
+            <table>
+            {% if signal.return_value.is_array and signal.return_value.zero_terminated %}<tr><td>The array is <code>NULL</code>-terminated.</td></tr>{% endif %}
+            {% if signal.return_value.is_array and signal.return_value.fixed_size > 0 %}<tr><td>The array has {{ signal.return_value.fixed_size }} elements.</td></tr>{% endif %}
+            {% if signal.return_value.is_array and signal.return_value.len_arg %}<tr><td>The length of the array is in the <code>{{ signal.return_value.len_arg }}</code> argument.</td></tr>{% endif %}
+            {% if signal.return_value.is_pointer %}<tr><td title="transfer: {{ signal.return_value.transfer }}">{{ signal.return_value.transfer_note }}</td></tr>{% endif %}
+            {% if signal.return_value.is_pointer and signal.return_value.nullable %}<tr><td>The return value can be <code>NULL</code>.</td></tr>{% endif %}
+            {% if signal.return_value.string_note %}<tr><td>{{ signal.return_value.string_note }}</td></tr>{% endif %}
+            </table>
+          </div>
+        </div>
       </div>
     </div>
     {% endif %}

_service:tar_scm:gi-docgen-2022.1.tar.xz/gidocgen/templates/basic/struct.html -> _service:tar_scm:gi-docgen-2023.1.tar.bz2/gidocgen/templates/basic/struct.html Changed

@@ -1,9 +1,3 @@
-
-
 {% extends "base.html" %}
 
 {% block title %}{{ namespace.name }}.{{ struct.name }}{% endblock %}
@@ -83,6 +77,19 @@
 
   <section>
     <summary>
+      <div class="docblock">
+        <p>
+        {%- if CONFIG.is_unstable(struct.available_since) -%}
+        <span class="emblem available-next" title="This type will be available in the next stable release">unstable</span>&nbsp;
+        {%- endif %}
+        {%- if struct.deprecated_since -%}
+        <span class="emblem deprecated">deprecated: {{ struct.deprecated_since.version }}</span>&nbsp;
+        {%- endif -%}
+        {%- if struct.available_since -%}
+        <span class="emblem available">since: {{ struct.available_since }}</span>
+        {%- endif -%}
+        </p>
+      </div>
       <div class="toggle-wrapper">
         <h4 style="display:flex;" id="description">
           Description
@@ -108,31 +115,33 @@
           </h6>
 
           <div class="docblock">
-            <table>
+            <dl>
             {% for field in struct.fields %}
-              <tr>
-                <td><code>{{ field.name }}</code></td>
-                <td>{{ field.description }}</td>
-              </tr>
+              <dt><code>{{ field.name }}</code></dt>
+              <dd>{{ field.description }}</dd>
             {% endfor %}
-            </table>
+            </dl>
           </div>
         </div>
         {% endif %}
 
         <div class="docblock">
-          <table class="attributes">
-            {% if struct.stability %}
-            <tr><td>Stability:</td><td>{{ struct.stability }}</td></tr>
-            {% endif %}
-            {% if struct.available_since %}
-            <tr><td>Available since:</td><td>{{ struct.available_since }}</td></tr>
-            {% endif %}
-            {% if struct.deprecated_since %}
-            <tr><td>Deprecated since:</td><td>{{ struct.deprecated_since.version }}</td></tr>
-            <tr><td colspan="2">{{ struct.deprecated_since.message }}</td></tr>
-            {% endif %}
-          </table>
+          {% if struct.stability %}
+          <p>Stability: {{ struct.stability }}</p>
+          {% endif %}
+          {% if struct.available_since %}
+          <p>Available since: {{ struct.available_since }}</p>
+          {% endif %}
+          {% if struct.deprecated_since %}
+          {%- if struct.deprecated_since.message -%}
+          <div>
+            <p>Deprecated since: {{ struct.deprecated_since.version }}</p>
+            {{ struct.deprecated_since.message }}
+          </div>
+          {%- else -%}
+          <p>Deprecated since: {{ struct.deprecated_since.version }}. Do not use in newly written code.</p>
+          {%- endif -%}
+          {% endif %}
         </div>
 
         {% if struct.attributes %}
@@ -158,21 +167,22 @@
       {% for ctor in struct.ctors %}
         <div class="{% if ctor.deprecated_since %}deprecated{% endif %}">
           <h6><a href="ctor.{{ struct.name }}.{{ ctor.name }}.html">{{ ctor.identifier }}</a></h6>
-
           <div class="docblock">
             {{ ctor.summary }}
           </div>
-
-          {% if ctor.available_since or ctor.deprecated_since -%}
           <div class="docblock">
-          {%- if ctor.available_since -%}
-          <p>Available since: {{ ctor.available_since }}</p>
-          {%- endif -%}
-          {%- if ctor.deprecated_since -%}
-          <p>Deprecated since: {{ ctor.deprecated_since }}</p>
-          {%- endif -%}
+            <p>
+            {%- if CONFIG.is_unstable(ctor.available_since) -%}
+            <span class="emblem available-next" title="This constructor will be available in the next stable release">unstable</span>&nbsp;
+            {%- endif %}
+            {%- if ctor.deprecated_since -%}
+            <span class="emblem deprecated">deprecated: {{ ctor.deprecated_since }}</span>&nbsp;
+            {%- endif -%}
+            {%- if ctor.available_since -%}
+            <span class="emblem available">since: {{ ctor.available_since }}</span>
+            {%- endif -%}
+            </p>
           </div>
-          {%- endif %}
         </div>
       {% endfor %}
       </div>
@@ -190,21 +200,22 @@
       {% for func in struct.type_funcs %}
       <div class="{% if func.deprecated_since %}deprecated{% endif %}">
         <h6><a href="type_func.{{ struct.name }}.{{ func.name }}.html">{{ func.identifier }}</a></h6>
-
         <div class="docblock">
           {{ func.summary }}
         </div>
-
-        {% if func.available_since or func.deprecated_since -%}
         <div class="docblock">
-        {%- if func.available_since -%}
-        <p>Available since: {{ func.available_since }}</p>
-        {%- endif -%}
-        {%- if func.deprecated_since -%}
-        <p>Deprecated since: {{ func.deprecated_since }}</p>
-        {%- endif -%}
+          <p>
+          {%- if CONFIG.is_unstable(func.available_since) -%}
+          <span class="emblem available-next" title="This function will be available in the next stable release">unstable</span>&nbsp;
+          {%- endif %}
+          {%- if func.deprecated_since -%}
+          <span class="emblem deprecated">deprecated: {{ func.deprecated_since }}</span>&nbsp;
+          {%- endif -%}
+          {%- if func.available_since -%}
+          <span class="emblem available">since: {{ func.available_since }}</span>
+          {%- endif -%}
+          </p>
         </div>
-        {%- endif %}
       </div>
       {% endfor %}
       </div>
@@ -222,21 +233,22 @@
       {% for method in struct.methods %}
         <div class="{% if method.deprecated_since %}deprecated{% endif %}">
           <h6><a href="method.{{ struct.name}}.{{ method.name }}.html">{{ method.identifier }}</a></h6>
-
           <div class="docblock">
             {{ method.summary }}
           </div>
-
-          {% if method.available_since or method.deprecated_since -%}
           <div class="docblock">
-          {%- if method.available_since -%}
-          <p>Available since: {{ method.available_since }}</p>
-          {%- endif -%}
-          {%- if method.deprecated_since -%}
-          <p>Deprecated since: {{ method.deprecated_since }}</p>
-          {%- endif -%}
+            <p>
+            {%- if CONFIG.is_unstable(method.available_since) -%}
+            <span class="emblem available-next" title="This method will be available in the next stable release">unstable</span>&nbsp;
+            {%- endif %}
+            {%- if method.deprecated_since -%}
+            <span class="emblem deprecated">deprecated: {{ method.deprecated_since }}</span>&nbsp;
+            {%- endif -%}
+            {%- if method.available_since -%}
+            <span class="emblem available">since: {{ method.available_since }}</span>
+            {%- endif -%}
+            </p>
           </div>
-          {%- endif %}
         </div>
       {% endfor %}
       </div>

_service:tar_scm:gi-docgen-2022.1.tar.xz/gidocgen/templates/basic/style.css -> _service:tar_scm:gi-docgen-2023.1.tar.bz2/gidocgen/templates/basic/style.css Changed

@@ -24,7 +24,15 @@
   --sidebar-selected-bg: var(--primary);
   --sidebar-hover-bg: rgba(127, 127, 127, 0.2);
   --sidebar-text-color: #fafafa;
+  --sidebar-search-bg: rgba(127, 127, 127, 0.25);
+  --sidebar-search-focus-bg: rgba(127, 127, 127, 0.3);
   --sidebar-padding: 1.5em;
+  --warning-bg-color: #e5a50a;
+  --warning-fg-color: rgba(0, 0, 0, 0.8);
+  --error-bg-color: #e01b24;
+  --error-fg-color: #ffffff;
+  --accent-bg-color: #3584e4;
+  --accent-fg-color: #ffffff;
 
   /* boxes, e.g. code blocks */
   --box-bg: rgba(135, 135, 135, 0.085);
@@ -84,6 +92,12 @@
     --box-bg: rgba(135, 135, 135, 0.1);
     --box-text-color: #fff;
     --heading-docblock-color: #b7b7b7;
+    --warning-bg-color: #cd9309;
+    --warning-fg-color: rgba(0, 0, 0, 0.8);
+    --error-bg-color: #c01c28;
+    --error-fg-color: #ffffff;
+    --accent-bg-color: #3584e4;
+    --accent-fg-color: #ffffff;
   }
 }
 
@@ -106,28 +120,6 @@
   background: var(--primary);
 }
 
-::-webkit-scrollbar {
-  width: 8px;
-  height: 8px;
-}
-
-::-webkit-scrollbar-thumb {
-  border-radius: 10px;
-  background: rgba(128, 128, 128, 0.6);
-}
-
-::-webkit-scrollbar-thumb:hover {
-  background: rgba(128, 128, 128, 1);
-}
-
-::-webkit-scrollbar-track {
-  background: rgba(128, 128, 128, 0.15);
-}
-
-* {
-  scrollbar-width: initial;
-}
-
 body {
   font: 16px/1.5 var(--body-font-family);
   font-weight: var(--body-font-weight);
@@ -338,6 +330,13 @@
   margin-bottom: 0;
 }
 
+/* allow easily adding a frame around images, by appending
+ * #frame to the url
+ */
+imgsrc$="#frame" {
+  border: 1px solid var(--text-color);
+}
+
 /*********************************
  * PAGE STRUCTURE
  *********************************/
@@ -394,7 +393,6 @@
  * SIDEBAR
  *********************************/
 .sidebar {
-  scrollbar-width: thin;
   background: var(--sidebar-bg);
   border-right: 1px solid var(--sidebar-bg);
   min-width: 35ch;
@@ -405,6 +403,7 @@
   z-index: 2;
   height: 100vh;
   overflow-y: auto;
+  color-scheme: dark;
 }
 
 .sidebar a,
@@ -422,6 +421,15 @@
   margin-right: -10px;
 }
 
+.sidebar .generator > p {
+  padding-left: 0.5rem;
+  padding-right: 0.5rem;
+  font-size: 0.8em;
+  opacity: 0.8;
+  position: relative;
+  bottom: 0;
+}
+
 .sidebar .section h3, .sidebar .section h5 {
   text-align: left;
   padding-left: 0.5rem;
@@ -485,15 +493,21 @@
 }
 
 .sidebar .search inputtype="text" {
-  border-color: transparent;
+  border: none;
   width: 100%;
-  border: 1px solid #ccc;
   border-radius: 50px;
-  padding: 6px 12px;
+  padding: 8px 14px;
   display: inline-block;
   font-size: 14px;
-  box-shadow: inset 0 1px 3px #ddd;
-  transition: border .3s linear;
+  outline: transparent;
+  background: var(--sidebar-search-bg);
+  color: var(--sidebar-text-color);
+  transition: background-color 150ms ease;
+}
+
+.sidebar .search inputtype="text":hover,
+.sidebar .search inputtype="text":focus {
+  background: var(--sidebar-search-focus-bg);
 }
 
 .toc {
@@ -855,6 +869,26 @@
   background-color: var(--primary);
 }
 
+.emblem {
+  padding: 0 0.75em;
+  border-radius: 9999px;
+  font-size: 80%;
+}
+
+.emblem.available-next {
+  background-color: var(--warning-bg-color);
+  color: var(--warning-fg-color);
+}
+
+.emblem.deprecated {
+  background-color: var(--error-bg-color);
+  color: var(--error-fg-color);
+}
+
+.emblem.available {
+  background-color: var(--accent-bg-color);
+  color: var(--accent-fg-color);
+}
 
 /*************************************************************
  SYMBOLS

_service:tar_scm:gi-docgen-2022.1.tar.xz/gidocgen/templates/basic/type_func.html -> _service:tar_scm:gi-docgen-2023.1.tar.bz2/gidocgen/templates/basic/type_func.html Changed

@@ -1,9 +1,3 @@
-
-
 {% extends "base.html" %}
 
 {% block title %}{{ namespace.name }}.{{ class.name }}.{{ type_func.name }}{% endblock %}
@@ -40,6 +34,19 @@
   </header>
 
   <section>
+    <div class="docblock">
+      <p>
+      {%- if CONFIG.is_unstable(type_func.available_since) -%}
+      <span class="emblem available-next" title="This function will be available in the next stable release">unstable</span>&nbsp;
+      {%- endif %}
+      {%- if type_func.deprecated_since -%}
+      <span class="emblem deprecated">deprecated: {{ type_func.deprecated_since.version }}</span>&nbsp;
+      {%- endif -%}
+      {%- if type_func.available_since -%}
+      <span class="emblem available">since: {{ type_func.available_since }}</span>
+      {%- endif -%}
+      </p>
+    </div>
     <div class="declaration toggle-wrapper">
       <h4 id="declaration" style="display:flex;">
         Declaration
@@ -68,18 +75,31 @@
       </div>
 
       <div class="docblock">
-        <table>
-          {% if type_func.stability %}
-          <tr><td>Stability:</td><td>{{ type_func.stability }}</td></tr>
-          {% endif %}
-          {% if type_func.available_since %}
-          <tr><td>Available since:</td><td>{{ type_func.available_since }}</td></tr>
-          {% endif %}
-          {% if type_func.deprecated_since %}
-          <tr><td>Deprecated since:</td><td>{{ type_func.deprecated_since.version }}</td></tr>
-          <tr><td colspan="2">{{ type_func.deprecated_since.message }}</td></tr>
-          {% endif %}
-        </table>
+        {% if type_func.stability -%}
+        <p>Stability: {{ type_func.stability }}</p>
+        {%- endif %}
+        {% if type_func.available_since -%}
+        <p>Available since: {{ type_func.available_since }}</p>
+        {%- endif %}
+        {% if type_func.deprecated_since -%}
+        <div>
+          {%- if type_func.deprecated_since.message -%}
+          <p>Deprecated since: {{ type_func.deprecated_since.version }}</p>
+          {{ type_func.deprecated_since.message }}
+          {%- else -%}
+          <p>Deprecated since: {{ type_func.deprecated_since.version }}. Do not use in newly written code</p>
+          {%- endif -%}
+        </div>
+        {%- endif %}
+        {% if not type_func.introspectable -%}
+        <p>This function is not directly available to language bindings.</p>
+        {%- endif %}
+        {% if type_func.shadows -%}
+        <p>This method is renamed to <a href="type_func.{{class.name}}.{{type_func.shadows}}.html"><code>{{type_func.shadows_symbol}}()</code></a> in language bindings</p>
+        {%- endif %}
+        {% if type_func.shadowed_by -%}
+        <p>The implementation of this method is provided by <a href="type_func.{{class.name}}.{{type_func.shadowed_by}}.html"><code>{{type_func.shadowed_by_symbol}}()</code></a> in language bindings</p>
+        {%- endif %}
       </div>
 
       {% if type_func.attributes %}
@@ -101,11 +121,11 @@
       </h4>
 
       <div class="docblock">
-        <table class="arguments">
+        <dl class="arguments">
           {% for arg in type_func.arguments %}
-          <tr class="arg-name">
-            <td><code>{{ arg.name }}</code></td>
-            <td>
+          <dt class="arg-name"><code>{{ arg.name }}</code></dt>
+          <dd class="arg-description">
+            <p><em>Type:</em>&nbsp;
             {%- if arg.is_array -%}An array of&nbsp;{%- endif -%}
             {%- if arg.is_list -%}A list of&nbsp;{%- endif -%}
             {%- if arg.link -%}
@@ -113,33 +133,36 @@
             {%- else -%}
             <code>{{ arg.type_cname }}</code>
             {%- endif -%}
-            </td>
-          </tr>
-          <tr class="arg-description">
-            <td>&nbsp;</td>
-            <td>{{ arg.description|safe }}</td>
-          </tr>
-          {% if arg.direction != "in" %}<tr><td>&nbsp;</td><td title="direction: {{ arg.direction}}">{{ arg.direction_note }}</td></tr>{% endif %}
-          {% if arg.direction == "in" and arg.is_pointer and arg.nullable %}<tr><td>&nbsp;</td><td>The argument can be <code>NULL</code>.</td></tr>{% endif %}
-          {% if arg.direction == "out" and arg.is_pointer and arg.nullable %}<tr><td>&nbsp;</td><td>The argument can be set to <code>NULL</code>.</td></tr>{% endif %}
-          {% if arg.optional %}<tr><td>&nbsp;</td><td>The argument can be <code>NULL</code>.</td></tr>{% endif %}
-          {% if arg.is_array and arg.zero_terminated %}<tr><td>&nbsp;</td><td>The array must be <code>NULL</code>-terminated.</td></tr>{% endif %}
-          {% if arg.is_array and arg.fixed_size > 0 %}<tr><td>&nbsp;</td><td>The array must have {{ arg.fixed_size }} elements.</td></tr>{% endif %}
-          {% if arg.is_array and arg.len_arg %}<tr><td>&nbsp;</td><td>The length of the array is specified in the <code>{{ arg.len_arg }}</code> argument.</td></tr>{% endif %}
-          {% if arg.is_pointer %}<tr><td>&nbsp;</td><td title="transfer: {{ arg.transfer }}">{{ arg.transfer_note }}</td></tr>{% endif %}
-          {% if arg.string_note %}<tr><td>&nbsp;</td><td>{{ arg.string_note }}</td></tr>{% endif %}
+            </p>
+            <p>{{ arg.description|safe }}</p>
+            <table>
+            {% if arg.direction != "in" %}<tr><td title="direction: {{ arg.direction}}">{{ arg.direction_note }}</td></tr>{% endif %}
+            {% if arg.direction == "in" and arg.is_pointer and arg.nullable %}<tr><td>The argument can be <code>NULL</code>.</td></tr>{% endif %}
+            {% if arg.direction == "out" and arg.is_pointer and arg.nullable %}<tr><td>The argument can be set to <code>NULL</code> by the function.</td></tr>{% endif %}
+            {% if arg.optional %}<tr><td>The argument can be <code>NULL</code>.</td></tr>{% endif %}
+            {% if arg.is_array and arg.zero_terminated %}<tr><td>The array must be <code>NULL</code>-terminated.</td></tr>{% endif %}
+            {% if arg.is_array and arg.fixed_size > 0 %}<tr><td>The array must have {{ arg.fixed_size }} elements.</td></tr>{% endif %}
+            {% if arg.is_array and arg.len_arg %}<tr><td>The length of the array is specified in the <code>{{ arg.len_arg }}</code> argument.</td></tr>{% endif %}
+            {% if arg.is_pointer %}<tr><td title="transfer: {{ arg.transfer }}">{{ arg.transfer_note }}</td></tr>{% endif %}
+            {% if arg.string_note %}<tr><td>{{ arg.string_note }}</td></tr>{% endif %}
+            </table>
+          </dd>
           {% endfor %}
+
           {% if type_func.throws %}
-          <tr class="arg-name">
-            <td><code>error</code></td>
-            <td><code>GError **</code></td>
-          </tr>
-          <tr class="arg-description">
-            <td>&nbsp;</td>
-            <td>The return location for a <code>GError*</code>, or <code>NULL</code>.</td>
-          </tr>
+          <dt class="arg-name"><code>error</code></dt>
+          <dd class="arg-description">
+            <p><em>Type:</em>&nbsp;<a href="javascript:void(0)" data-namespace="GLib" data-link="struct.Error.html" class="external"><code>GError **</code></a></p>
+            <p>The return location for <a href="https://docs.gtk.org/glib/error-reporting.html#rules-for-use-of-gerror">a recoverable error</a>.</p>
+            <table>
+              <tr><td>The argument can be <code>NULL</code>.</td></tr>
+              <tr><td>If the return location is not <code>NULL</code>, then you must initialize it to a <code>NULL</code> <code>GError*</code>.</td></tr>
+              <tr><td>The argument will left initialized to <code>NULL</code> by the function if there are no errors.</td></tr>
+              <tr><td>In case of error, the argument will be set to a newly allocated <code>GError</code>; the caller will take ownership of the data, and be responsible for freeing it.</td></tr>
+            </table>
+          </dd>
           {% endif %}
-        </table>
+        </dl>
       </div>
     </div>
     {% endif %}
@@ -152,10 +175,9 @@
       </h4>
 
       <div class="docblock">
-        <table class="returns">
-          <tr class="arg-name">
-            <td>Returns:</td>
-            <td>
+        <div class="returns">
+          <div class="arg-description">
+            <p><em>Type:</em>&nbsp;
             {%- if type_func.return_value.is_array -%}An array of&nbsp;{%- endif -%}
             {%- if type_func.return_value.is_list -%}A list of&nbsp;{%- endif -%}
             {%- if type_func.return_value.is_list_model -%}A list model of&nbsp;{%- endif -%}
@@ -164,19 +186,20 @@
             {%- else -%}
             <code>{{ type_func.return_value.type_cname }}</code>
             {%- endif -%}
-            </td>
-          </tr>
-          <tr class="arg-description">
-            <td>&nbsp;</td>
-            <td>{{ type_func.return_value.description|safe }}</td>
-          </tr>
-          {% if type_func.return_value.is_array and type_func.return_value.zero_terminated %}<tr><td>&nbsp;</td><td>The array is <code>NULL</code>-terminated.</td></tr>{% endif %}
-          {% if type_func.return_value.is_array and type_func.return_value.fixed_size > 0 %}<tr><td>&nbsp;</td><td>The array has {{ type_func.return_value.fixed_size }} elements.</td></tr>{% endif %}
-          {% if type_func.return_value.is_array and type_func.return_value.len_arg %}<tr><td>&nbsp;</td><td>The length of the array is in the <code>{{ type_func.return_value.len_arg }}</code> argument.</td></tr>{% endif %}
-          {% if type_func.return_value.is_pointer %}<tr><td>&nbsp;</td><td title="transfer: {{ type_func.return_value.transfer }}">{{ type_func.return_value.transfer_note }}</td></tr>{% endif %}
-          {% if type_func.return_value.is_pointer and type_func.return_value.nullable %}<tr><td>&nbsp;</td><td>The return value can be <code>NULL</code>.</td></tr>{% endif %}
-          {% if type_func.return_value.string_note %}<tr><td>&nbsp;</td><td>{{ type_func.return_value.string_note }}</td></tr>{% endif %}
-        </table>
+            </p>
+            <p>{{ type_func.return_value.description|safe }}</p>
+          </div>
+          <div>
+            <table>
+            {% if type_func.return_value.is_array and type_func.return_value.zero_terminated %}<tr><td>The array is <code>NULL</code>-terminated.</td></tr>{% endif %}
+            {% if type_func.return_value.is_array and type_func.return_value.fixed_size > 0 %}<tr><td>The array has {{ type_func.return_value.fixed_size }} elements.</td></tr>{% endif %}
+            {% if type_func.return_value.is_array and type_func.return_value.len_arg %}<tr><td>The length of the array is in the <code>{{ type_func.return_value.len_arg }}</code> argument.</td></tr>{% endif %}
+            {% if type_func.return_value.is_pointer %}<tr><td title="transfer: {{ type_func.return_value.transfer }}">{{ type_func.return_value.transfer_note }}</td></tr>{% endif %}
+            {% if type_func.return_value.is_pointer and type_func.return_value.nullable %}<tr><td>The return value can be <code>NULL</code>.</td></tr>{% endif %}
+            {% if type_func.return_value.string_note %}<tr><td>{{ type_func.return_value.string_note }}</td></tr>{% endif %}
+            </table>
+          </div>
+        </div>
       </div>
     </div>
     {% endif %}

_service:tar_scm:gi-docgen-2022.1.tar.xz/gidocgen/templates/basic/vfunc.html -> _service:tar_scm:gi-docgen-2023.1.tar.bz2/gidocgen/templates/basic/vfunc.html Changed

@@ -1,9 +1,3 @@
-
-
 {% extends "base.html" %}
 
 {% block title %}{{ namespace.name }}.{{ class.name }}.{{ vfunc.name }}{% endblock %}
@@ -40,6 +34,20 @@
   </header>
 
   <section>
+    <div class="docblock">
+      <p>
+      {%- if CONFIG.is_unstable(vfunc.available_since) -%}
+      <span class="emblem available-next" title="This virtual functionwill be available in the next stable release">unstable</span>&nbsp;
+      {%- endif %}
+      {%- if vfunc.deprecated_since -%}
+      <span class="emblem deprecated">deprecated: {{ vfunc.deprecated_since.version }}</span>&nbsp;
+      {%- endif -%}
+      {%- if vfunc.available_since -%}
+      <span class="emblem available">since: {{ vfunc.available_since }}</span>
+      {%- endif -%}
+      </p>
+    </div>
+
     <div class="declaration toggle-wrapper">
       <h4 id="declaration">
         Declaration
@@ -68,18 +76,22 @@
       </div>
 
       <div class="docblock">
-        <table>
-          {% if vfunc.stability %}
-          <tr><td>Stability:</td><td>{{ vfunc.stability }}</td></tr>
-          {% endif %}
-          {% if vfunc.available_since %}
-          <tr><td>Available since:</td><td>{{ vfunc.available_since }}</td></tr>
-          {% endif %}
-          {% if vfunc.deprecated_since %}
-          <tr><td>Deprecated since:</td><td>{{ vfunc.deprecated_since.version }}</td></tr>
-          <tr><td colspan="2">{{ vfunc.deprecated_since.message }}</td></tr>
-          {% endif %}
-        </table>
+        {% if vfunc.stability -%}
+        <p>Stability: {{ vfunc.stability }}</p>
+        {%- endif %}
+        {% if vfunc.available_since -%}
+        <p>Available since: {{ vfunc.available_since }}</p>
+        {%- endif %}
+        {% if vfunc.deprecated_since -%}
+        <div>
+          {%- if vfunc.deprecated_since.message -%}
+          <p>Deprecated since: {{ vfunc.deprecated_since.version }}</p>
+          {{ vfunc.deprecated_since.message }}
+          {%- else -%}
+          <p>Deprecated since: {{ vfunc.deprecated_since.version }}. Do not use in newly written code</p>
+          {%- endif -%}
+        </div>
+        {%- endif %}
       </div>
 
       {% if vfunc.attributes %}
@@ -101,11 +113,11 @@
       </h4>
 
       <div class="docblock">
-        <table class="arguments">
+        <dl class="arguments">
           {% for arg in vfunc.arguments %}
-          <tr class="arg-name">
-            <td><code>{{ arg.name }}</code></td>
-            <td>
+          <dt class="arg-name"><code>{{ arg.name }}</code></dt>
+          <dd class="arg-description">
+            <p><em>Type:</em>&nbsp;
             {%- if arg.is_array -%}An array of&nbsp;{%- endif -%}
             {%- if arg.is_list -%}A list of&nbsp;{%- endif -%}
             {%- if arg.link -%}
@@ -113,33 +125,36 @@
             {%- else -%}
             <code>{{ arg.type_cname }}</code>
             {%- endif -%}
-            </td>
-          </tr>
-          <tr class="arg-description">
-            <td>&nbsp;</td>
-            <td>{{ arg.description|safe }}</td>
-          </tr>
-          {% if arg.direction != "in" %}<tr><td>&nbsp;</td><td title="direction: {{ arg.direction}}">{{ arg.direction_note }}</td></tr>{% endif %}
-          {% if arg.direction == "in" and arg.is_pointer and arg.nullable %}<tr><td>&nbsp;</td><td>The argument can be <code>NULL</code>.</td></tr>{% endif %}
-          {% if arg.direction == "out" and arg.is_pointer and arg.nullable %}<tr><td>&nbsp;</td><td>The argument can be set to <code>NULL</code>.</td></tr>{% endif %}
-          {% if arg.optional %}<tr><td>&nbsp;</td><td>The argument can be <code>NULL</code>.</td></tr>{% endif %}
-          {% if arg.is_array and arg.zero_terminated %}<tr><td>&nbsp;</td><td>The array must be <code>NULL</code>-terminated.</td></tr>{% endif %}
-          {% if arg.is_array and arg.fixed_size > 0 %}<tr><td>&nbsp;</td><td>The array must have {{ arg.fixed_size }} elements.</td></tr>{% endif %}
-          {% if arg.is_array and arg.len_arg %}<tr><td>&nbsp;</td><td>The length of the array is specified in the <code>{{ arg.len_arg }}</code> argument.</td></tr>{% endif %}
-          {% if arg.is_pointer %}<tr><td>&nbsp;</td><td title="transfer: {{ arg.transfer }}">{{ arg.transfer_note }}</td></tr>{% endif %}
-          {% if arg.string_note %}<tr><td>&nbsp;</td><td>{{ arg.string_note }}</td></tr>{% endif %}
+            </p>
+            <p>{{ arg.description|safe }}</p>
+            <table>
+            {% if arg.direction != "in" %}<tr><td title="direction: {{ arg.direction}}">{{ arg.direction_note }}</td></tr>{% endif %}
+            {% if arg.direction == "in" and arg.is_pointer and arg.nullable %}<tr><td>The argument can be <code>NULL</code>.</td></tr>{% endif %}
+            {% if arg.direction == "out" and arg.is_pointer and arg.nullable %}<tr><td>The argument can be set to <code>NULL</code> by the virtual function.</td></tr>{% endif %}
+            {% if arg.optional %}<tr><td>The argument can be <code>NULL</code>.</td></tr>{% endif %}
+            {% if arg.is_array and arg.zero_terminated %}<tr><td>The array must be <code>NULL</code>-terminated.</td></tr>{% endif %}
+            {% if arg.is_array and arg.fixed_size > 0 %}<tr><td>The array must have {{ arg.fixed_size }} elements.</td></tr>{% endif %}
+            {% if arg.is_array and arg.len_arg %}<tr><td>The length of the array is specified in the <code>{{ arg.len_arg }}</code> argument.</td></tr>{% endif %}
+            {% if arg.is_pointer %}<tr><td title="transfer: {{ arg.transfer }}">{{ arg.transfer_note }}</td></tr>{% endif %}
+            {% if arg.string_note %}<tr><td>{{ arg.string_note }}</td></tr>{% endif %}
+            </table>
+          </dd>
           {% endfor %}
+
           {% if vfunc.throws %}
-          <tr class="arg-name">
-            <td><code>error</code></td>
-            <td><code>GError **</code></td>
-          </tr>
-          <tr class="arg-description">
-            <td>&nbsp;</td>
-            <td>The return location for a <code>GError*</code>, or <code>NULL</code>.</td>
-          </tr>
+          <dt class="arg-name"><code>error</code></dt>
+          <dd class="arg-description">
+            <p><em>Type:</em>&nbsp;<a href="javascript:void(0)" data-namespace="GLib" data-link="struct.Error.html" class="external"><code>GError **</code></a></p>
+            <p>The return location for <a href="https://docs.gtk.org/glib/error-reporting.html#rules-for-use-of-gerror">a recoverable error</a>.</p>
+            <table>
+              <tr><td>The argument can be <code>NULL</code>.</td></tr>
+              <tr><td>If the return location is not <code>NULL</code>, then you must initialize it to a <code>NULL</code> <code>GError*</code>.</td></tr>
+              <tr><td>The argument will left initialized to <code>NULL</code> by the virtual function if there are no errors.</td></tr>
+              <tr><td>In case of error, the argument will be set to a newly allocated <code>GError</code>; the caller will take ownership of the data, and be responsible for freeing it.</td></tr>
+            </table>
+          </dd>
           {% endif %}
-        </table>
+        </dl>
       </div>
     </div>
     {% endif %}
@@ -152,10 +167,9 @@
       </h4>
 
       <div class="docblock">
-        <table class="returns">
-          <tr class="arg-name">
-            <td>Returns:</td>
-            <td>
+        <div class="returns">
+          <div>
+            <p><em>Type:</em>&nbsp;
             {%- if vfunc.return_value.is_array -%}An array of&nbsp;{%- endif -%}
             {%- if vfunc.return_value.is_list -%}A list of&nbsp;{%- endif -%}
             {%- if vfunc.return_value.is_list_model -%}A list model of&nbsp;{%- endif -%}
@@ -164,19 +178,20 @@
             {%- else -%}
             <code>{{ vfunc.return_value.type_cname }}</code>
             {%- endif -%}
-            </td>
-          </tr>
-          <tr class="arg-description">
-            <td>&nbsp;</td>
-            <td>{{ vfunc.return_value.description|safe }}</td>
-          </tr>
-          {% if vfunc.return_value.is_array and vfunc.return_value.zero_terminated %}<tr><td>&nbsp;</td><td>The array is <code>NULL</code>-terminated.</td></tr>{% endif %}
-          {% if vfunc.return_value.is_array and vfunc.return_value.fixed_size > 0 %}<tr><td>&nbsp;</td><td>The array has {{ vfunc.return_value.fixed_size }} elements.</td></tr>{% endif %}
-          {% if vfunc.return_value.is_array and vfunc.return_value.len_arg %}<tr><td>&nbsp;</td><td>The length of the array is in the <code>{{ vfunc.return_value.len_arg }}</code> argument.</td></tr>{% endif %}
-          {% if vfunc.return_value.is_pointer %}<tr><td>&nbsp;</td><td title="transfer: {{ vfunc.return_value.transfer }}">{{ vfunc.return_value.transfer_note }}</td></tr>{% endif %}
-          {% if vfunc.return_value.is_pointer and vfunc.return_value.nullable %}<tr><td>&nbsp;</td><td>The return value can be <code>NULL</code>.</td></tr>{% endif %}
-          {% if vfunc.return_value.string_note %}<tr><td>&nbsp;</td><td>{{ vfunc.return_value.string_note }}</td></tr>{% endif %}
-        </table>
+            </p>
+            <p>{{ vfunc.return_value.description|safe }}</p>
+          </div>
+          <div>
+            <table>
+            {% if vfunc.return_value.is_array and vfunc.return_value.zero_terminated %}<tr><td>The array is <code>NULL</code>-terminated.</td></tr>{% endif %}
+            {% if vfunc.return_value.is_array and vfunc.return_value.fixed_size > 0 %}<tr><td>The array has {{ vfunc.return_value.fixed_size }} elements.</td></tr>{% endif %}
+            {% if vfunc.return_value.is_array and vfunc.return_value.len_arg %}<tr><td>The length of the array is in the <code>{{ vfunc.return_value.len_arg }}</code> argument.</td></tr>{% endif %}
+            {% if vfunc.return_value.is_pointer %}<tr><td title="transfer: {{ vfunc.return_value.transfer }}">{{ vfunc.return_value.transfer_note }}</td></tr>{% endif %}
+            {% if vfunc.return_value.is_pointer and vfunc.return_value.nullable %}<tr><td>The return value can be <code>NULL</code>.</td></tr>{% endif %}
+            {% if vfunc.return_value.string_note %}<tr><td>{{ vfunc.return_value.string_note }}</td></tr>{% endif %}
+            </table>
+          </div>
+        </div>
       </div>
     </div>
     {% endif %}

_service:tar_scm:gi-docgen-2022.1.tar.xz/gidocgen/utils.py -> _service:tar_scm:gi-docgen-2023.1.tar.bz2/gidocgen/utils.py Changed

@@ -13,7 +13,7 @@
 from pygments.formatters import HtmlFormatter
 from typogrify.filters import typogrify
 
-from . import gir, log, mdext, porter
+from . import gir, log, mdext
 
 
 # The beginning of a gtk-doc code block:
@@ -305,8 +305,6 @@
             # invalid links
             if isinstance(t, gir.Alias):
                 type_fragment = 'alias'
-            elif isinstance(t, gir.BitField):
-                type_fragment = 'flags'
             elif isinstance(t, gir.Callback):
                 type_fragment = 'callback'
             elif isinstance(t, gir.Class):
@@ -314,9 +312,12 @@
             elif isinstance(t, gir.Constant):
                 type_fragment = 'const'
             elif isinstance(t, gir.Enumeration):
-                type_fragment = 'enum'
-            elif isinstance(t, gir.ErrorDomain):
-                type_fragment = 'error'
+                if isinstance(t, gir.BitField):
+                    type_fragment = 'flags'
+                elif isinstance(t, gir.ErrorDomain):
+                    type_fragment = 'error'
+                else:
+                    type_fragment = 'enum'
             elif isinstance(t, gir.Interface):
                 type_fragment = 'iface'
             elif isinstance(t, gir.Record) or isinstance(t, gir.Union):
@@ -727,80 +728,6 @@
     return Markup(typogrify(text, ignore_tags='h1', 'h2', 'h3', 'h4'))
 
 
-def stem(word, stemmer=None):
-    if stemmer is None:
-        stemmer = porter.PorterStemmer()
-    return stemmer.stem(word, 0, len(word) - 1)
-
-
-def index_description(text, stemmer=None):
-    processed_text = 
-
-    inside_code_block = False
-    for line in text.split("\n"):
-        if not inside_code_block and (line.startswith('```') or line.startswith('|')):
-            inside_code_block = True
-            continue
-
-        if inside_code_block and (line.startswith('```') or line.startswith('|')):
-            inside_code_block = False
-            continue
-
-        if not inside_code_block:
-            processed_text.append(line)
-
-    data = " ".join(processed_text)
-    terms = set()
-    for chunk in data.split(" "):
-        chunk = chunk.lower()
-        if chunk in "\n", "\r", "\r\n":
-            continue
-        # Skip gtk-doc sygils
-        if chunk.startswith('%') or chunk.startswith('#') or chunk.startswith('@') or chunk.endswith('()'):
-            continue
-        # Skip gi-docgen links
-        if chunk.startswith('') and chunk.endswith('') and '@' in chunk:
-            continue
-        # Skip images
-        if chunk.startswith('!'):
-            continue
-        if chunk in EN_STOPWORDS:
-            continue
-        chunk = re.sub(r"`(\w+)`", r"\g<1>", chunk)
-        chunk = re.sub(r",\.:;`$", '', chunk)
-        chunk = re.sub(r"+", '', chunk)
-        terms.add(stem(chunk, stemmer))
-    return terms
-
-
-def canonicalize(symbol):
-    return symbol.replace('-', '_')
-
-
-def index_identifier(symbol, stemmer=None):
-    """Chunks an identifier (e.g. EventControllerClik) into terms useful for indexing."""
-    symbol = re.sub(CAMEL_CASE_START_RE, r"\g<1>_\g<2>", symbol)
-    symbol = re.sub(CAMEL_CASE_CHUNK_RE, r"\g<1>_\g<2>", symbol)
-    symbol = symbol.replace('-', '_')
-    symbol = symbol.lower()
-    terms = set()
-    for chunk in symbol.split('_'):
-        if chunk in EN_STOPWORDS:
-            continue
-        terms.add(stem(chunk, stemmer))
-    return terms
-
-
-def index_symbol(symbol, stemmer=None):
-    """Chunks a symbol (e.g. set_layout_manager) into terms useful for indexing."""
-    terms = set()
-    for chunk in canonicalize(symbol).split('_'):
-        if chunk in EN_STOPWORDS:
-            continue
-        terms.add(stem(chunk, stemmer))
-    return terms
-
-
 def code_highlight(text, language='c'):
     lexer = get_lexer_by_name(language)
     formatter = HtmlFormatter()

_service:tar_scm:gi-docgen-2022.1.tar.xz/meson.build -> _service:tar_scm:gi-docgen-2023.1.tar.bz2/meson.build Changed

@@ -3,7 +3,7 @@
 # SPDX-License-Identifier: Apache-2.0 OR GPL-3.0-or-later
 
 project('gi-docgen',
-  version: '2022.1',
+  version: '2023.1',
   meson_version: '>= 0.55.0',
 )
 
@@ -13,11 +13,39 @@
     'markdown',
     'markupsafe',
     'pygments',
-    'toml',
     'typogrify',
   ,
 )
 
+markdown_version = run_command(
+  py, '-c', 'import markdown; print(markdown.__version__)',
+  check: true,
+).stdout().strip()
+
+if not markdown_version.version_compare('>=3.2')
+  error('gi-docgen requires at least markdown >= 3.2')
+endif
+
+if py.language_version().version_compare('<3.11')
+  tomli_version = run_command(
+    py, '-c', 'import tomli; print(tomli.__version__)',
+    check: false,
+  ).stdout().strip()
+  if tomli_version.version_compare('>=1.0')
+    message('Falling back to toml on Python <3.11')
+  else
+    toml_version = run_command(
+      py, '-c', 'import toml; print(toml.__version__)',
+      check: false,
+    ).stdout().strip()
+    if toml_version.version_compare('>=0.10.2')
+      warning('Falling back to deprecated toml module; please update to tomli')
+    else
+      error('tomli 1.0 or newer required on Python 3.10 and older')
+    endif
+  endif
+endif
+
 configure_file(
   input: 'gi-docgen.py',
   output: 'gi-docgen',

_service:tar_scm:gi-docgen-2022.1.tar.xz/pyproject.toml -> _service:tar_scm:gi-docgen-2023.1.tar.bz2/pyproject.toml Changed

_service:tar_scm:gi-docgen-2022.1.tar.xz/setup.cfg -> _service:tar_scm:gi-docgen-2023.1.tar.bz2/setup.cfg Changed

@@ -3,8 +3,11 @@
 # SPDX-License-Identifier: Apache-2.0 OR GPL-3.0-or-later
 
 metadata
+name = gi-docgen
+version = attr: gidocgen.core.version
 description = Documentation tool for GObject-based libraries
-long_description = GI-Docgen is a document generator for GObject-based libraries. GObject is the base type system of the GNOME project. GI-Docgen reuses the introspection data generated by GObject-based libraries to generate the API reference of these libraries, as well as other ancillary documentation.
+long_description = file: README.md
+long_description_content_type = text/markdown
 author = Emmanuele Bassi
 author_email = ebassi@gnome.org
 url = https://gitlab.gnome.org/GNOME/gi-docgen
@@ -16,9 +19,7 @@
   introspection
   gobject
   gtk
-license =
-  Apache License, Version 2.0
-  GNU General Publice License, Version 3.0 or later
+license = GPL-3.0-or-later AND Apache-2.0 AND CC0-1.0
 license_files =
   LICENSES/Apache-2.0.txt
   LICENSES/GPL-3.0-or-later.txt
@@ -43,21 +44,39 @@
 
 
 options
+include_package_data = true
+packages =
+  gidocgen
+  gidocgen.gir
 python_requires = >= 3.6.0
 setup_requires =
   setuptools
-
 install_requires =
-  Markdown
+  Markdown >= 3.2
   MarkupSafe
   Pygments
   jinja2
-  toml
+  tomli; python_version < '3.11'
   typogrify
 
 options.entry_points
 console_scripts =
-  meson = gidocgen.gidocmain:main
+  gi-docgen = gidocgen.gidocmain:main
+
+options.data_files
+share/pkgconfig = gi-docgen.pc
+share/man/man1 = docs/gi-docgen.1
+
+options.package_data
+gidocgen =
+  templates/basic/basic.toml
+  templates/basic/*.css
+  templates/basic/*.html
+  templates/basic/*.js
+  templates/basic/*.png
+  templates/basic/*.woff2
+  templates/basic/*.woff
+  py.typed
 
 bdist_wheel
 universal = true

_service:tar_scm:gi-docgen-2022.1.tar.xz/setup.py -> _service:tar_scm:gi-docgen-2023.1.tar.bz2/setup.py Changed

@@ -28,50 +28,9 @@
         return super().run()
 
 
-def readme_md():
-    '''Return the contents of the README.md file'''
-    return open('README.md').read()
-
-
-entries = {
-    'console_scripts': 'gi-docgen=gidocgen.gidocmain:main',
-}
-
-packages = 
-    'gidocgen',
-    'gidocgen.gir',
-
-
-package_data = {
-    'gidocgen': 
-        "templates/basic/basic.toml",
-        "templates/basic/*.css",
-        "templates/basic/*.html",
-        "templates/basic/*.js",
-        "templates/basic/*.png",
-        "templates/basic/*.woff2",
-        "templates/basic/*.woff",
-    ,
-}
-
-data_files = 
-    ('share/pkgconfig', 'gi-docgen.pc'),
-    ('share/man/man1', 'docs/gi-docgen.1'),
-
-
 if __name__ == '__main__':
     setup(
         cmdclass={
             'build_py': BuildCommand,
         },
-        name='gi-docgen',
-        version=version,
-        license='GPL-3.0-or-later AND Apache-2.0 AND CC0-1.0',
-        long_description=readme_md(),
-        long_description_content_type='text/markdown',
-        include_package_data=True,
-        packages=packages,
-        package_data=package_data,
-        entry_points=entries,
-        data_files=data_files,
     )

Changes of Revision 3