[sling-org-apache-sling-paxexam-util] 16/18: fix javadoc errors

[ro...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

rombert pushed a commit to annotated tag org.apache.sling.paxexam.util-1.0.4
in repository https://gitbox.apache.org/repos/asf/sling-org-apache-sling-paxexam-util.git

commit b0da372a290fd928a127442141f53791cd732112
Author: Stefan Seifert <ss...@apache.org>
AuthorDate: Thu May 4 19:45:37 2017 +0000

    fix javadoc errors
    
    git-svn-id: https://svn.apache.org/repos/asf/sling/trunk/testing/sling-pax-util@1793861 13f79535-47bb-0310-9956-ffa450edef68
---
 .../apache/sling/paxexam/util/SlingPaxOptions.java | 34 +++++++++++++++-------
 1 file changed, 24 insertions(+), 10 deletions(-)

diff --git a/src/main/java/org/apache/sling/paxexam/util/SlingPaxOptions.java b/src/main/java/org/apache/sling/paxexam/util/SlingPaxOptions.java
index 5368d71..56cfdf7 100644
--- a/src/main/java/org/apache/sling/paxexam/util/SlingPaxOptions.java
+++ b/src/main/java/org/apache/sling/paxexam/util/SlingPaxOptions.java
@@ -44,11 +44,12 @@ import org.ops4j.pax.exam.options.DefaultCompositeOption;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
-/** Pax exam options and utilities to test Sling applications
- *  The basic idea is to get a vanilla Sling launchpad instance
- *  setup with a minimal amount of boilerplate code.
- *  See {@link SlingSetupTest} for an example.
- * */
+/**
+ * Pax exam options and utilities to test Sling applications
+ * The basic idea is to get a vanilla Sling launchpad instance
+ * setup with a minimal amount of boilerplate code.
+ * See SlingSetupTest for an example.
+ */
 public class SlingPaxOptions {
     private static final Logger log = LoggerFactory.getLogger(SlingPaxOptions.class);
     public static final int DEFAULT_SLING_START_LEVEL = 30;
@@ -68,8 +69,11 @@ public class SlingPaxOptions {
         return result;
     }
     
-    /** When reading bundle lists, ignore bundles which have symbolic names
-     *  starting with one of the supplied prefixes */
+    /**
+     * When reading bundle lists, ignore bundles which have symbolic names
+     * starting with one of the supplied prefixes
+     * @param symbolicNamePrefix Symbolic name prefixes
+     */
     public static void setIgnoredBundles(String ... symbolicNamePrefix) {
         if(symbolicNamePrefix == null || symbolicNamePrefix.length == 0) {
             ignoredBundlePrefixes = new String[] {};
@@ -78,13 +82,20 @@ public class SlingPaxOptions {
         }
     }
     
-    /** Get run modes to use for our tests, as set by the sling.run.modes property */
+    /**
+     * Get run modes to use for our tests, as set by the sling.run.modes property
+     * @return Run modes
+     */
     public static Collection<String> getTestRunModes() {
         final String runModes = System.getProperty("sling.run.modes", DEFAULT_RUN_MODES);
         return Arrays.asList(runModes.split(","));
     }
     
-    /** @param launchpadVersion null means use the latest */
+    /**
+     * Set default launchpad options
+     * @param launchpadVersion null means use the latest
+     * @return Composite option
+     */
     public static CompositeOption defaultLaunchpadOptions(String launchpadVersion) {
         final String paxLogLevel = System.getProperty("pax.exam.log.level", "INFO");
         
@@ -219,7 +230,10 @@ public class SlingPaxOptions {
         return slingBundleList("org.apache.sling", "org.apache.sling.launchpad", version, "xml", "bundlelist");
     }
     
-    /** @param version can be null, to use default */ 
+    /**
+     * Felix remote shell bundles
+     * @return Composite option
+     */ 
     public static CompositeOption felixRemoteShellBundles() {
         final String gogoVersion = "0.10.0";
         return new DefaultCompositeOption(

-- 
To stop receiving notification emails like this one, please contact
"commits@sling.apache.org" <co...@sling.apache.org>.