Changeset 1078

Timestamp:

07/10/08 12:39:08 (4 years ago)

Author:

amandel

Message:

Generated javadoc cleanup.

Location:

trunk/src/xml/xsl

Files:

• generate-log-message-info.xsl (modified) (22 diffs)
• libcommon.xsl (modified) (3 diffs)

trunk/src/xml/xsl/generate-log-message-info.xsl

@@ -214 +214 @@
 
 /**
- * Exception thrown when a <xsl:value-of select="$display-name"/> occurred.
+ * <xsl:value-of select="$message/description"/>
+ *
+ * <xsl:value-of select="$message/text"/>
  *
  * This exception encapsulates the log message
@@ -232 +234 @@
 
    /**
-    * Constructs a <xsl:value-of select="$display-name"/> exception with a <tt>cause</tt>.<xsl:call-template
+    * Constructs a <xsl:value-of select="$display-name"/> exception with a &lt;tt>cause&lt;/tt>.<xsl:call-template
       name="inner-clazz-log-parameter-javadoc">
                 <xsl:with-param name="tokens" select="$tokens"/>
@@ -256 +258 @@
 
    /**
-    * Constructs a <xsl:value-of select="$display-name"/> exception with a <tt>cause</tt>.<xsl:call-template
+    * Constructs a <xsl:value-of select="$display-name"/> exception with a &lt;tt>cause&lt;/tt>.<xsl:call-template
       name="inner-clazz-log-parameter-javadoc">
                 <xsl:with-param name="tokens" select="$tokens"/>
@@ -280 +282 @@
    /**
     * Constructor getting an log message info.
+    * This constructor is for generated exceptions internal use only.
     *
     * @param messageInfo the log message info for this exception
@@ -295 +298 @@
    /**
     * Constructor getting an log message info and a root exception.
+    * This constructor is for generated exceptions internal use only.
     *
     * @param messageInfo the log message info for this exception
@@ -312 +316 @@
       /**
        * Logs the exception
-       * <tt>"<xsl:value-of select="normalize-space($message/text)"/>"</tt>
+       * &lt;tt>"<xsl:value-of select="normalize-space($message/text)"/>"&lt;/tt>
        * to the custom logger.
        * @param logger the custom logger to log to.
@@ -368 +372 @@
 
 /**
- * Exception thrown when a <xsl:value-of select="$display-name"/> occurred.
- *
  * This is the base exception for all message in
  * the package {@link <xsl:value-of select="$package"/>}.
@@ -383 +385 @@
    /**
     * Constructor getting an log message info.
+    * This constructor is for generated exceptions internal use only.
     *
     * @param messageInfo the log message info for this exception
@@ -393 +396 @@
    /**
     * Constructor getting an log message info and a root exception.
+    * This constructor is for generated exceptions internal use only.
     *
     * @param messageInfo the log message info for this exception
@@ -428 +432 @@
 
 /**
- * Enumeration of all <xsl:value-of select="$group/@name"/>.
+ * Enumeration of all <xsl:value-of select="$group/@name"/> log messages.
  *
- * Instances of this class are immutable.
+ * &lt;p>Instances of this class are immutable.&lt;/p>
  *
  * The following <xsl:value-of select="$group/@name"/> are defined:
@@ -446 +450 @@
 
    /**
-    * Constructor.
+    * Private constructor used by the inner classes.
     * @param symbol The symbolic name of the log message.
     * @param id The unique numeric id of the log message.
@@ -474 +478 @@
       </xsl:call-template>
    </xsl:variable>
-   /** The log message &lt;code&gt;<xsl:value-of select="./@name"/>&lt;/code&gt;. */
+   /**
+    <xsl:choose>
+      <xsl:when test="description">
+       <xsl:value-of select="normalize-space(description)"/>
+      </xsl:when>
+      <xsl:when test="text">
+       <xsl:value-of select="normalize-space(text)"/>
+      </xsl:when>
+    </xsl:choose>
+    * .
+    * &lt;p>This class holds the static data for the &lt;code&gt;<xsl:value-of select="./@name"/>&lt;/code&gt;
+    * log message.&lt;/p>
+    * &lt;p>It holds the following parameters:&lt;/p>
+    * &lt;ul>
+    * <xsl:if test="text">
+       &lt;li>Message: <xsl:value-of select="normalize-space(text)"/>&lt;/li>
+      </xsl:if>
+      <xsl:if test="description">
+       &lt;li>Description: <xsl:value-of select="normalize-space(description)"/>&lt;/li>
+      </xsl:if>
+      <xsl:if test="solution">
+       &lt;li>Solution <xsl:value-of select="normalize-space(solution)"/>&lt;/li>
+      </xsl:if>
+      <xsl:if test="procedure">
+       &lt;li>Procedure <xsl:value-of select="normalize-space(procedure)"/>&lt;/li>
+      </xsl:if>
+      <xsl:if test="verification">
+       &lt;li>Verification <xsl:value-of select="normalize-space(verification)"/>&lt;/li>
+      </xsl:if>
+    * &lt;/ul>
+    */
    public static final class <xsl:value-of select="$inner-classname"/>
          extends <xsl:value-of select="$classname"/>
