Author: kwin
Date: Wed May 11 15:21:20 2016
New Revision: 1743389

URL: http://svn.apache.org/viewvc?rev=1743389&view=rev
Log:
SLING-4677 clarify javadoc on debugging options

Modified:
    
sling/trunk/tooling/maven/slingstart-maven-plugin/src/main/java/org/apache/sling/maven/slingstart/run/ServerConfiguration.java
    
sling/trunk/tooling/maven/slingstart-maven-plugin/src/main/java/org/apache/sling/maven/slingstart/run/StartMojo.java

Modified: 
sling/trunk/tooling/maven/slingstart-maven-plugin/src/main/java/org/apache/sling/maven/slingstart/run/ServerConfiguration.java
URL: 
http://svn.apache.org/viewvc/sling/trunk/tooling/maven/slingstart-maven-plugin/src/main/java/org/apache/sling/maven/slingstart/run/ServerConfiguration.java?rev=1743389&r1=1743388&r2=1743389&view=diff
==============================================================================
--- 
sling/trunk/tooling/maven/slingstart-maven-plugin/src/main/java/org/apache/sling/maven/slingstart/run/ServerConfiguration.java
 (original)
+++ 
sling/trunk/tooling/maven/slingstart-maven-plugin/src/main/java/org/apache/sling/maven/slingstart/run/ServerConfiguration.java
 Wed May 11 15:21:20 2016
@@ -49,7 +49,11 @@ public class ServerConfiguration impleme
     /** 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. */

Modified: 
sling/trunk/tooling/maven/slingstart-maven-plugin/src/main/java/org/apache/sling/maven/slingstart/run/StartMojo.java
URL: 
http://svn.apache.org/viewvc/sling/trunk/tooling/maven/slingstart-maven-plugin/src/main/java/org/apache/sling/maven/slingstart/run/StartMojo.java?rev=1743389&r1=1743388&r2=1743389&view=diff
==============================================================================
--- 
sling/trunk/tooling/maven/slingstart-maven-plugin/src/main/java/org/apache/sling/maven/slingstart/run/StartMojo.java
 (original)
+++ 
sling/trunk/tooling/maven/slingstart-maven-plugin/src/main/java/org/apache/sling/maven/slingstart/run/StartMojo.java
 Wed May 11 15:21:20 2016
@@ -77,7 +77,8 @@ public class StartMojo extends AbstractM
     
     /**
      * 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;


Reply via email to