[sling-org-apache-sling-testing-resourceresolver-mock] 23/25: fix some javadoc errors/warnings

[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.testing.resourceresolver-mock-1.1.0
in repository https://gitbox.apache.org/repos/asf/sling-org-apache-sling-testing-resourceresolver-mock.git

commit 5e9bdd97ae322a69279dcac5e064f5da64951a1d
Author: Stefan Seifert <ss...@apache.org>
AuthorDate: Tue Dec 9 23:01:37 2014 +0000

    fix some javadoc errors/warnings
    
    git-svn-id: https://svn.apache.org/repos/asf/sling/trunk/testing/mocks/resourceresolver-mock@1644220 13f79535-47bb-0310-9956-ffa450edef68
---
 .../sling/testing/resourceresolver/MockHelper.java     | 18 ++++++++++++------
 .../resourceresolver/MockResourceResolverFactory.java  |  6 ++++--
 2 files changed, 16 insertions(+), 8 deletions(-)

diff --git a/src/main/java/org/apache/sling/testing/resourceresolver/MockHelper.java b/src/main/java/org/apache/sling/testing/resourceresolver/MockHelper.java
index c4995ff..18508d8 100644
--- a/src/main/java/org/apache/sling/testing/resourceresolver/MockHelper.java
+++ b/src/main/java/org/apache/sling/testing/resourceresolver/MockHelper.java
@@ -49,16 +49,19 @@ public class MockHelper {
 
     /**
      * Create a new helper
+     * @param resolver Resource resolver
+     * @return this
      */
     public static MockHelper create(final ResourceResolver resolver) {
         return new MockHelper(resolver);
     }
 
     /**
-     * Add a new resource
+     * Add a new resource.
      * If the path is relative, this resource is added as a child to the previous resource.
-     * If the path is relative and starts with a dot, this resource is added as a peer to
-     * the previous resource.
+     * If the path is relative and starts with a dot, this resource is added as a peer to the previous resource.
+     * @param path Resource path
+     * @return this
      */
     public MockHelper resource(final String path) {
         final String fullPath;
@@ -80,6 +83,9 @@ public class MockHelper {
 
     /**
      * Add a property to the current resource
+     * @param name Property name
+     * @param value Property value
+     * @return this
      */
     public MockHelper p(final String name, final Object value) {
         final Description d = this.stack.peek();
@@ -90,6 +96,7 @@ public class MockHelper {
 
     /**
      * Finish building and add all resources to the resource tree.
+     * @throws PersistenceException Persistence exception
      */
     public void add() throws PersistenceException {
         for(int i=0; i<this.stack.size(); i++) {
@@ -100,9 +107,8 @@ public class MockHelper {
     }
 
     /**
-     * Finish building, add all resources to the resource tree and commit
-     * changes.
-     * @throws PersistenceException
+     * Finish building, add all resources to the resource tree and commit changes.
+     * @throws PersistenceException Persistence exception
      */
     public void commit() throws PersistenceException {
         this.add();
diff --git a/src/main/java/org/apache/sling/testing/resourceresolver/MockResourceResolverFactory.java b/src/main/java/org/apache/sling/testing/resourceresolver/MockResourceResolverFactory.java
index c9cd719..8046d74 100644
--- a/src/main/java/org/apache/sling/testing/resourceresolver/MockResourceResolverFactory.java
+++ b/src/main/java/org/apache/sling/testing/resourceresolver/MockResourceResolverFactory.java
@@ -55,6 +55,7 @@ public class MockResourceResolverFactory implements ResourceResolverFactory {
 
     /**
      * Create a new resource resolver factory.
+     * @param options Options
      */
     public MockResourceResolverFactory(final MockResourceResolverFactoryOptions options) {
         this.options = options;
@@ -111,11 +112,12 @@ public class MockResourceResolverFactory implements ResourceResolverFactory {
     /**
      * Inform about a closed resource resolver.
      * Make sure to remove it from the current thread context.
+     * @param resolver Resource resolver
      */
-    public void closed(final ResourceResolver resourceResolverImpl) {
+    public void closed(final ResourceResolver resolver) {
         final Stack<ResourceResolver> resolverStack = resolverStackHolder.get();
         if ( resolverStack != null ) {
-            resolverStack.remove(resourceResolverImpl);
+            resolverStack.remove(resolver);
         }
     }
 }

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