From 13ae5af72fca947c15e0d9f16c9c44396cc28aaa Mon Sep 17 00:00:00 2001 From: Simon Brandhof Date: Fri, 16 Aug 2013 17:57:02 +0200 Subject: [PATCH] SONAR-4547 improve javadoc of MessageException --- .../src/main/java/org/sonar/api/utils/MessageException.java | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/sonar-plugin-api/src/main/java/org/sonar/api/utils/MessageException.java b/sonar-plugin-api/src/main/java/org/sonar/api/utils/MessageException.java index fc41e59c26f..1d641633bb6 100644 --- a/sonar-plugin-api/src/main/java/org/sonar/api/utils/MessageException.java +++ b/sonar-plugin-api/src/main/java/org/sonar/api/utils/MessageException.java @@ -24,6 +24,10 @@ package org.sonar.api.utils; * like stack traces. It requires sonar-runner 2.4. Previous versions log stack trace. *

* Note that by design Maven still logs the stack trace when the option -e is set. + *

+ * Message should be clear and complete. Keep in mind that context is not added to the exception. + * Names of processed resource and decorator are for example not automatically added when throwing {@link MessageException} + * from {@link org.sonar.api.batch.Decorator}. * * @since 4.0 */ -- 2.39.5