You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by ol...@apache.org on 2013/08/10 14:25:45 UTC
[04/22] git commit: improved javadoc
improved javadoc
Project: http://git-wip-us.apache.org/repos/asf/maven/repo
Commit: http://git-wip-us.apache.org/repos/asf/maven/commit/6065d292
Tree: http://git-wip-us.apache.org/repos/asf/maven/tree/6065d292
Diff: http://git-wip-us.apache.org/repos/asf/maven/diff/6065d292
Branch: refs/heads/guice-from-google
Commit: 6065d292dc0dc518fae2d6c772395dea3f42e539
Parents: ae8c2e4
Author: Hervé Boutemy <hb...@apache.org>
Authored: Sun Jul 28 14:08:13 2013 +0200
Committer: Olivier Lamy <ol...@apache.org>
Committed: Sat Aug 10 21:46:50 2013 +1000
----------------------------------------------------------------------
.../apache/maven/exception/ExceptionHandler.java | 5 +++++
.../apache/maven/exception/ExceptionSummary.java | 17 ++++++++++-------
2 files changed, 15 insertions(+), 7 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/maven/blob/6065d292/maven-core/src/main/java/org/apache/maven/exception/ExceptionHandler.java
----------------------------------------------------------------------
diff --git a/maven-core/src/main/java/org/apache/maven/exception/ExceptionHandler.java b/maven-core/src/main/java/org/apache/maven/exception/ExceptionHandler.java
index 4dec0ee..945edf6 100644
--- a/maven-core/src/main/java/org/apache/maven/exception/ExceptionHandler.java
+++ b/maven-core/src/main/java/org/apache/maven/exception/ExceptionHandler.java
@@ -19,6 +19,11 @@ package org.apache.maven.exception;
* under the License.
*/
+/**
+ * Transform an exception into useful end-user message.
+ *
+ * @since 3.0-alpha-3
+ */
public interface ExceptionHandler
{
ExceptionSummary handleException( Throwable e );
http://git-wip-us.apache.org/repos/asf/maven/blob/6065d292/maven-core/src/main/java/org/apache/maven/exception/ExceptionSummary.java
----------------------------------------------------------------------
diff --git a/maven-core/src/main/java/org/apache/maven/exception/ExceptionSummary.java b/maven-core/src/main/java/org/apache/maven/exception/ExceptionSummary.java
index 048698e..2b7f27b 100644
--- a/maven-core/src/main/java/org/apache/maven/exception/ExceptionSummary.java
+++ b/maven-core/src/main/java/org/apache/maven/exception/ExceptionSummary.java
@@ -22,13 +22,16 @@ package org.apache.maven.exception;
import java.util.Collections;
import java.util.List;
-// provide a
-// - the exception
-// - useful message
-// - useful reference to a solution, or set of solutions
-// - the configuration gleaned for examination
-// - plugin repositories
-
+/**
+ * Provide a summary of the exception, containing:<ul>
+ * <li>the exception itself,</li>
+ * <li>useful end-user message,</li>
+ * <li>useful reference to a solution, or set of solutions: this is usually a wiki page url in
+ * <a href="http://cwiki.apache.org/confluence/display/MAVEN/">http://cwiki.apache.org/confluence/display/MAVEN/</a>,
+ * </li>
+ * <li>child exception summaries.</li>
+ * </ul>
+ */
public class ExceptionSummary
{