messaging
messaging copied to clipboard
Published
20 hours ago •
jakartaee
jakartaee
Incorrect HTML in API documentation
There are some HTML errors in the released JMS 2.0 documentation at https://jms-spec.java.net/2.0/apidocs/index.html
For example, in the javadoc for Message: https://jms-spec.java.net/2.0/apidocs/javax/jms/Message.html
The JMS API reserves the JMS_<I>vendor_name</I> property
<I>arithmetic-expr1</I> [NOT] BETWEEN <I>arithmetic-expr2</I> AND <I>arithmetic-expr3</I> (comparison operator)
"age BETWEEN 15 AND 19" is equivalent to "age >= 15 AND age <= 19"
"age NOT BETWEEN 15 AND 19" is equivalent to "age < 15 OR age > 19"
The spurious <I> and   characters are caused by @code constructs containing HTML which is getting escaped by the javadoc program.
Affected Versions
[2.0]
- Issue Imported From: https://github.com/javaee/jms-spec/issues/127
- Original Issue Raised By:@glassfishrobot
- Original Issue Assigned To: Unassigned
@glassfishrobot Commented @nigeldeakin said: Changes to Message:
--- jms2.0/src/main/java/javax/jms/Message.java (revision 282)
+++ jms2.0/src/main/java/javax/jms/Message.java (working copy)
@@ -235,9 +235,9 @@
* Unless specifically noted, the values and semantics of the JMSX properties
* are undefined.
*
- * <P>The JMS API reserves the {@code JMS_<I>vendor_name</I>} property
+ * <P>The JMS API reserves the <CODE>JMS_<I>vendor_name</I></CODE> property
* name prefix for provider-specific properties. Each provider defines its own
- * value for {@code <I>vendor_name</I>}. This is the mechanism a JMS
+ * value for <CODE><I>vendor_name</I></CODE>. This is the mechanism a JMS
* provider uses to make its special per-message services available to a JMS
* client.
*
@@ -399,70 +399,70 @@
* <LI>Arithmetic operations must use numeric promotion in the Java
* programming language.
* </UL>
- * <LI>{@code <I>arithmetic-expr1</I> [NOT] BETWEEN <I>arithmetic-expr2</I>
- * AND <I>arithmetic-expr3</I>} (comparison operator)
+ * <LI><CODE><I>arithmetic-expr1</I> [NOT] BETWEEN <I>arithmetic-expr2</I>
+ * AND <I>arithmetic-expr3</I></CODE> (comparison operator)
* <UL>
- * <LI>{@code "age BETWEEN 15 AND 19"} is
+ * <LI><CODE>"age BETWEEN 15 AND 19"</CODE> is
* equivalent to
- * {@code "age >= 15 AND age <= 19"}
- * <LI>{@code "age NOT BETWEEN 15 AND 19"}
+ * <CODE>"age >= 15 AND age <= 19"</CODE>
+ * <LI><CODE>"age NOT BETWEEN 15 AND 19"</CODE>
* is equivalent to
- * {@code "age < 15 OR age > 19"}
+ * <CODE>"age < 15 OR age > 19"</CODE>
* </UL>
- * <LI>{@code <I>identifier</I> [NOT] IN (<I>string-literal1</I>,
- * <I>string-literal2</I>,...)} (comparison operator where
- * {@code <I>identifier</I>} has a {@code String} or
- * {@code NULL} value)
+ * <LI><CODE><I>identifier</I> [NOT] IN (<I>string-literal1</I>,
+ * <I>string-literal2</I>,...)</CODE> (comparison operator where
+ * <CODE><I>identifier</I></CODE> has a <CODE>String</CODE> or
+ * <CODE>NULL</CODE> value)
* <UL>
- * <LI>{@code "Country IN (' UK', 'US', 'France')"}
+ * <LI><CODE>"Country IN (' UK', 'US', 'France')"</CODE>
* is true for
- * {@code 'UK'} and false for {@code 'Peru'}; it is
+ * <CODE>'UK'</CODE> and false for <CODE>'Peru'</CODE>; it is
* equivalent to the expression
- * {@code "(Country = ' UK') OR (Country = ' US') OR (Country = ' France')"}
- * <LI>{@code "Country NOT IN (' UK', 'US', 'France')"}
- * is false for {@code 'UK'} and true for {@code 'Peru'}; it
+ * <CODE>"(Country = ' UK') OR (Country = ' US') OR (Country = ' France')"</CODE>
+ * <LI><CODE>"Country NOT IN (' UK', 'US', 'France')"</CODE>
+ * is false for <CODE>'UK'</CODE> and true for <CODE>'Peru'</CODE>; it
* is equivalent to the expression
- * {@code "NOT ((Country = ' UK') OR (Country = ' US') OR (Country = ' France'))"}
- * <LI>If identifier of an {@code IN} or {@code NOT IN}
- * operation is {@code NULL}, the value of the operation is
+ * <CODE>"NOT ((Country = ' UK') OR (Country = ' US') OR (Country = ' France'))"</CODE>
+ * <LI>If identifier of an <CODE>IN</CODE> or <CODE>NOT IN</CODE>
+ * operation is <CODE>NULL</CODE>, the value of the operation is
* unknown.
* </UL>
- * <LI>{@code <I>identifier</I> [NOT] LIKE <I>pattern-value</I> [ESCAPE
- * <I>escape-character</I>]} (comparison operator, where
- * {@code <I>identifier</I>} has a {@code String} value;
- * {@code <I>pattern-value</I>} is a string literal where
- * {@code '_'} stands for any single character; {@code '%'}
+ * <LI><CODE><I>identifier</I> [NOT] LIKE <I>pattern-value</I> [ESCAPE
+ * <I>escape-character</I>]</CODE> (comparison operator, where
+ * <CODE><I>identifier</I></CODE> has a <CODE>String</CODE> value;
+ * <CODE><I>pattern-value</I></CODE> is a string literal where
+ * <CODE>'_'</CODE> stands for any single character; <CODE>'%'</CODE>
* stands for any sequence of characters, including the empty sequence;
* and all other characters stand for themselves. The optional
- * {@code <I>escape-character</I>} is a single-character string
+ * <CODE><I>escape-character</I></CODE> is a single-character string
* literal whose character is used to escape the special meaning of the
- * {@code '_'} and {@code '%'} in
- * {@code <I>pattern-value</I>}.)
+ * <CODE>'_'</CODE> and <CODE>'%'</CODE> in
+ * <CODE><I>pattern-value</I></CODE>.)
* <UL>
- * <LI>{@code "phone LIKE '12%3'"} is true for
- * {@code '123'} or {@code '12993'} and false for
- * {@code '1234'}
- * <LI>{@code "word LIKE 'l_se'"} is true for
- * {@code 'lose'} and false for {@code 'loose'}
- * <LI>{@code "underscored LIKE '\_%' ESCAPE '\'"}
- * is true for {@code '_foo'} and false for {@code 'bar'}
- * <LI>{@code "phone NOT LIKE '12%3'"} is false for
- * {@code '123'} or {@code '12993'} and true for
- * {@code '1234'}
- * <LI>If {@code <I>identifier</I>} of a {@code LIKE} or
- * {@code NOT LIKE} operation is {@code NULL}, the value
+ * <LI><CODE>"phone LIKE '12%3'"</CODE> is true for
+ * <CODE>'123'</CODE> or <CODE>'12993'</CODE> and false for
+ * <CODE>'1234'</CODE>
+ * <LI><CODE>"word LIKE 'l_se'"</CODE> is true for
+ * <CODE>'lose'</CODE> and false for <CODE>'loose'</CODE>
+ * <LI><CODE>"underscored LIKE '\_%' ESCAPE '\'"</CODE>
+ * is true for <CODE>'_foo'</CODE> and false for <CODE>'bar'</CODE>
+ * <LI><CODE>"phone NOT LIKE '12%3'"</CODE> is false for
+ * <CODE>'123'</CODE> or <CODE>'12993'</CODE> and true for
+ * <CODE>'1234'</CODE>
+ * <LI>If <CODE><I>identifier</I></CODE> of a <CODE>LIKE</CODE> or
+ * <CODE>NOT LIKE</CODE> operation is <CODE>NULL</CODE>, the value
* of the operation is unknown.
* </UL>
- * <LI>{@code <I>identifier</I> IS NULL} (comparison operator that tests
+ * <LI><CODE><I>identifier</I> IS NULL</CODE> (comparison operator that tests
* for a null header field value or a missing property value)
* <UL>
- * <LI>{@code "prop_name IS NULL"}
+ * <LI><CODE>"prop_name IS NULL"</CODE>
* </UL>
- * <LI>{@code <I>identifier</I> IS NOT NULL} (comparison operator that
+ * <LI><CODE><I>identifier</I> IS NOT NULL</CODE> (comparison operator that
* tests for the existence of a non-null header field value or a property
* value)
* <UL>
- * <LI>{@code "prop_name IS NOT NULL"}
+ * <LI><CODE>"prop_name IS NOT NULL"</CODE>
* </UL>
*
* <P>JMS providers are required to verify the syntactic correctness of a
@@ -1349,8 +1349,8 @@
*
* <P>This method can be used to return, in objectified format,
* an object that has been stored as a property in the message with the
- * equivalent {@code setObjectProperty} method call, or its equivalent
- * primitive {@code set<I>type</I>Property} method.
+ * equivalent <CODE>setObjectProperty</CODE> method call, or its equivalent
+ * primitive <CODE>set<I>type</I>Property</CODE> method.
*
* @param name the name of the Java object property
*
@glassfishrobot Commented @nigeldeakin said: Changes to JMSProducer
--- src/main/java/javax/jms/JMSProducer.java (revision 282)
+++ src/main/java/javax/jms/JMSProducer.java (working copy)
@@ -1015,7 +1015,7 @@
* This method can be used to return, in objectified format, an object that
* has been stored as a property in the message with the equivalent
* {@code setObjectProperty} method call, or its equivalent primitive
- * {@code set<I>type</I>Property} method.
+ * <code>set<I>type</I>Property</code> method.
*
* @param name
* the name of the property
@glassfishrobot Commented @nigeldeakin said: Changes to MapMessage:
--- src/main/java/javax/jms/MapMessage.java (revision 282)
+++ src/main/java/javax/jms/MapMessage.java (working copy)
@@ -269,7 +269,7 @@
* an object in the Java programming language ("Java object") that had
* been stored in the Map with the equivalent
* {@code setObject} method call, or its equivalent primitive
- * {@code set<I>type</I>} method.
+ * <code>set<I>type</I></code> method.
*
* <P>Note that byte values are returned as {@code byte[]}, not
* {@code Byte[]}.
@glassfishrobot Commented @nigeldeakin said: Changes to StreamMessage
--- src/main/java/javax/jms/StreamMessage.java (revision 282)
+++ src/main/java/javax/jms/StreamMessage.java (working copy)
@@ -331,7 +331,7 @@
* an object in the Java programming language ("Java object") that has
* been written to the stream with the equivalent
* {@code writeObject} method call, or its equivalent primitive
- * {@code write<I>type</I>} method.
+ * <code>write<I>type</I></code> method.
*
* <P>Note that byte values are returned as {@code byte[]}, not
* {@code Byte[]}.
@glassfishrobot Commented This issue was imported from java.net JIRA JMS_SPEC-127