@@ -492 +526 @@
       </xsl:call-template>
    </xsl:variable>
-   /** The log message &lt;code&gt;<xsl:value-of select="./@name"/>&lt;/code&gt;. */
+   /** The log message for thwe event &lt;code&gt;<xsl:value-of select="./@name"/>&lt;/code&gt;. */
    public static final <xsl:value-of select="$inner-classname"/><xsl:text> </xsl:text><xsl:value-of select="./@name"/>
          = new <xsl:value-of select="$inner-classname"/>();
@@ -695 +729 @@
       /**
        * Logs the message
-       * <tt>"<xsl:value-of select="normalize-space($message/text)"/>"</tt>
+       * &lt;tt>"<xsl:value-of select="normalize-space($message/text)"/>"&lt;/tt>
        * with the given parameters.<xsl:call-template
                   name="inner-clazz-log-parameter-javadoc">
@@ -724 +758 @@
       /**
        * Logs the message
-       * <tt>"<xsl:value-of select="normalize-space($message/text)"/>"</tt>
+       * &lt;tt>"<xsl:value-of select="normalize-space($message/text)"/>"&lt;/tt>
        * with the given parameters.<xsl:call-template
                   name="inner-clazz-log-parameter-javadoc">
@@ -756 +790 @@
       /**
        * Logs the message
-       * <tt>"<xsl:value-of select="normalize-space($message/text)"/>"</tt>
+       * &lt;tt>"<xsl:value-of select="normalize-space($message/text)"/>"&lt;/tt>
        * with the given parameters to the custom logger.
        * @param logger the custom logger to log to.<xsl:call-template
@@ -764 +798 @@
                </xsl:call-template>
        */
