[gobject-introspection: 20/30] devdocs: Mention when a function throws an error



commit d69aad5810fb35a4b38796f9378787bc08a9a981
Author: Philip Chimento <philip chimento gmail com>
Date:   Sun Dec 13 22:49:50 2015 -0800

    devdocs: Mention when a function throws an error
    
    This uses the "throws" annotation in the generated docs, adding a "Throws
    exception: Yes" if the annotation is present.

 giscanner/doctemplates/devdocs/Gjs/_method.tmpl | 4 ++++
 1 file changed, 4 insertions(+)
---
diff --git a/giscanner/doctemplates/devdocs/Gjs/_method.tmpl b/giscanner/doctemplates/devdocs/Gjs/_method.tmpl
index 59e9ab8b..6619eb9e 100644
--- a/giscanner/doctemplates/devdocs/Gjs/_method.tmpl
+++ b/giscanner/doctemplates/devdocs/Gjs/_method.tmpl
@@ -47,6 +47,10 @@
         </ul>
       </dd>
     % endif
+    % if m.throws:
+      <dt>Throws exception:</dt>
+      <dd>Yes</dd>
+    % endif
   </dl>
 </%def>
 


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