[sling-org-apache-sling-resourcecollection] 06/31: SLING-2853 - tweak javadocs

[ro...@apache.org]

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-resourcecollection.git

commit b7439569f26fea0217218fba5240e66e8a10ba75
Author: Bertrand Delacretaz <bd...@apache.org>
AuthorDate: Mon May 6 09:05:30 2013 +0000

    SLING-2853 - tweak javadocs
    
    git-svn-id: https://svn.apache.org/repos/asf/sling/trunk@1479500 13f79535-47bb-0310-9956-ffa450edef68
---
 .../apache/sling/resource/collection/ResourceCollection.java  | 11 ++++++-----
 .../sling/resource/collection/ResourceCollectionManager.java  |  5 ++---
 2 files changed, 8 insertions(+), 8 deletions(-)

diff --git a/src/main/java/org/apache/sling/resource/collection/ResourceCollection.java b/src/main/java/org/apache/sling/resource/collection/ResourceCollection.java
index b1a4f6f..ad0b257 100755
--- a/src/main/java/org/apache/sling/resource/collection/ResourceCollection.java
+++ b/src/main/java/org/apache/sling/resource/collection/ResourceCollection.java
@@ -17,7 +17,6 @@
  * under the License.
  */
 
-
 package org.apache.sling.resource.collection;
 import java.util.Iterator;
 import java.util.Map;
@@ -27,10 +26,13 @@ import org.apache.sling.api.resource.PersistenceException;
 import org.apache.sling.api.resource.Resource;
 
 /**
- * ResourceCollection is an ordered collection of resources. Actual resources are not stored inside the collection.
+ * ResourceCollection is an ordered collection of {@link Resource}. 
+ * The collection does not store the actual Resources, it only points to
+ * them. 
  * 
- * Each entry in a collection is represented as a resource, which contain a reference to original resource
- * and it can have additional properties i.e. creationDate.
+ * Each entry in the collection is represented by a Resource which contains a 
+ * reference to original resource. That reference Resource can have additional 
+ * properties (creationDate, etc.)
  */
 public interface ResourceCollection {
     
@@ -76,7 +78,6 @@ public interface ResourceCollection {
      */
     boolean contains(Resource resource);
     
-    
     /**
      * Creates a new entry in the collection at the last position and add a reference to resource 
      * in the entry.  
diff --git a/src/main/java/org/apache/sling/resource/collection/ResourceCollectionManager.java b/src/main/java/org/apache/sling/resource/collection/ResourceCollectionManager.java
index 290e6d7..d6c4093 100755
--- a/src/main/java/org/apache/sling/resource/collection/ResourceCollectionManager.java
+++ b/src/main/java/org/apache/sling/resource/collection/ResourceCollectionManager.java
@@ -17,7 +17,6 @@
  * under the License.
  */
 
-
 package org.apache.sling.resource.collection;
 
 import java.util.Map;
@@ -28,9 +27,9 @@ import org.apache.sling.api.resource.ResourceResolver;
 
 /**
  * The <code>ResourceCollectionManager<code> defines the API to get, create and delete
- * resource collection {@link org.apache.sling.resource.collection.ResourceCollection}.
+ * resource collections {@link org.apache.sling.resource.collection.ResourceCollection}.
  * 
- * A ResourceCollectionManager instance can be retrieved by adapting ResourceResolver. 
+ * A ResourceCollectionManager instance can be retrieved by adapting a {@link ResourceResolver}. 
  */
 public interface ResourceCollectionManager {
     

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