You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@sling.apache.org by ro...@apache.org on 2023/11/10 14:09:51 UTC

(sling-org-apache-sling-launchpad-test-services) 02/02: chore: fix javadoc

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

rombert pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/sling-org-apache-sling-launchpad-test-services.git

commit 12d47036c5603a03f45357778fd2c478c000a28d
Author: Robert Munteanu <ro...@apache.org>
AuthorDate: Fri Nov 10 15:01:25 2023 +0100

    chore: fix javadoc
---
 .../sling/launchpad/testservices/exported/MappingsFacade.java       | 2 ++
 .../launchpad/testservices/serversidetests/MappingEventsTest.java   | 6 +++++-
 .../apache/sling/launchpad/testservices/servlets/DomServlet.java    | 2 +-
 .../apache/sling/launchpad/testservices/servlets/JaxbServlet.java   | 2 +-
 .../sling/launchpad/testservices/servlets/MiscUnsafeServlet.java    | 2 +-
 .../apache/sling/launchpad/testservices/servlets/SaxServlet.java    | 2 +-
 .../apache/sling/launchpad/testservices/servlets/XpathServlet.java  | 2 +-
 7 files changed, 12 insertions(+), 6 deletions(-)

diff --git a/src/main/java/org/apache/sling/launchpad/testservices/exported/MappingsFacade.java b/src/main/java/org/apache/sling/launchpad/testservices/exported/MappingsFacade.java
index 6ee2a74..997f4a1 100644
--- a/src/main/java/org/apache/sling/launchpad/testservices/exported/MappingsFacade.java
+++ b/src/main/java/org/apache/sling/launchpad/testservices/exported/MappingsFacade.java
@@ -44,7 +44,9 @@ public class MappingsFacade {
     
     /** Save a Session that has mapping changes, and wait for the OSGi event
      *  that signals that mappings have been updated.
+     *  @param session the JCR session
      *  @return error message, null if ok
+     *  @throws Exception in case of any errors
      */
     public String saveMappings(Session session) throws Exception {
         final int oldEventsCount = eventsCounter.getEventsCount(MAPPING_EVENT_TOPIC);
diff --git a/src/main/java/org/apache/sling/launchpad/testservices/serversidetests/MappingEventsTest.java b/src/main/java/org/apache/sling/launchpad/testservices/serversidetests/MappingEventsTest.java
index 4c78438..2d9a15b 100644
--- a/src/main/java/org/apache/sling/launchpad/testservices/serversidetests/MappingEventsTest.java
+++ b/src/main/java/org/apache/sling/launchpad/testservices/serversidetests/MappingEventsTest.java
@@ -101,7 +101,11 @@ public class MappingEventsTest {
         }
     }
     
-    /** Test SLING-4058 - unexpected timeouts in saveMappings */
+    /** 
+     * Test SLING-4058 - unexpected timeouts in saveMappings
+     *
+     * @throws Exception in case of any problems
+     */
     @Test public void testSaveMappings() throws Exception {
         final Node base = mapRoot.getNode("map/https/localhost.443");
         final MappingsFacade f = new MappingsFacade(eventsCounter);
diff --git a/src/main/java/org/apache/sling/launchpad/testservices/servlets/DomServlet.java b/src/main/java/org/apache/sling/launchpad/testservices/servlets/DomServlet.java
index b35eb25..9f8120c 100644
--- a/src/main/java/org/apache/sling/launchpad/testservices/servlets/DomServlet.java
+++ b/src/main/java/org/apache/sling/launchpad/testservices/servlets/DomServlet.java
@@ -37,7 +37,7 @@ import org.xml.sax.InputSource;
 import org.xml.sax.SAXException;
 
 /**
- * The <tt>DomServlet</tt> evaluates a simple XML document using DOM APIs.
+ * The <code>DomServlet</code> evaluates a simple XML document using DOM APIs.
  * 
  */
 @Component(service=Servlet.class)
diff --git a/src/main/java/org/apache/sling/launchpad/testservices/servlets/JaxbServlet.java b/src/main/java/org/apache/sling/launchpad/testservices/servlets/JaxbServlet.java
index 9ec1146..58e5738 100644
--- a/src/main/java/org/apache/sling/launchpad/testservices/servlets/JaxbServlet.java
+++ b/src/main/java/org/apache/sling/launchpad/testservices/servlets/JaxbServlet.java
@@ -34,7 +34,7 @@ import org.apache.sling.servlets.annotations.SlingServletPathsStrict;
 import org.osgi.service.component.annotations.Component;
 
 /**
- * The <tt>JaxbServlet</tt> serializes a basic JAXB-annotated class
+ * The <code>JaxbServlet</code> serializes a basic JAXB-annotated class
  * 
  */
 @Component(service=Servlet.class)
diff --git a/src/main/java/org/apache/sling/launchpad/testservices/servlets/MiscUnsafeServlet.java b/src/main/java/org/apache/sling/launchpad/testservices/servlets/MiscUnsafeServlet.java
index 7b847b3..4f20d1a 100644
--- a/src/main/java/org/apache/sling/launchpad/testservices/servlets/MiscUnsafeServlet.java
+++ b/src/main/java/org/apache/sling/launchpad/testservices/servlets/MiscUnsafeServlet.java
@@ -30,7 +30,7 @@ import org.apache.sling.servlets.annotations.SlingServletPathsStrict;
 import org.osgi.service.component.annotations.Component;
 
 /**
- * Validates that the <tt>sun.misc.Unsafe</tt> class can be accessed
+ * Validates that the <code>sun.misc.Unsafe</code> class can be accessed
  *
  */
 @Component(service=Servlet.class)
diff --git a/src/main/java/org/apache/sling/launchpad/testservices/servlets/SaxServlet.java b/src/main/java/org/apache/sling/launchpad/testservices/servlets/SaxServlet.java
index 6a88c34..db40e93 100644
--- a/src/main/java/org/apache/sling/launchpad/testservices/servlets/SaxServlet.java
+++ b/src/main/java/org/apache/sling/launchpad/testservices/servlets/SaxServlet.java
@@ -38,7 +38,7 @@ import org.xml.sax.SAXException;
 import org.xml.sax.helpers.DefaultHandler;
 
 /**
- * The <tt>SaxServlet</tt> evaluates a simple XML document using a SAX handler
+ * The <code>SaxServlet</code> evaluates a simple XML document using a SAX handler
  * 
  */
 @Component(service=Servlet.class)
diff --git a/src/main/java/org/apache/sling/launchpad/testservices/servlets/XpathServlet.java b/src/main/java/org/apache/sling/launchpad/testservices/servlets/XpathServlet.java
index edf516b..02ac98e 100644
--- a/src/main/java/org/apache/sling/launchpad/testservices/servlets/XpathServlet.java
+++ b/src/main/java/org/apache/sling/launchpad/testservices/servlets/XpathServlet.java
@@ -35,7 +35,7 @@ import org.osgi.service.component.annotations.Component;
 import org.xml.sax.InputSource;
 
 /**
- * The <tt>XpathServlet</tt> evaluates a simple XML document using an XPath expression
+ * The <code>XpathServlet</code> evaluates a simple XML document using an XPath expression
  * 
  */
 @Component(service=Servlet.class)