From 82eba2a03f90ce9b38bc1fb2b58b9b515ecd53a9 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Herv=C3=A9=20Boutemy?= <hboutemy@apache.org>
Date: Sun, 28 Jul 2013 14:08:13 +0200
Subject: [PATCH] improved javadoc

---
 .../maven/exception/ExceptionHandler.java       |  5 +++++
 .../maven/exception/ExceptionSummary.java       | 17 ++++++++++-------
 2 files changed, 15 insertions(+), 7 deletions(-)

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 4dec0ee0a0..945edf6358 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 );
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 048698ea28..2b7f27b9d0 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
 {