You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@sling.apache.org by da...@apache.org on 2018/11/02 09:11:36 UTC

[sling-org-apache-sling-feature] branch master updated: Fix some missing Javadoc.

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

davidb pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/sling-org-apache-sling-feature.git


The following commit(s) were added to refs/heads/master by this push:
     new 69d4d01  Fix some missing Javadoc.
69d4d01 is described below

commit 69d4d01a0c3e1860eabf6daa00ace126875c0b41
Author: David Bosschaert <bo...@adobe.com>
AuthorDate: Fri Nov 2 09:11:17 2018 +0000

    Fix some missing Javadoc.
---
 src/main/java/org/apache/sling/feature/Artifacts.java              | 2 +-
 src/main/java/org/apache/sling/feature/builder/BuilderContext.java | 3 ++-
 src/main/java/org/apache/sling/feature/builder/MergeHandler.java   | 3 ++-
 3 files changed, 5 insertions(+), 3 deletions(-)

diff --git a/src/main/java/org/apache/sling/feature/Artifacts.java b/src/main/java/org/apache/sling/feature/Artifacts.java
index 7607b15..f756d10 100644
--- a/src/main/java/org/apache/sling/feature/Artifacts.java
+++ b/src/main/java/org/apache/sling/feature/Artifacts.java
@@ -30,7 +30,7 @@ public class Artifacts extends ArrayList<Artifact> {
      * collection, it is not added again.
      *
      * @param artifact The artifact
-     * @return @{code true} if this collection changed as a result of the call
+     * @return {@code true} if this collection changed as a result of the call
      */
     @Override
     public boolean add(final Artifact artifact) {
diff --git a/src/main/java/org/apache/sling/feature/builder/BuilderContext.java b/src/main/java/org/apache/sling/feature/builder/BuilderContext.java
index 696ea8b..70c0eee 100644
--- a/src/main/java/org/apache/sling/feature/builder/BuilderContext.java
+++ b/src/main/java/org/apache/sling/feature/builder/BuilderContext.java
@@ -40,6 +40,7 @@ public class BuilderContext {
      * Create a new context
      *
      * @param provider A provider providing the included features
+     * @param ap An ArtifactProvider to resolve artifact IDs to files
      * @throws IllegalArgumentException If feature provider is {@code null}
      */
     public BuilderContext(final FeatureProvider provider, final ArtifactProvider ap) {
@@ -50,7 +51,7 @@ public class BuilderContext {
      * Create a new context
      *
      * @param provider A provider providing the included features
-     * @param ap
+     * @param ap An ArtifactProvider to resolve artifact IDs to files
      * @param variables A map of variables to override on feature merge
      * @param properties A map of framework properties to override on feature merge
      * @throws IllegalArgumentException If feature provider is {@code null}
diff --git a/src/main/java/org/apache/sling/feature/builder/MergeHandler.java b/src/main/java/org/apache/sling/feature/builder/MergeHandler.java
index 39cf543..e30fbf5 100644
--- a/src/main/java/org/apache/sling/feature/builder/MergeHandler.java
+++ b/src/main/java/org/apache/sling/feature/builder/MergeHandler.java
@@ -42,7 +42,8 @@ public interface MergeHandler {
      * @param context Context for the handler
      * @param target The target feature
      * @param source The source feature
-     * @param extension The extension
+     * @param targetEx The target extension
+     * @param sourceEx The source extension
      * @throws IllegalStateException If the extensions can't be merged
      */
     void merge(HandlerContext context, Feature target, Feature source, Extension targetEx, Extension sourceEx);