-      public static void log (<xsl:value-of select="$custom-logger-class"/> logger<xsl:if 
-             test="$isAudit or normalize-space($tokens)">, <xsl:call-template
+      public static void log (<xsl:value-of select="$custom-logger-class"/> logger<xsl:if
+       test="$isAudit or normalize-space($tokens)">, <xsl:call-template
                   name="inner-clazz-log-parameter-list">
                   <xsl:with-param name="tokens" select="$tokens"/>
@@ -795 +829 @@
       /**
        * Logs the message
-       * <tt>"<xsl:value-of select="normalize-space($message/text)"/>"</tt>
+       * &lt;tt>"<xsl:value-of select="normalize-space($message/text)"/>"&lt;/tt>
        * with the given parameters to the custom logger.
        * @param logger the custom logger to log to.<xsl:call-template
@@ -804 +838 @@
        * @param cause the Throwable that causes this message to be logged.
        */
-      public static void log (<xsl:value-of select="$custom-logger-class"/> logger<xsl:if 
-             test="$isAudit or normalize-space($tokens)">, <xsl:call-template
+      public static void log (<xsl:value-of select="$custom-logger-class"/> logger<xsl:if
+       test="$isAudit or normalize-space($tokens)">, <xsl:call-template
                   name="inner-clazz-log-parameter-list">
                   <xsl:with-param name="tokens" select="$tokens"/>
                   <xsl:with-param name="isAudit" select="$isAudit"/>
-          </xsl:call-template></xsl:if>, 
+          </xsl:call-template></xsl:if>,
                Throwable cause
             )
@@ -842 +876 @@
       /**
        * Creates the audit log event
-       * <tt>"<xsl:value-of select="normalize-space($message/text)"/>"</tt>
+       * &lt;tt>"<xsl:value-of select="normalize-space($message/text)"/>"&lt;/tt>
        * with the given parameters.<xsl:call-template
                   name="inner-clazz-log-parameter-javadoc">
@@ -871 +905 @@
       /**
        * Creates the audit log event
-       * <tt>"<xsl:value-of select="normalize-space($message/text)"/>"</tt>
+       * &lt;tt>"<xsl:value-of select="normalize-space($message/text)"/>"&lt;/tt>
        * with the given parameters.<xsl:call-template
                   name="inner-clazz-log-parameter-javadoc">
@@ -903 +937 @@
 
       /**
-       * Adds the given message parameters to the <tt>loggable</tt>.
+       * Adds the given message parameters to the &lt;tt>loggable&lt;/tt>.
        * @param loggable the loggable to initialize. <xsl:call-template
                   name="inner-clazz-log-parameter-javadoc">
                   <xsl:with-param name="tokens" select="$tokens"/>
                </xsl:call-template>
-       * @return the given initialized <tt>loggable</tt>.
+       * @return the given initialized &lt;tt>loggable&lt;/tt>.
        */
       public static Loggable addParameters (Loggable loggable<xsl:if

trunk/src/xml/xsl/libcommon.xsl

@@ -1817 +1817 @@
 
     /**
-     * Translates a <tt>BigDecimal</tt> value into a
-     * <tt><xsl:value-of select="$classname"/></tt>.
+     * Translates a &lt;tt>BigDecimal&lt;/tt> value into a
+     * &lt;tt><xsl:value-of select="$classname"/>&lt;/tt>.
      *
-     * @param bd the <tt>BigDecimal</tt>.
-     * @return a <tt><xsl:value-of select="$classname"/></tt> whose value is equal
+     * @param bd the &lt;tt>BigDecimal&lt;/tt>.
+     * @return a &lt;tt><xsl:value-of select="$classname"/>&lt;/tt> whose value is equal
      *  to bd.
      * @throws ArgumentMalformedException If the given
-     *   <tt>BigDecimal</tt> violates the restriction
+     *   &lt;tt>BigDecimal&lt;/tt> violates the restriction
      *   of the <xsl:value-of select="$classname"/> type.
      */
@@ -1841 +1841 @@
 
     /**
-     * Translates a <tt>long</tt> value into a
-     * <tt><xsl:value-of select="$classname"/></tt>.
+     * Translates a &lt;tt>long&lt;/tt> value into a
+     * &lt;tt><xsl:value-of select="$classname"/>&lt;/tt>.
      *
-     * @param val the <tt>long</tt>.
-     * @return a <tt><xsl:value-of select="$classname"/></tt> whose value is equal
+     * @param val the &lt;tt>long&lt;/tt>.
+     * @return a &lt;tt><xsl:value-of select="$classname"/>&lt;/tt> whose value is equal
      *  to the given long.
      * @throws ArgumentMalformedException If the given
-     *   <tt>long</tt> violates the restriction
+     *   &lt;tt>long&lt;/tt> violates the restriction
      *   of the <xsl:value-of select="$classname"/> type.
      * @see BigDecimal#valueOf(long)
@@ -1870 +1870 @@
 
     /**
-     * Translates a <tt>long</tt> with the given scale into a
-     * <tt><xsl:value-of select="$classname"/></tt>.
+     * Translates a &lt;tt>long&lt;/tt> with the given scale into a
+     * &lt;tt><xsl:value-of select="$classname"/>&lt;/tt>.
      *
      * @param unscaledVal the unscaled value.
      * @param scale the scale to be applied.
-     * @return a <tt><xsl:value-of select="$classname"/></tt> whose value is
-     *         <tt>(unscaledVal &amp;times; 10<sup>-scale</sup>)</tt>.
+     * @return a &lt;tt><xsl:value-of select="$classname"/>&lt;/tt> whose value is
+     *         &lt;tt>(unscaledVal &amp;times; 10&lt;sup>-scale&lt;/sup>)&lt;/tt>.
      * @throws ArgumentMalformedException If the given
      *   long and scale violates the restriction