diff options
| author | Simon Brandhof <simon.brandhof@gmail.com> | 2013-08-16 17:57:02 +0200 |
|---|---|---|
| committer | Simon Brandhof <simon.brandhof@gmail.com> | 2013-08-16 17:57:02 +0200 |
| commit | 13ae5af72fca947c15e0d9f16c9c44396cc28aaa (patch) | |
| tree | 13c5a656be6fe24268d23da283cc2bb2b6a68f15 /sonar-plugin-api/src | |
| parent | 5793d47116097bbae05cd8811187ca1a0b362551 (diff) | |
| download | sonarqube-13ae5af72fca947c15e0d9f16c9c44396cc28aaa.tar.gz sonarqube-13ae5af72fca947c15e0d9f16c9c44396cc28aaa.zip | |
SONAR-4547 improve javadoc of MessageException
Diffstat (limited to 'sonar-plugin-api/src')
| -rw-r--r-- | sonar-plugin-api/src/main/java/org/sonar/api/utils/MessageException.java | 4 |
1 files changed, 4 insertions, 0 deletions
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. * <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 */ |