jakartaee / jakartaee/messaging

Incorrect HTML in API documentation

Open
#127 8 comments 0 reactions 0 assignees View on GitHub
jms20-errata Priority: Major Type: Bug
Dominant language
Java
Stars
49
Forks
34
PR merge metrics
No merged PRs in 30d

Description

There are some HTML errors in the released JMS 2.0 documentation at
[https://jms-spec.java.net/2.0/apidocs/index.html](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](https://jms-spec.java.net/2.0/apidocs/javax/jms/Message.html)

```
The JMS API reserves the JMS_vendor_name property
```
```
arithmetic-expr1 [NOT] BETWEEN arithmetic-expr2 AND arithmetic-expr3 (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 and   characters are caused by @code constructs containing HTML which is getting escaped by the javadoc program.
#### Affected Versions
[2.0]

Contributor guide

Open the contributing guide

Research direction

Start by examining the JMS 2.0 API documentation pages, especially Message.html, and trace the displayed examples back to their Javadoc @code constructs. Reproduce the documentation output to identify the escaping behavior; done means the affected examples render as valid HTML without spurious tags or entities.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.