You are viewing a plain text version of this content. The canonical link for it is here.
Posted to log4j-dev@logging.apache.org by ca...@apache.org on 2007/10/23 20:29:45 UTC

svn commit: r587591 - in /logging/log4j/trunk/src: changes/ main/java/org/apache/log4j/ main/java/org/apache/log4j/config/ main/java/org/apache/log4j/net/ main/java/org/apache/log4j/xml/

Author: carnold
Date: Tue Oct 23 11:29:44 2007
New Revision: 587591

URL: http://svn.apache.org/viewvc?rev=587591&view=rev
Log:
Bug 43314: SMTPAppender.setSMTPUserName and others missing @since tags

Modified:
    logging/log4j/trunk/src/changes/changes.xml
    logging/log4j/trunk/src/main/java/org/apache/log4j/AsyncAppender.java
    logging/log4j/trunk/src/main/java/org/apache/log4j/config/PropertyPrinter.java
    logging/log4j/trunk/src/main/java/org/apache/log4j/net/SMTPAppender.java
    logging/log4j/trunk/src/main/java/org/apache/log4j/net/SocketAppender.java
    logging/log4j/trunk/src/main/java/org/apache/log4j/net/TelnetAppender.java
    logging/log4j/trunk/src/main/java/org/apache/log4j/xml/XMLLayout.java

Modified: logging/log4j/trunk/src/changes/changes.xml
URL: http://svn.apache.org/viewvc/logging/log4j/trunk/src/changes/changes.xml?rev=587591&r1=587590&r2=587591&view=diff
==============================================================================
--- logging/log4j/trunk/src/changes/changes.xml (original)
+++ logging/log4j/trunk/src/changes/changes.xml Tue Oct 23 11:29:44 2007
@@ -22,6 +22,7 @@
   <body>
 
     <release version="1.2.16" date="TBD" description="">
+       <action action="fix" issue="43314">SMTPAppender.setSMTPUserName and others missing @since tags.</action>
        <action action="fix" issue="43618">Request for compile-on-Windows help file in src package.</action>
        <action action="fix" issue="43599">AsyncAppender failing on changing message objects.</action>
        <action action="fix" issue="43325">Subst-mechanism in DOMConfigurator broken.</action>

Modified: logging/log4j/trunk/src/main/java/org/apache/log4j/AsyncAppender.java
URL: http://svn.apache.org/viewvc/logging/log4j/trunk/src/main/java/org/apache/log4j/AsyncAppender.java?rev=587591&r1=587590&r2=587591&view=diff
==============================================================================
--- logging/log4j/trunk/src/main/java/org/apache/log4j/AsyncAppender.java (original)
+++ logging/log4j/trunk/src/main/java/org/apache/log4j/AsyncAppender.java Tue Oct 23 11:29:44 2007
@@ -399,6 +399,7 @@
    * Sets whether appender should wait if there is no
    * space available in the event buffer or immediately return.
    *
+   * @since 1.2.14
    * @param value true if appender should wait until available space in buffer.
    */
   public void setBlocking(final boolean value) {
@@ -413,6 +414,7 @@
    * If false, messages will be counted by logger and a summary
    * message appended after the contents of the buffer have been appended.
    *
+   * @since 1.2.14
    * @return true if calling thread will be blocked when buffer is full.
    */
   public boolean getBlocking() {

Modified: logging/log4j/trunk/src/main/java/org/apache/log4j/config/PropertyPrinter.java
URL: http://svn.apache.org/viewvc/logging/log4j/trunk/src/main/java/org/apache/log4j/config/PropertyPrinter.java?rev=587591&r1=587590&r2=587591&view=diff
==============================================================================
--- logging/log4j/trunk/src/main/java/org/apache/log4j/config/PropertyPrinter.java (original)
+++ logging/log4j/trunk/src/main/java/org/apache/log4j/config/PropertyPrinter.java Tue Oct 23 11:29:44 2007
@@ -90,6 +90,9 @@
     }
   }
   
