Show
Ignore:
Timestamp:
07/10/08 12:39:08 (4 years ago)
Author:
amandel
Message:

Generated javadoc cleanup.

Files:
1 modified

Legend:

Unmodified
Added
Removed
  • trunk/src/xml/xsl/generate-log-message-info.xsl

    r1058 r1078  
    214214 
    215215/** 
    216  * Exception thrown when a <xsl:value-of select="$display-name"/> occurred. 
     216 * <xsl:value-of select="$message/description"/> 
     217 * 
     218 * <xsl:value-of select="$message/text"/> 
    217219 * 
    218220 * This exception encapsulates the log message 
     
    232234 
    233235   /** 
    234     * Constructs a <xsl:value-of select="$display-name"/> exception with a <tt>cause</tt>.<xsl:call-template 
     236    * Constructs a <xsl:value-of select="$display-name"/> exception with a &lt;tt>cause&lt;/tt>.<xsl:call-template 
    235237      name="inner-clazz-log-parameter-javadoc"> 
    236238                <xsl:with-param name="tokens" select="$tokens"/> 
     
    256258 
    257259   /** 
    258     * Constructs a <xsl:value-of select="$display-name"/> exception with a <tt>cause</tt>.<xsl:call-template 
     260    * Constructs a <xsl:value-of select="$display-name"/> exception with a &lt;tt>cause&lt;/tt>.<xsl:call-template 
    259261      name="inner-clazz-log-parameter-javadoc"> 
    260262                <xsl:with-param name="tokens" select="$tokens"/> 
     
    280282   /** 
    281283    * Constructor getting an log message info. 
     284    * This constructor is for generated exceptions internal use only. 
    282285    * 
    283286    * @param messageInfo the log message info for this exception 
     
    295298   /** 
    296299    * Constructor getting an log message info and a root exception. 
     300    * This constructor is for generated exceptions internal use only. 
    297301    * 
    298302    * @param messageInfo the log message info for this exception 
     
    312316      /** 
    313317       * Logs the exception 
    314        * <tt>"<xsl:value-of select="normalize-space($message/text)"/>"</tt> 
     318       * &lt;tt>"<xsl:value-of select="normalize-space($message/text)"/>"&lt;/tt> 
    315319       * to the custom logger. 
    316320       * @param logger the custom logger to log to. 
     
    368372 
    369373/** 
    370  * Exception thrown when a <xsl:value-of select="$display-name"/> occurred. 
    371  * 
    372374 * This is the base exception for all message in 
    373375 * the package {@link <xsl:value-of select="$package"/>}. 
     
    383385   /** 
    384386    * Constructor getting an log message info. 
     387    * This constructor is for generated exceptions internal use only. 
    385388    * 
    386389    * @param messageInfo the log message info for this exception 
     
    393396   /** 
    394397    * Constructor getting an log message info and a root exception. 
     398    * This constructor is for generated exceptions internal use only. 
    395399    * 
    396400    * @param messageInfo the log message info for this exception 
     
    428432 
    429433/** 
    430  * Enumeration of all <xsl:value-of select="$group/@name"/>. 
     434 * Enumeration of all <xsl:value-of select="$group/@name"/> log messages. 
    431435 * 
    432  * Instances of this class are immutable. 
     436 * &lt;p>Instances of this class are immutable.&lt;/p> 
    433437 * 
    434438 * The following <xsl:value-of select="$group/@name"/> are defined: 
     
    446450 
    447451   /** 
    448     * Constructor. 
     452    * Private constructor used by the inner classes. 
    449453    * @param symbol The symbolic name of the log message. 
    450454    * @param id The unique numeric id of the log message. 
     
    474478      </xsl:call-template> 
    475479   </xsl:variable> 
    476    /** The log message &lt;code&gt;<xsl:value-of select="./@name"/>&lt;/code&gt;. */ 
     480   /** 
     481    <xsl:choose> 
     482      <xsl:when test="description"> 
     483       <xsl:value-of select="normalize-space(description)"/> 
     484      </xsl:when> 
     485      <xsl:when test="text"> 
     486       <xsl:value-of select="normalize-space(text)"/> 
     487      </xsl:when> 
     488    </xsl:choose> 
     489    * . 
     490    * &lt;p>This class holds the static data for the &lt;code&gt;<xsl:value-of select="./@name"/>&lt;/code&gt; 
     491    * log message.&lt;/p> 
     492    * &lt;p>It holds the following parameters:&lt;/p> 
     493    * &lt;ul> 
     494    * <xsl:if test="text"> 
     495       &lt;li>Message: <xsl:value-of select="normalize-space(text)"/>&lt;/li> 
     496      </xsl:if> 
     497      <xsl:if test="description"> 
     498       &lt;li>Description: <xsl:value-of select="normalize-space(description)"/>&lt;/li> 
     499      </xsl:if> 
     500      <xsl:if test="solution"> 
     501       &lt;li>Solution <xsl:value-of select="normalize-space(solution)"/>&lt;/li> 
     502      </xsl:if> 
     503      <xsl:if test="procedure"> 
     504       &lt;li>Procedure <xsl:value-of select="normalize-space(procedure)"/>&lt;/li> 
     505      </xsl:if> 
     506      <xsl:if test="verification"> 
     507       &lt;li>Verification <xsl:value-of select="normalize-space(verification)"/>&lt;/li> 
     508      </xsl:if> 
     509    * &lt;/ul> 
     510    */ 
    477511   public static final class <xsl:value-of select="$inner-classname"/> 
    478512         extends <xsl:value-of select="$classname"/> 
     
    492526      </xsl:call-template> 
    493527   </xsl:variable> 
    494    /** The log message &lt;code&gt;<xsl:value-of select="./@name"/>&lt;/code&gt;. */ 
     528   /** The log message for thwe event &lt;code&gt;<xsl:value-of select="./@name"/>&lt;/code&gt;. */ 
    495529   public static final <xsl:value-of select="$inner-classname"/><xsl:text> </xsl:text><xsl:value-of select="./@name"/> 
    496530         = new <xsl:value-of select="$inner-classname"/>(); 
     
    695729      /** 
    696730       * Logs the message 
    697        * <tt>"<xsl:value-of select="normalize-space($message/text)"/>"</tt> 
     731       * &lt;tt>"<xsl:value-of select="normalize-space($message/text)"/>"&lt;/tt> 
    698732       * with the given parameters.<xsl:call-template 
    699733                  name="inner-clazz-log-parameter-javadoc"> 
     
    724758      /** 
    725759       * Logs the message 
    726        * <tt>"<xsl:value-of select="normalize-space($message/text)"/>"</tt> 
     760       * &lt;tt>"<xsl:value-of select="normalize-space($message/text)"/>"&lt;/tt> 
    727761       * with the given parameters.<xsl:call-template 
    728762                  name="inner-clazz-log-parameter-javadoc"> 
     
    756790      /** 
    757791       * Logs the message 
    758        * <tt>"<xsl:value-of select="normalize-space($message/text)"/>"</tt> 
     792       * &lt;tt>"<xsl:value-of select="normalize-space($message/text)"/>"&lt;/tt> 
    759793       * with the given parameters to the custom logger. 
    760794       * @param logger the custom logger to log to.<xsl:call-template 
     
    764798               </xsl:call-template> 
    765799       */ 
    766       public static void log (<xsl:value-of select="$custom-logger-class"/> logger<xsl:if  
    767              test="$isAudit or normalize-space($tokens)">, <xsl:call-template 
     800      public static void log (<xsl:value-of select="$custom-logger-class"/> logger<xsl:if 
     801       test="$isAudit or normalize-space($tokens)">, <xsl:call-template 
    768802                  name="inner-clazz-log-parameter-list"> 
    769803                  <xsl:with-param name="tokens" select="$tokens"/> 
     
    795829      /** 
    796830       * Logs the message 
    797        * <tt>"<xsl:value-of select="normalize-space($message/text)"/>"</tt> 
     831       * &lt;tt>"<xsl:value-of select="normalize-space($message/text)"/>"&lt;/tt> 
    798832       * with the given parameters to the custom logger. 
    799833       * @param logger the custom logger to log to.<xsl:call-template 
     
    804838       * @param cause the Throwable that causes this message to be logged. 
    805839       */ 
    806       public static void log (<xsl:value-of select="$custom-logger-class"/> logger<xsl:if  
    807              test="$isAudit or normalize-space($tokens)">, <xsl:call-template 
     840      public static void log (<xsl:value-of select="$custom-logger-class"/> logger<xsl:if 
     841       test="$isAudit or normalize-space($tokens)">, <xsl:call-template 
    808842                  name="inner-clazz-log-parameter-list"> 
    809843                  <xsl:with-param name="tokens" select="$tokens"/> 
    810844                  <xsl:with-param name="isAudit" select="$isAudit"/> 
    811           </xsl:call-template></xsl:if>,  
     845          </xsl:call-template></xsl:if>, 
    812846               Throwable cause 
    813847            ) 
     
    842876      /** 
    843877       * Creates the audit log event 
    844        * <tt>"<xsl:value-of select="normalize-space($message/text)"/>"</tt> 
     878       * &lt;tt>"<xsl:value-of select="normalize-space($message/text)"/>"&lt;/tt> 
    845879       * with the given parameters.<xsl:call-template 
    846880                  name="inner-clazz-log-parameter-javadoc"> 
     
    871905      /** 
    872906       * Creates the audit log event 
    873        * <tt>"<xsl:value-of select="normalize-space($message/text)"/>"</tt> 
     907       * &lt;tt>"<xsl:value-of select="normalize-space($message/text)"/>"&lt;/tt> 
    874908       * with the given parameters.<xsl:call-template 
    875909                  name="inner-clazz-log-parameter-javadoc"> 
     
    903937 
    904938      /** 
    905        * Adds the given message parameters to the <tt>loggable</tt>. 
     939       * Adds the given message parameters to the &lt;tt>loggable&lt;/tt>. 
    906940       * @param loggable the loggable to initialize. <xsl:call-template 
    907941                  name="inner-clazz-log-parameter-javadoc"> 
    908942                  <xsl:with-param name="tokens" select="$tokens"/> 
    909943               </xsl:call-template> 
    910        * @return the given initialized <tt>loggable</tt>. 
     944       * @return the given initialized &lt;tt>loggable&lt;/tt>. 
    911945       */ 
    912946      public static Loggable addParameters (Loggable loggable<xsl:if