From 020a1f2a44183a7edb96c417de3b88bc6cbff400 Mon Sep 17 00:00:00 2001
From: dlukyanov <dlukyanov@ukr.net>
Date: Sun, 12 Nov 2017 14:12:12 +0200
Subject: [PATCH] [NIFI-3688] fix javadoc comments

---
 .../nifi/processors/groovyx/util/Files.java       |  1 -
 .../nifi/processors/groovyx/util/Throwables.java  | 15 +++++++++++----
 2 files changed, 11 insertions(+), 5 deletions(-)

diff --git a/nifi-nar-bundles/nifi-groovyx-bundle/nifi-groovyx-processors/src/main/java/org/apache/nifi/processors/groovyx/util/Files.java b/nifi-nar-bundles/nifi-groovyx-bundle/nifi-groovyx-processors/src/main/java/org/apache/nifi/processors/groovyx/util/Files.java
index e110f8e718..88495153fc 100644
--- a/nifi-nar-bundles/nifi-groovyx-bundle/nifi-groovyx-processors/src/main/java/org/apache/nifi/processors/groovyx/util/Files.java
+++ b/nifi-nar-bundles/nifi-groovyx-bundle/nifi-groovyx-processors/src/main/java/org/apache/nifi/processors/groovyx/util/Files.java
@@ -31,7 +31,6 @@ public class Files {
 
     /**
      * Classpath list separated by semicolon. You can use masks like `*`, `*.jar` in file name.
-     * Please avoid using this parameter because of deploy complexity :)
      *
      * @return file list defined by classpath parameter
      */
diff --git a/nifi-nar-bundles/nifi-groovyx-bundle/nifi-groovyx-processors/src/main/java/org/apache/nifi/processors/groovyx/util/Throwables.java b/nifi-nar-bundles/nifi-groovyx-bundle/nifi-groovyx-processors/src/main/java/org/apache/nifi/processors/groovyx/util/Throwables.java
index cc96c92654..b8df10f0f3 100644
--- a/nifi-nar-bundles/nifi-groovyx-bundle/nifi-groovyx-processors/src/main/java/org/apache/nifi/processors/groovyx/util/Throwables.java
+++ b/nifi-nar-bundles/nifi-groovyx-bundle/nifi-groovyx-processors/src/main/java/org/apache/nifi/processors/groovyx/util/Throwables.java
@@ -24,7 +24,7 @@ import java.io.PrintWriter;
  * Class with helper to return simplified human readable error message with one main `at` code position.
  */
 public class Throwables {
-
+	/** returns stacktrace as a String */
     public static String stringStackTrace(Throwable e) {
         StringWriter sw = new StringWriter(500);
         PrintWriter pw = new PrintWriter(sw);
@@ -34,15 +34,22 @@ public class Throwables {
         return sw.toString();
     }
 
-    /*================> User Input Format And Parse <==================*/
-
     /**
-     * returns error message with selected line from stacktrace:
+     * returns error message with one main line from stacktrace
      */
     public static String getMessage(Throwable e) {
         return getMessage(e, null, -1);
     }
 
+    /**
+     * returns human readable error message with only one element from stacktrace. 
+     * The parameter `priority` could identify the stacktrace element.
+     * To find stacktrace element tries to find `priority`, 
+     * then any non-standard java/groovy class.
+     * @param e throwable to convert to message
+     * @param priority package name, class, or object that could identify the stacktrace element
+     * @param maxlen the max length of returned string or -1 for unlimited
+     */
     public static String getMessage(Throwable e, Object priority, int maxlen) {
 
         if (e == null) {