Apache
/
maven
mirror of https://github.com/apache/maven.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

improved javadoc

This commit is contained in:
Hervé Boutemy 2013-07-28 14:08:13 +02:00
parent 2351cc1bb9
commit 82eba2a03f
2 changed files with 15 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
maven-core/src/main/java/org/apache/maven/exception/ExceptionHandler.java
View File

@ -19,6 +19,11 @@ package org.apache.maven.exception;
* under the License. * under the License.
*/ */
/**
* Transform an exception into useful end-user message.
*
* @since 3.0-alpha-3
*/
public interface ExceptionHandler public interface ExceptionHandler
{ {
ExceptionSummary handleException( Throwable e ); ExceptionSummary handleException( Throwable e );

17
maven-core/src/main/java/org/apache/maven/exception/ExceptionSummary.java
View File

@ -22,13 +22,16 @@ package org.apache.maven.exception;
import java.util.Collections; import java.util.Collections;
import java.util.List; import java.util.List;
// provide a /**
// - the exception * Provide a summary of the exception, containing:<ul>
// - useful message * <li>the exception itself,</li>
// - useful reference to a solution, or set of solutions * <li>useful end-user message,</li>
// - the configuration gleaned for examination * <li>useful reference to a solution, or set of solutions: this is usually a wiki page url in
// - plugin repositories * <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 public class ExceptionSummary
{ {