luc14n0/glib
1
0
Fork 0
mirror of https://gitlab.gnome.org/GNOME/glib.git synced 2025-04-25 08:36:52 +02:00
Code Issues Packages Projects Releases Wiki Activity

Merge branch 'ebassi/rst-codegen-fixes' into 'main'

Browse Source 
Generate missing docs for out arguments

See merge request GNOME/glib!3553
This commit is contained in:
Philip Withnall 2023-08-28 17:16:34 +00:00
commit b35e70a701
1 changed files with 15 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
gio/gdbus-2.0/codegen/codegen_rst.py
View File

@ -120,12 +120,12 @@ class RstCodeGenerator:
def _generate_section(self, title, name): def _generate_section(self, title, name):
"""Generates a section with the given title.""" """Generates a section with the given title."""
res = [ res = [
f".. _{name} {title}:",
"",
"-" * len(title), "-" * len(title),
title, title,
"-" * len(title), "-" * len(title),
"", "",
f".. {name} {title}:",
"",
"", "",
] ]
return "\n".join(res) return "\n".join(res)
@ -142,6 +142,8 @@ class RstCodeGenerator:
else: else:
access = "readable" access = "readable"
res += [ res += [
".. _{title}:",
"",
title, title,
"^" * len(title), "^" * len(title),
"", "",
@ -216,6 +218,8 @@ class RstCodeGenerator:
for m in iface.methods: for m in iface.methods:
title = f"{iface.name}.{m.name}" title = f"{iface.name}.{m.name}"
res += [ res += [
".. _{title}:",
"",
title, title,
"^" * len(title), "^" * len(title),
"", "",
@ -231,6 +235,13 @@ class RstCodeGenerator:
f" {arg_desc}", f" {arg_desc}",
"", "",
] ]
for a in m.out_args:
arg_desc = self._expand(a.doc_string, True)
res += [
f"{a.name}",
f" {arg_desc}",
"",
]
res += [""] res += [""]
if m.since: if m.since:
res += [ res += [
@ -285,6 +296,8 @@ class RstCodeGenerator:
for s in iface.signals: for s in iface.signals:
title = f"{iface.name}::{s.name}" title = f"{iface.name}::{s.name}"
res += [ res += [
".. _{title}:",
"",
title, title,
"^" * len(title), "^" * len(title),
"", "",