summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorPhilip Chimento <philip.chimento@gmail.com>2015-12-13 22:49:50 -0800
committerrockon999 <rockon999@users.noreply.github.com>2018-08-06 02:53:45 -0500
commitd69aad5810fb35a4b38796f9378787bc08a9a981 (patch)
treeb8412a6ba6a08b7bd78cf3fb0363b14c7c6cc66f
parent0a9b0d8c8d7e89f7ff639f5bc8ff3ffdc6abccb7 (diff)
downloadgobject-introspection-d69aad5810fb35a4b38796f9378787bc08a9a981.tar.gz
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.
-rw-r--r--giscanner/doctemplates/devdocs/Gjs/_method.tmpl4
1 files changed, 4 insertions, 0 deletions
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>