+  /**
+   * @since 1.2.15
+   */
   protected
   void printOptions(PrintWriter out, Category cat) {
     Enumeration appenders = cat.getAllAppenders();

Modified: logging/log4j/trunk/src/main/java/org/apache/log4j/net/SMTPAppender.java
URL: http://svn.apache.org/viewvc/logging/log4j/trunk/src/main/java/org/apache/log4j/net/SMTPAppender.java?rev=587591&r1=587590&r2=587591&view=diff
==============================================================================
--- logging/log4j/trunk/src/main/java/org/apache/log4j/net/SMTPAppender.java (original)
+++ logging/log4j/trunk/src/main/java/org/apache/log4j/net/SMTPAppender.java Tue Oct 23 11:29:44 2007
@@ -64,6 +64,8 @@
    property with an instance of TriggeringEventEvaluator or
    nesting a triggeringPolicy element where the specified
    class implements TriggeringEventEvaluator.
+   
+   This class has implemented UnrecognizedElementHandler since 1.2.15.
 
    @author Ceki G&uuml;lc&uuml;
    @since 1.0 */
@@ -139,6 +141,7 @@
    *   Address message.
    *   @param msg message, may not be null.
    *   @throws MessagingException thrown if error addressing message. 
+   *   @since 1.2.14
    */
   protected void addressMessage(final Message msg) throws MessagingException {
        if (from != null) {
@@ -165,6 +168,7 @@
   /**
    *  Create mail session.
    *  @return mail session, may not be null.
+   *  @since 1.2.14
    */
   protected Session createSession() {
     Properties props = null;
@@ -470,6 +474,7 @@
    /**
       Set the cc recipient addresses.
       @param addresses recipient addresses as comma separated string, may be null.
+      @since 1.2.14
     */
    public void setCc(final String addresses) {
      this.cc = addresses;
@@ -478,6 +483,7 @@
    /**
       Get the cc recipient addresses.
       @return recipient addresses as comma separated string, may be null.
+      @since 1.2.14
     */
     public String getCc() {
      return cc;
@@ -486,6 +492,7 @@
    /**
       Set the bcc recipient addresses.
       @param addresses recipient addresses as comma separated string, may be null.
+      @since 1.2.14
     */
    public void setBcc(final String addresses) {
      this.bcc = addresses;
@@ -494,6 +501,7 @@
    /**
       Get the bcc recipient addresses.
       @return recipient addresses as comma separated string, may be null.
+      @since 1.2.14
     */
     public String getBcc() {
      return bcc;
@@ -503,6 +511,7 @@
    * The <b>SmtpPassword</b> option takes a string value which should be the password required to authenticate against
    * the mail server.
    * @param password password, may be null.
+   * @since 1.2.14
    */
   public void setSMTPPassword(final String password) {
     this.smtpPassword = password;
@@ -512,6 +521,7 @@
    * The <b>SmtpUsername</b> option takes a string value which should be the username required to authenticate against
    * the mail server.
    * @param username user name, may be null.
+   * @since 1.2.14
    */
   public void setSMTPUsername(final String username) {
     this.smtpUsername = username;
@@ -522,6 +532,7 @@
    * This can be useful when debuging the appender but should not be used during production because username and
    * password information is included in the output.
    * @param debug debug flag.
+   * @since 1.2.14
    */
   public void setSMTPDebug(final boolean debug) {
     this.smtpDebug = debug;
@@ -530,6 +541,7 @@
   /**
    * Get SMTP password.
    * @return SMTP password, may be null.
+   * @since 1.2.14
    */
   public String getSMTPPassword() {
     return smtpPassword;
@@ -538,6 +550,7 @@
   /**
    * Get SMTP user name.
    * @return SMTP user name, may be null.
+   * @since 1.2.14
    */
   public String getSMTPUsername() {
     return smtpUsername;
@@ -546,6 +559,7 @@
   /**
    * Get SMTP debug.
    * @return SMTP debug flag.
+   * @since 1.2.14
    */
   public boolean getSMTPDebug() {
     return smtpDebug;
@@ -572,7 +586,9 @@
       return evaluator;
   }
 
-  /** {@inheritDoc} */
+  /** {@inheritDoc}
+   * @since 1.2.15 
+  */
   public boolean parseUnrecognizedElement(final Element element,
                                           final Properties props) throws Exception {
       if ("triggeringPolicy".equals(element.getNodeName())) {

Modified: logging/log4j/trunk/src/main/java/org/apache/log4j/net/SocketAppender.java
URL: http://svn.apache.org/viewvc/logging/log4j/trunk/src/main/java/org/apache/log4j/net/SocketAppender.java?rev=587591&r1=587590&r2=587591&view=diff
==============================================================================
--- logging/log4j/trunk/src/main/java/org/apache/log4j/net/SocketAppender.java (original)
+++ logging/log4j/trunk/src/main/java/org/apache/log4j/net/SocketAppender.java Tue Oct 23 11:29:44 2007
@@ -341,6 +341,7 @@
    * The <b>App</b> option takes a string value which should be the name of the 
    * application getting logged.
    * If property was already set (via system property), don't set here.
+   * @since 1.2.15
    */
   public void setApplication(String lapp) {
     this.application = lapp;
@@ -348,6 +349,7 @@
 
   /**
    *  Returns value of the <b>Application</b> option.
+   * @since 1.2.15
    */
   public String getApplication() {
     return application;

Modified: logging/log4j/trunk/src/main/java/org/apache/log4j/net/TelnetAppender.java
URL: http://svn.apache.org/viewvc/logging/log4j/trunk/src/main/java/org/apache/log4j/net/TelnetAppender.java?rev=587591&r1=587590&r2=587591&view=diff
==============================================================================
--- logging/log4j/trunk/src/main/java/org/apache/log4j/net/TelnetAppender.java (original)
+++ logging/log4j/trunk/src/main/java/org/apache/log4j/net/TelnetAppender.java Tue Oct 23 11:29:44 2007
@@ -132,7 +132,10 @@
         close();
     }
       
-    /** make sure we close all network connections when this handler is destroyed. */
+    /** 
+    * make sure we close all network connections when this handler is destroyed.
+    * @since 1.2.15 
+    */
     public void close() {
       for(Enumeration e = connections.elements();e.hasMoreElements();) {
         try {

Modified: logging/log4j/trunk/src/main/java/org/apache/log4j/xml/XMLLayout.java
URL: http://svn.apache.org/viewvc/logging/log4j/trunk/src/main/java/org/apache/log4j/xml/XMLLayout.java?rev=587591&r1=587590&r2=587591&view=diff
==============================================================================
--- logging/log4j/trunk/src/main/java/org/apache/log4j/xml/XMLLayout.java (original)
+++ logging/log4j/trunk/src/main/java/org/apache/log4j/xml/XMLLayout.java Tue Oct 23 11:29:44 2007
@@ -99,6 +99,7 @@
     /**
      * Sets whether MDC key-value pairs should be output, default false.
      * @param flag new value.
+     * @since 1.2.15
      */
   public void setProperties(final boolean flag) {
       properties = flag;
@@ -107,6 +108,7 @@
     /**
      * Gets whether MDC key-value pairs should be output.
      * @return true if MDC key-value pairs are output.
+     * @since 1.2.15
      */
   public boolean getProperties() {
       return properties;



---------------------------------------------------------------------
To unsubscribe, e-mail: log4j-dev-unsubscribe@logging.apache.org
For additional commands, e-mail: log4j-dev-help@logging.apache.org