SLING-4677 clarify javadoc on debugging options
git-svn-id: https://svn.apache.org/repos/asf/sling/trunk@1743389 13f79535-47bb-0310-9956-ffa450edef68
diff --git a/src/main/java/org/apache/sling/maven/slingstart/run/ServerConfiguration.java b/src/main/java/org/apache/sling/maven/slingstart/run/ServerConfiguration.java
index 7fe781a..8aa00fc 100644
--- a/src/main/java/org/apache/sling/maven/slingstart/run/ServerConfiguration.java
+++ b/src/main/java/org/apache/sling/maven/slingstart/run/ServerConfiguration.java
@@ -49,7 +49,11 @@
/** The vm options. */
private String vmOpts = DEFAULT_VM_OPTS;
- /** Attach a debugger to the forked JVM. If set to "true", the process will allow a debugger to attach on port 8000. If set to some other string, that string will be appended to the vmOpts, allowing you to configure arbitrary debuggability options (without overwriting the other options specified through the vmOpts parameter).*/
+ /**
+ * If set to {@code "true"}, the process will allow a debugger to connect on port 8000.
+ * If set to some other string, that string will be appended to this server's {@code vmOpts}, allowing you to configure arbitrary debugging options.
+ * If the global configuration property {@link StartMojo#debug} is set on the mojo itself, it will be used instead.
+ */
private String debug;
/** Additional application options. */
diff --git a/src/main/java/org/apache/sling/maven/slingstart/run/StartMojo.java b/src/main/java/org/apache/sling/maven/slingstart/run/StartMojo.java
index f8dd965..928204f 100644
--- a/src/main/java/org/apache/sling/maven/slingstart/run/StartMojo.java
+++ b/src/main/java/org/apache/sling/maven/slingstart/run/StartMojo.java
@@ -77,7 +77,8 @@
/**
* Overwrites debug parameter of all server configurations (if set).
- * Attaches a debugger to the forked JVM. If set to "true", the process will allow a debugger to attach on port 8000. If set to some other string, that string will be appended to the vmOpts, allowing you to configure arbitrary debuggability options (without overwriting the other options specified through the vmOpts parameter of the servers).
+ * Attaches a debugger to the forked JVM. If set to {@code "true"}, the process will allow a debugger to connect on port 8000.
+ * If set to some other string, that string will be appended to the server's {@code vmOpts}, allowing you to configure arbitrary debugging options.
*/
@Parameter(property = "launchpad.debug")
protected String debug;
