You are viewing a plain text version of this content. The canonical link for it is here.
Posted to cvs@avalon.apache.org by ni...@apache.org on 2004/03/28 07:05:44 UTC

cvs commit: avalon-logkit/src/java/org/apache/log/output/net SMTPOutputLogTarget.java

niclas      2004/03/27 21:05:44

  Modified:    src/java/org/apache/log/format Formatter.java
               src/java/org/apache/log/output AbstractOutputTarget.java
                        PriorityFilteringTarget.java
               src/java/org/apache/log/output/net SMTPOutputLogTarget.java
  Log:
  Fixed warnings in Javadoc generations.
  
  Revision  Changes    Path
  1.8       +1 -2      avalon-logkit/src/java/org/apache/log/format/Formatter.java
  
  Index: Formatter.java
  ===================================================================
  RCS file: /home/cvs/avalon-logkit/src/java/org/apache/log/format/Formatter.java,v
  retrieving revision 1.7
  retrieving revision 1.8
  diff -u -r1.7 -r1.8
  --- Formatter.java	28 Feb 2004 11:31:24 -0000	1.7
  +++ Formatter.java	28 Mar 2004 05:05:43 -0000	1.8
  @@ -18,8 +18,7 @@
   
   import org.apache.log.LogEvent;
   
  -/**
  - * This defines the interface for components that wish to serialize
  +/** This defines the interface for components that wish to serialize
    * LogEvents into Strings.
    *
    * @author Peter Donald
  
  
  
  1.22      +4 -9      avalon-logkit/src/java/org/apache/log/output/AbstractOutputTarget.java
  
  Index: AbstractOutputTarget.java
  ===================================================================
  RCS file: /home/cvs/avalon-logkit/src/java/org/apache/log/output/AbstractOutputTarget.java,v
  retrieving revision 1.21
  retrieving revision 1.22
  diff -u -r1.21 -r1.22
  --- AbstractOutputTarget.java	13 Mar 2004 04:12:04 -0000	1.21
  +++ AbstractOutputTarget.java	28 Mar 2004 05:05:43 -0000	1.22
  @@ -19,8 +19,8 @@
   import org.apache.log.LogEvent;
   import org.apache.log.format.Formatter;
   
  -/**
  - * Abstract output target.
  +/** Abstract output target.
  + *
    * Any new output target that is writing to a single connected
    * resource should extend this class directly or indirectly.
    *
  @@ -30,15 +30,10 @@
   public abstract class AbstractOutputTarget
       extends AbstractTarget
   {
  -    /**
  -     * Formatter for target.
  -     *
  -     */
  +    /** Formatter for target. */
       private Formatter m_formatter;
   
  -    /**
  -     * Parameterless constructor.
  -     */
  +    /** Parameterless constructor.  */
       public AbstractOutputTarget()
       {
       }
  
  
  
  1.3       +2 -2      avalon-logkit/src/java/org/apache/log/output/PriorityFilteringTarget.java
  
  Index: PriorityFilteringTarget.java
  ===================================================================
  RCS file: /home/cvs/avalon-logkit/src/java/org/apache/log/output/PriorityFilteringTarget.java,v
  retrieving revision 1.2
  retrieving revision 1.3
  diff -u -r1.2 -r1.3
  --- PriorityFilteringTarget.java	13 Mar 2004 14:50:37 -0000	1.2
  +++ PriorityFilteringTarget.java	28 Mar 2004 05:05:43 -0000	1.3
  @@ -39,7 +39,7 @@
       private LogTarget m_targets[];
   
       /**
  -     * @param Priority The priority used to filter
  +     * @param priority The priority used to filter
        * @param closeWrappedTarget see AbstractWrappingTarget
        */
       public PriorityFilteringTarget(Priority priority,
  @@ -51,7 +51,7 @@
       }
   
       /**
  -     * @param Priority The priority used to filter
  +     * @param priority The priority used to filter
        */
       public PriorityFilteringTarget(Priority priority)
       {
  
  
  
  1.10      +12 -10    avalon-logkit/src/java/org/apache/log/output/net/SMTPOutputLogTarget.java
  
  Index: SMTPOutputLogTarget.java
  ===================================================================
  RCS file: /home/cvs/avalon-logkit/src/java/org/apache/log/output/net/SMTPOutputLogTarget.java,v
  retrieving revision 1.9
  retrieving revision 1.10
  diff -u -r1.9 -r1.10
  --- SMTPOutputLogTarget.java	28 Feb 2004 11:31:25 -0000	1.9
  +++ SMTPOutputLogTarget.java	28 Mar 2004 05:05:43 -0000	1.10
  @@ -26,8 +26,7 @@
   import org.apache.log.format.Formatter;
   import org.apache.log.output.AbstractOutputTarget;
   
  -/**
  - * Logkit output target that logs data via SMTP (ie. email, email gateways).
  +/** Logkit output target that logs data via SMTP.
    *
    * @author <a href="mailto:dev@avalon.apache.org">Avalon Development Team</a>
    * @author <a href="mailto:crafterm@apache.org">Marcus Crafter</a>
  @@ -60,9 +59,10 @@
       // Buffer containing current mail
       private StringBuffer m_buffer;
   
  -    /**
  -     * SMTPOutputLogTarget constructor, creates a logkit output target
  -     * capable of logging to SMTP (ie. email, email gateway) targets.
  +    /** SMTPOutputLogTarget constructor.
  +     *
  +     * It creates a logkit output target capable of logging to SMTP 
  +     * (ie. email, email gateway) targets.
        *
        * @param session mail session to be used
        * @param toAddresses addresses logs should be sent to
  @@ -92,8 +92,9 @@
           open();
       }
   
  -    /**
  -     * Method to write data to the log target. Logging data is stored in
  +    /** Method to write data to the log target. 
  +     * 
  +     * Logging data is stored in
        * an internal buffer until the size limit is reached. When this happens
        * the data is sent to the SMTP target, and the buffer is reset for
        * subsequent events.
  @@ -133,8 +134,9 @@
           }
       }
   
  -    /**
  -     * Closes this log target. Sends currently buffered message, if existing.
  +    /** Closes this log target. 
  +     *
  +     * Sends currently buffered message, if existing.
        */
       public synchronized void close()
       {
  
  
  

---------------------------------------------------------------------
To unsubscribe, e-mail: cvs-unsubscribe@avalon.apache.org
For additional commands, e-mail: cvs-help@avalon.apache.org