1 files changed, 78 insertions, 0 deletions
diff --git a/libvaladoc/taglets/tagletreturn.vala b/libvaladoc/taglets/tagletreturn.vala
new file mode 100644
index 000000000..691a4a31f
--- /dev/null
+++ b/libvaladoc/taglets/tagletreturn.vala
@@ -0,0 +1,78 @@
+/* taglet.vala
+ *
+ * Copyright (C) 2008-2009 Didier Villevalois
+ * Copyright (C) 2008-2012 Florian Brosch
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 2.1 of the License, or (at your option) any later version.
+ *
+ * This library is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this library; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301  USA
+ *
+ * Author:
+ * 	Didier 'Ptitjes Villevalois <ptitjes@free.fr>
+ */
+
+
+using Valadoc.Content;
+
+public class Valadoc.Taglets.Return : BlockContent, Taglet, Block {
+	public Rule? get_parser_rule (Rule run_rule) {
+		return run_rule;
+	}
+
+	public override void check (Api.Tree api_root, Api.Node container, string file_path,
+								ErrorReporter reporter, Settings settings) {
+		Api.TypeReference? type_ref = null;
+		bool creation_method = false;
+
+		if (container is Api.Method) {
+			creation_method = ((Api.Method) container).is_constructor;
+			type_ref = ((Api.Method) container).return_type;
+		} else if (container is Api.Callable) {
+			type_ref = ((Api.Callable) container).return_type;
+		} else {
+			reporter.simple_warning ("%s: %s: @return".printf (file_path, container.get_full_name ()),
+									 "@return used outside method/delegate/signal context");
+		}
+
+		if (type_ref != null && type_ref.data_type == null && !creation_method) {
+			reporter.simple_warning ("%s: %s: @return".printf (file_path, container.get_full_name ()),
+									 "Return description declared for void function");
+		}
+
+		base.check (api_root, container, file_path, reporter, settings);
+	}
+
+	public override void accept (ContentVisitor visitor) {
+		visitor.visit_taglet (this);
+	}
+
+	public Vala.List<ContentElement>? get_inheritable_documentation () {
+		return content;
+	}
+
+	public bool inheritable (Taglet taglet) {
+		return taglet is Taglets.Return;
+	}
+
+	public override ContentElement copy (ContentElement? new_parent = null) {
+		Return ret = new Return ();
+		ret.parent = new_parent;
+
+		foreach (Block element in content) {
+			Block copy = element.copy (ret) as Block;
+			ret.content.add (copy);
+		}
+
+		return ret;
+	}
+}