You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@logging.apache.org by gg...@apache.org on 2015/09/01 06:48:08 UTC

[3/3] logging-log4j2 git commit: Javadoc: Use the active voice.

Javadoc: Use the active voice.

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

Branch: refs/heads/LOG4J2-952
Commit: 426d729f387cd69e3b503c378215d2a5e3af25ad
Parents: af25d45
Author: ggregory <gg...@apache.org>
Authored: Mon Aug 31 21:48:04 2015 -0700
Committer: ggregory <gg...@apache.org>
Committed: Mon Aug 31 21:48:04 2015 -0700

----------------------------------------------------------------------
 .../builder/api/ConfigurationBuilder.java       | 20 ++++++++++----------
 1 file changed, 10 insertions(+), 10 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/logging-log4j2/blob/426d729f/log4j-core/src/main/java/org/apache/logging/log4j/core/config/builder/api/ConfigurationBuilder.java
----------------------------------------------------------------------
diff --git a/log4j-core/src/main/java/org/apache/logging/log4j/core/config/builder/api/ConfigurationBuilder.java b/log4j-core/src/main/java/org/apache/logging/log4j/core/config/builder/api/ConfigurationBuilder.java
index cbfaedc..4a3ff3a 100644
--- a/log4j-core/src/main/java/org/apache/logging/log4j/core/config/builder/api/ConfigurationBuilder.java
+++ b/log4j-core/src/main/java/org/apache/logging/log4j/core/config/builder/api/ConfigurationBuilder.java
@@ -28,42 +28,42 @@ import org.apache.logging.log4j.core.util.Builder;
 public interface ConfigurationBuilder<T extends Configuration> extends Builder<T> {
 
     /**
-     * Set the name of the configuration.
+     * Sets the name of the configuration.
      * @param name the name of the {@link Configuration}. By default is {@code "Constructed"}.
      * @return this Assembler instance.
      */
     ConfigurationBuilder<T> setConfigurationName(String name);
 
     /**
-     * Set the configuration source, if one exists.
+     * Sets the configuration source, if one exists.
      * @param configurationSource the ConfigurationSource.
      * @return this Assembler instance.
      */
     ConfigurationBuilder<T> setConfigurationSource(ConfigurationSource configurationSource);
 
     /**
-     * Set the level of the StatusLogger.
+     * Sets the level of the StatusLogger.
      * @param level The logging level.
      * @return this Assembler instance.
      */
     ConfigurationBuilder<T> setStatusLevel(Level level);
 
     /**
-     * Set whether the logging should include constructing Plugins.
+     * Sets whether the logging should include constructing Plugins.
      * @param verbosity "disable" will hide messages from plugin construction.
      * @return this Assembler instance.
      */
     ConfigurationBuilder<T> setVerbosity(String verbosity);
 
     /**
-     * Set the list of packages to search for plugins.
+     * Sets the list of packages to search for plugins.
      * @param packages The comma separated list of packages.
      * @return this Assembler instance.
      */
     ConfigurationBuilder<T> setPackages(String packages);
 
     /**
-     * Set whether the shutdown hook should be disabled.
+     * Sets whether the shutdown hook should be disabled.
      * @param flag "disable" will prevent the shutdown hook from being set.
      * @return this Assembler instance.
      */
@@ -91,28 +91,28 @@ public interface ConfigurationBuilder<T extends Configuration> extends Builder<T
     ConfigurationBuilder<T> add(CustomLevelComponentBuilder assembler);
 
     /**
-     * Add a Logger component.
+     * Adds a Logger component.
      * @param assembler The LoggerComponentBuilder with all of its attributes and sub components set.
      * @return this Assembler instance.
      */
     ConfigurationBuilder<T> add(LoggerComponentBuilder assembler);
 
     /**
-     * Add the root Logger component.
+     * Adds the root Logger component.
      * @param assembler The RootLoggerComponentBuilder with all of its attributes and sub components set.
      * @return this Assembler instance.
      */
     ConfigurationBuilder<T> add(RootLoggerComponentBuilder assembler);
 
     /**
-     * Add a Filter component.
+     * Adds a Filter component.
      * @param assembler the FilterComponentBuilder with all of its attributes and sub components set.
      * @return this Assembler instance.
      */
     ConfigurationBuilder<T> add(FilterComponentBuilder assembler);
 
     /**
-     * Add a Property key and value.
+     * Adds a Property key and value.
      * @param key The property key.
      * @param value The property value.
      * @return this Assembler instance.