svn commit: r1781725 - in /sling/trunk/contrib/extensions/resourcemerger/src/main/java/org/apache/sling/resourcemerger: impl/MergingResourceProvider.java spi/MergedResourcePicker.java

[kw...@apache.org]

Author: kwin
Date: Sun Feb  5 09:04:06 2017
New Revision: 1781725

URL: http://svn.apache.org/viewvc?rev=1781725&view=rev
Log:
fix some javadoc

Modified:
    sling/trunk/contrib/extensions/resourcemerger/src/main/java/org/apache/sling/resourcemerger/impl/MergingResourceProvider.java
    sling/trunk/contrib/extensions/resourcemerger/src/main/java/org/apache/sling/resourcemerger/spi/MergedResourcePicker.java

Modified: sling/trunk/contrib/extensions/resourcemerger/src/main/java/org/apache/sling/resourcemerger/impl/MergingResourceProvider.java
URL: http://svn.apache.org/viewvc/sling/trunk/contrib/extensions/resourcemerger/src/main/java/org/apache/sling/resourcemerger/impl/MergingResourceProvider.java?rev=1781725&r1=1781724&r2=1781725&view=diff
==============================================================================
--- sling/trunk/contrib/extensions/resourcemerger/src/main/java/org/apache/sling/resourcemerger/impl/MergingResourceProvider.java (original)
+++ sling/trunk/contrib/extensions/resourcemerger/src/main/java/org/apache/sling/resourcemerger/impl/MergingResourceProvider.java Sun Feb  5 09:04:06 2017
@@ -83,7 +83,7 @@ public class MergingResourceProvider ext
         /**
          * 
          * @param parent the underlying resource
-         * @param traverseParent
+         * @param traverseParent if true will also continue with the parent's parent recursively
          */
         public ParentHidingHandler(final Resource parent, final boolean traverseParent) {
             // evaluate the sling:hideChildren property on the current resource

Modified: sling/trunk/contrib/extensions/resourcemerger/src/main/java/org/apache/sling/resourcemerger/spi/MergedResourcePicker.java
URL: http://svn.apache.org/viewvc/sling/trunk/contrib/extensions/resourcemerger/src/main/java/org/apache/sling/resourcemerger/spi/MergedResourcePicker.java?rev=1781725&r1=1781724&r2=1781725&view=diff
==============================================================================
--- sling/trunk/contrib/extensions/resourcemerger/src/main/java/org/apache/sling/resourcemerger/spi/MergedResourcePicker.java (original)
+++ sling/trunk/contrib/extensions/resourcemerger/src/main/java/org/apache/sling/resourcemerger/spi/MergedResourcePicker.java Sun Feb  5 09:04:06 2017
@@ -30,7 +30,7 @@ import aQute.bnd.annotation.ConsumerType
  * Service interface which can be implemented to define an algorithm used to pick
  * resources to be merged. For each picker service, a separate {@link ResourceProviderFactory}
  * will be exposed at the MERGE_ROOT of the picker.
- * @deprecated
+ * @deprecated Use new {@link MergedResourcePicker2} instead.
  */
 @Deprecated
 @ConsumerType
@@ -61,7 +61,14 @@ public interface MergedResourcePicker {
     String TRAVERSE_PARENT = MergedResourcePicker2.TRAVERSE_PARENT;
 
     /**
-     * @see #pickResources(ResourceResolver, String, Resource)
+     * Method invoked by the MergingResourceProvider to identify the resources to be merged for a given
+     * relative path. The resources returned may be either resources returned from the ResourceResolver
+     * directory or an instance of NonExistingResource.
+     * 
+     * @param resolver the ResourceResolver
+     * @param relativePath the path relative to the merge root
+     * @return a List of Resource objects
+     * @see MergedResourcePicker2#pickResources(ResourceResolver, String, Resource)
      */
     List<Resource> pickResources(ResourceResolver resolver, String relativePath);
 }