[gi-docgen/filter-hidden: 3/11] template: Add a section for interface prerequisites




commit f8ea4c8406af6cbbd26e658e6637b26b6cb3d0c1
Author: Emmanuele Bassi <ebassi gnome org>
Date:   Tue Jun 8 13:54:35 2021 +0100

    template: Add a section for interface prerequisites
    
    Document the prerequisite explicitly, instead of relying on the
    pseudo-code declaration.

 gidocgen/templates/basic/interface.html | 17 +++++++++++++++++
 1 file changed, 17 insertions(+)
---
diff --git a/gidocgen/templates/basic/interface.html b/gidocgen/templates/basic/interface.html
index 2535feb..a590265 100644
--- a/gidocgen/templates/basic/interface.html
+++ b/gidocgen/templates/basic/interface.html
@@ -118,6 +118,23 @@ SPDX-License-Identifier: Apache-2.0 OR GPL-3.0-or-later
       </div>
     </summary>
 
+    <div class="toggle-wrapper prerequisite">
+      <h4 id="prerequisite">
+        Prerequisite
+        <a href="#prerequisite" class="anchor"></a>
+      </h4>
+
+      <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">
+        {%- else -%}
+        <a data-namespace="{{ interface.requires_namespace }}" data-link="class.{{ interface.requires_name 
}}.html" href="javascript:void(0)" class="external">
+        {%- endif -%}
+        <code>{{ interface.requires_ctype }}</code></a>.</p>
+      </div>
+    </div>
+
     {% if interface.methods %}
     <div class="methods toggle-wrapper">
       <h4 id="methods">


[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]