From: Florian Brosch <flo.brosch@gmail.com>
Date: Sat, 21 Jul 2012 16:14:57 +0000 (+0200)
Subject: libvaladoc/taglets: error/warning message improvements
X-Git-Tag: 0.37.1~3^2~185
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=20469451467f2234649007caef04e89b74ac9be2;p=thirdparty%2Fvala.git

libvaladoc/taglets: error/warning message improvements
---

diff --git a/src/libvaladoc/taglets/tagletdeprecated.vala b/src/libvaladoc/taglets/tagletdeprecated.vala
index f685f3fe5..0d3c19290 100644
--- a/src/libvaladoc/taglets/tagletdeprecated.vala
+++ b/src/libvaladoc/taglets/tagletdeprecated.vala
@@ -31,7 +31,7 @@ public class Valadoc.Taglets.Deprecated : InlineContent, Taglet, Block {
 
 	public override void check (Api.Tree api_root, Api.Node container, string file_path, ErrorReporter reporter, Settings settings) {
 		base.check (api_root, container, file_path, reporter, settings);
-		reporter.simple_warning ("warning: @deprecated is deprecated. Use [Deprecated]");
+		reporter.simple_warning ("%s: %s: @deprecated: warning: @deprecated is deprecated. Use [Deprecated]", file_path, container.get_full_name ());
 	}
 
 	public override void accept (ContentVisitor visitor) {
diff --git a/src/libvaladoc/taglets/tagletlink.vala b/src/libvaladoc/taglets/tagletlink.vala
index cbe8dc499..65a6fc706 100644
--- a/src/libvaladoc/taglets/tagletlink.vala
+++ b/src/libvaladoc/taglets/tagletlink.vala
@@ -73,7 +73,8 @@ public class Valadoc.Taglets.Link : InlineTaglet {
 
 		if (_symbol == null && symbol_name != "main") {
 			// TODO use ContentElement's source reference
-			reporter.simple_warning ("%s: %s does not exist", container.get_full_name (), symbol_name);
+			string node_segment = (container == null)? "" : container.get_full_name () + ": ";
+			reporter.simple_warning ("%s: %s@link: warning: %s does not exist", file_path, node_segment, symbol_name);
 		}
 
 		base.check (api_root, container, file_path, reporter, settings);
diff --git a/src/libvaladoc/taglets/tagletparam.vala b/src/libvaladoc/taglets/tagletparam.vala
index bbff4030b..36a21eb6b 100644
--- a/src/libvaladoc/taglets/tagletparam.vala
+++ b/src/libvaladoc/taglets/tagletparam.vala
@@ -70,7 +70,7 @@ public class Valadoc.Taglets.Param : InlineContent, Taglet, Block {
 		}
 
 		if (this.parameter == null) {
-			reporter.simple_warning ("%s: Unknown parameter `%s'", container.get_full_name (), parameter_name);
+			reporter.simple_warning ("%s: %s: @param: warning: Unknown parameter `%s'", file_path, container.get_full_name (), parameter_name);
 		}
 
 		base.check (api_root, container, file_path, reporter, settings);
diff --git a/src/libvaladoc/taglets/tagletreturn.vala b/src/libvaladoc/taglets/tagletreturn.vala
index 8a8e0640b..163f0ba53 100644
--- a/src/libvaladoc/taglets/tagletreturn.vala
+++ b/src/libvaladoc/taglets/tagletreturn.vala
@@ -39,11 +39,11 @@ public class Valadoc.Taglets.Return : InlineContent, Taglet, Block {
 		} else if (container is Api.Signal) {
 			type_ref = ((Api.Signal) container).return_type;
 		} else {
-			reporter.simple_warning ("@return used outside method/delegate/signal context");
+			reporter.simple_warning ("%s: %s: @return: warning: @return used outside method/delegate/signal context", file_path, container.get_full_name ());
 		}
 
 		if (type_ref != null && type_ref.data_type == null) {
-			reporter.simple_warning ("Return description declared for void function");
+			reporter.simple_warning ("%s: %s: @return: warning: Return description declared for void function", file_path, container.get_full_name ());
 		}
 
 		base.check (api_root, container, file_path, reporter, settings);
diff --git a/src/libvaladoc/taglets/tagletsee.vala b/src/libvaladoc/taglets/tagletsee.vala
index 895e3c2a2..fe8f799b5 100644
--- a/src/libvaladoc/taglets/tagletsee.vala
+++ b/src/libvaladoc/taglets/tagletsee.vala
@@ -52,7 +52,7 @@ public class Valadoc.Taglets.See : ContentElement, Taglet, Block {
 
 		if (symbol == null) {
 			// TODO use ContentElement's source reference
-			reporter.simple_warning ("%s does not exist", symbol_name);
+			reporter.simple_warning ("%s: %s: @see: warning: %s does not exist", file_path, container.get_full_name (), symbol_name);
 		}
 	}
 
diff --git a/src/libvaladoc/taglets/tagletthrows.vala b/src/libvaladoc/taglets/tagletthrows.vala
index 413662475..d833883d4 100644
--- a/src/libvaladoc/taglets/tagletthrows.vala
+++ b/src/libvaladoc/taglets/tagletthrows.vala
@@ -39,7 +39,7 @@ public class Valadoc.Taglets.Throws : InlineContent, Taglet, Block {
 	public override void check (Api.Tree api_root, Api.Node container, string file_path, ErrorReporter reporter, Settings settings) {
 		// context check:
 		if (container is Api.Method == false && container is Api.Delegate == false) {
-			reporter.simple_warning ("@throws used outside method/delegate context");
+			reporter.simple_warning ("%s: %s: @throws: warning: @throws used outside method/delegate context", file_path, container.get_full_name ());
 			base.check (api_root, container, file_path, reporter, settings);
 			return ;
 		}
@@ -49,7 +49,7 @@ public class Valadoc.Taglets.Throws : InlineContent, Taglet, Block {
 		error_domain = api_root.search_symbol_str (container, error_domain_name);
 		if (error_domain == null) {
 			// TODO use ContentElement's source reference
-			reporter.simple_error ("%s: %s does not exist", container.get_full_name (), error_domain_name);
+			reporter.simple_error ("%s: %s: @throws: warning: %s does not exist", file_path, container.get_full_name (), error_domain_name);
 			base.check (api_root, container, file_path, reporter, settings);
 			return ;
 		}
@@ -65,7 +65,7 @@ public class Valadoc.Taglets.Throws : InlineContent, Taglet, Block {
 			}
 		}
 		if (report_warning) {
-			reporter.simple_warning ("%s: @throws: %s does not exist in exception list", container.get_full_name (), error_domain_name);			
+			reporter.simple_warning ("%s: %s: @throws: warning: %s does not exist in exception list", file_path, container.get_full_name (), error_domain_name);			
 		}
 
 		base.check (api_root, container, file_path, reporter, settings);