SONAR-4547 improve javadoc of MessageException

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 fc41e59c26fdd6cafbd14172b6c0558a040e7475..1d641633bb655314389e0f0e6510182fd11e1eda 100644 (file)
--- 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.
  * <p/>
  * Note that by design Maven still logs the stack trace when the option -e is set.
+ * <p/>
+ * 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
  */