Important Javadoc clarification.

Project: http://git-wip-us.apache.org/repos/asf/logging-log4j2/repo
Commit: http://git-wip-us.apache.org/repos/asf/logging-log4j2/commit/d7f703e2
Tree: http://git-wip-us.apache.org/repos/asf/logging-log4j2/tree/d7f703e2
Diff: http://git-wip-us.apache.org/repos/asf/logging-log4j2/diff/d7f703e2

Branch: refs/heads/master
Commit: d7f703e22cdc7139e0df2e6bc9487f7da53f75f1
Parents: 51e4923
Author: ggregory <[email protected]>
Authored: Mon Aug 31 16:53:42 2015 -0700
Committer: ggregory <[email protected]>
Committed: Mon Aug 31 16:53:42 2015 -0700

----------------------------------------------------------------------
 .../logging/log4j/core/config/builder/api/ComponentBuilder.java    | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/logging-log4j2/blob/d7f703e2/log4j-core/src/main/java/org/apache/logging/log4j/core/config/builder/api/ComponentBuilder.java
----------------------------------------------------------------------
diff --git 
a/log4j-core/src/main/java/org/apache/logging/log4j/core/config/builder/api/ComponentBuilder.java
 
b/log4j-core/src/main/java/org/apache/logging/log4j/core/config/builder/api/ComponentBuilder.java
index 8d48a82..17e0faa 100644
--- 
a/log4j-core/src/main/java/org/apache/logging/log4j/core/config/builder/api/ComponentBuilder.java
+++ 
b/log4j-core/src/main/java/org/apache/logging/log4j/core/config/builder/api/ComponentBuilder.java
@@ -77,7 +77,7 @@ public interface ComponentBuilder<T extends ComponentBuilder> 
extends Builder<Co
     /**
      * Adds a sub component.
      * @param builder The Assembler for the subcomponent with all of its 
attributes and sub-components set.
-     * @return The ComponentBuilder.
+     * @return This ComponentBuilder (<em>not</em> the argument).
      */
     T addComponent(ComponentBuilder<?> builder);
 

Reply via email to