[gi-docgen/ebassi/iface-docs: 2/2] generate: Add class structure documentation
- From: Emmanuele Bassi <ebassi src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [gi-docgen/ebassi/iface-docs: 2/2] generate: Add class structure documentation
- Date: Fri, 1 Apr 2022 23:58:22 +0000 (UTC)
commit 101d59387f5a0cfe09c38a7bb703d248365c6527
Author: Emmanuele Bassi <ebassi gnome org>
Date: Sat Apr 2 00:54:34 2022 +0100
generate: Add class structure documentation
Just like we do for the interface structure.
gidocgen/gdgenerate.py | 8 +++++---
gidocgen/templates/basic/class.html | 4 ++++
2 files changed, 9 insertions(+), 3 deletions(-)
---
diff --git a/gidocgen/gdgenerate.py b/gidocgen/gdgenerate.py
index adbdc18..59979b0 100644
--- a/gidocgen/gdgenerate.py
+++ b/gidocgen/gdgenerate.py
@@ -1459,13 +1459,15 @@ class TemplateClass:
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))
diff --git a/gidocgen/templates/basic/class.html b/gidocgen/templates/basic/class.html
index 6d76282..1f511d8 100644
--- a/gidocgen/templates/basic/class.html
+++ b/gidocgen/templates/basic/class.html
@@ -620,6 +620,10 @@ SPDX-License-Identifier: Apache-2.0 OR GPL-3.0-or-later
}</code></pre>
</div>
+ <div class="docblock">
+ {{ class.class_description }}
+ </div>
+
{% if class.class_fields %}
<div class="docblock">
<h6>Class members</h6>
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]