[gi-docgen/ebassi/introspectable: 1/3] template: Note functions that are not introspectable




commit 74759b6aed6960b846d1329d99f3614414d227a0
Author: Emmanuele Bassi <ebassi gnome org>
Date:   Wed Feb 9 15:37:21 2022 +0000

    template: Note functions that are not introspectable
    
    People using language bindings might end up in the C API reference, so it
    would be nice to tell them that non-introspectable symbols might not be
    available through bindings.

 gidocgen/templates/basic/class_method.html | 3 +++
 gidocgen/templates/basic/ctor.html         | 3 +++
 gidocgen/templates/basic/function.html     | 3 +++
 gidocgen/templates/basic/method.html       | 3 +++
 4 files changed, 12 insertions(+)
---
diff --git a/gidocgen/templates/basic/class_method.html b/gidocgen/templates/basic/class_method.html
index a628eca..1573d7e 100644
--- a/gidocgen/templates/basic/class_method.html
+++ b/gidocgen/templates/basic/class_method.html
@@ -77,6 +77,9 @@ SPDX-License-Identifier: Apache-2.0 OR GPL-3.0-or-later
           <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>
       </div>
 
diff --git a/gidocgen/templates/basic/ctor.html b/gidocgen/templates/basic/ctor.html
index 038ee40..d4d380c 100644
--- a/gidocgen/templates/basic/ctor.html
+++ b/gidocgen/templates/basic/ctor.html
@@ -79,6 +79,9 @@ SPDX-License-Identifier: Apache-2.0 OR GPL-3.0-or-later
           <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>
       </div>
 
diff --git a/gidocgen/templates/basic/function.html b/gidocgen/templates/basic/function.html
index 0d41008..15dae65 100644
--- a/gidocgen/templates/basic/function.html
+++ b/gidocgen/templates/basic/function.html
@@ -84,6 +84,9 @@ SPDX-License-Identifier: Apache-2.0 OR GPL-3.0-or-later
           <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 %}
         </table>
       </div>
 
diff --git a/gidocgen/templates/basic/method.html b/gidocgen/templates/basic/method.html
index b993f5e..6f7c177 100644
--- a/gidocgen/templates/basic/method.html
+++ b/gidocgen/templates/basic/method.html
@@ -79,6 +79,9 @@ SPDX-License-Identifier: Apache-2.0 OR GPL-3.0-or-later
           <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 %}
         </table>
       </div>
 


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