[valadoc] doclet/gtkdoc: Implement @throws taglet in the gtk-doc comment converter
- From: Florian Brosch <flobrosch src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [valadoc] doclet/gtkdoc: Implement @throws taglet in the gtk-doc comment converter
- Date: Fri, 17 Aug 2012 23:24:24 +0000 (UTC)
commit 8c3c869986caeaa8342cbe814eba4becd8f089d2
Author: Philip Withnall <philip tecnocode co uk>
Date: Tue Aug 14 23:58:13 2012 +0200
doclet/gtkdoc: Implement @throws taglet in the gtk-doc comment converter
This now appends a paragraph to the gtk-doc comment explaining that
particular throw value and description.
src/doclets/gtkdoc/commentconverter.vala | 4 ++++
1 files changed, 4 insertions(+), 0 deletions(-)
---
diff --git a/src/doclets/gtkdoc/commentconverter.vala b/src/doclets/gtkdoc/commentconverter.vala
index b585a0d..3b90d48 100644
--- a/src/doclets/gtkdoc/commentconverter.vala
+++ b/src/doclets/gtkdoc/commentconverter.vala
@@ -277,6 +277,10 @@ public class Gtkdoc.CommentConverter : ContentVisitor {
this.see_also = see_also;
} else if (t is Taglets.Link) {
((Taglets.Link)t).produce_content().accept (this);
+ } else if (t is Taglets.Throws) {
+ var taglet = (Taglets.Throws) t;
+ var link = get_docbook_link (taglet.error_domain) ?? taglet.error_domain_name;
+ old_builder.append_printf ("\n<para>%s will be returned in @error %s</para>", link, current_builder.str);
} else {
reporter.simple_warning ("GtkDoc: warning: Taglet not supported"); // TODO
}
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]