Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

javadoc build errors under jdk17.0.7 #671

Closed
starksm64 opened this issue May 16, 2023 · 2 comments · Fixed by #672
Closed

javadoc build errors under jdk17.0.7 #671

starksm64 opened this issue May 16, 2023 · 2 comments · Fixed by #672
Assignees
@starksm64
Milestone
CDI 4.1

Comments

@starksm64
Copy link
Contributor

starksm64 commented May 16, 2023 •
edited
Loading

While testing out a new linux system, I tried building the current cdi master and found a few errors due to javadoc issues. This builds fine under jdk11, but the errors seem correct so I assume the checking has gotten stricter.

These are the 5 errors I see:

/home/starksm/Dev/Jakarta/cdi/api/src/main/java/jakarta/decorator/package-info.java:35: error: heading used out of sequence: <H3>, compared to implicit preceding heading: <H1>
 * <h3>Decorated types</h3>
   ^
/home/starksm/Dev/Jakarta/cdi/api/src/main/java/jakarta/enterprise/context/package-info.java:32: error: heading used out of sequence: <H3>, compared to implicit preceding heading: <H1>
 * <h3>Built-in scopes</h3>
   ^
/home/starksm/Dev/Jakarta/cdi/api/src/main/java/jakarta/enterprise/event/package-info.java:40: error: heading used out of sequence: <H3>, compared to implicit preceding heading: <H1>
 * <h3>Event objects and event types</h3>
   ^
/home/starksm/Dev/Jakarta/cdi/api/src/main/java/jakarta/enterprise/inject/spi/package-info.java:31: error: heading used out of sequence: <H3>, compared to implicit preceding heading: <H1>
 * <h3>The <code>BeanManager</code> object</h3>
home/starksm/Dev/Jakarta/cdi/api/src/main/java/jakarta/enterprise/event/Observes.java:109: error: unexpected end tag: </p>
 * </p>

There are also a ton of warnings about no comments that can be addressed later.
@starksm64 starksm64 self-assigned this May 16, 2023
starksm64 added a commit to jakartaredhat/cdi-master that referenced this issue May 16, 2023
@starksm64
Address the javadoc errors under jdk17, jakartaee#671
c47cd66 
Signed-off-by: Scott M Stark <starksm64@gmail.com>
@manovotn manovotn linked a pull request May 16, 2023 that will close this issue
Address the javadoc errors under jdk17 #672
Merged
@Emily-Jiang
Copy link
Contributor

I have seen this one before. I think the simple fix is to update to h2, which is valid under Java 17.

@Emily-Jiang
Copy link
Contributor

ah, I saw your PR now. +1

@Ladicek Ladicek mentioned this issue May 23, 2023
Merged
Ladicek pushed a commit that referenced this issue May 23, 2023
@starksm64
Address the javadoc errors under jdk17 (#672)
b1f023b 
* Address the javadoc errors under jdk17, #671
* Add Java 17 to the actions matrix

Signed-off-by: Scott M Stark <starksm64@gmail.com>
@Ladicek Ladicek added this to the CDI 4.1 milestone May 24, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@starksm64 starksm64

Labels
None yet
Projects
None yet
Milestone
CDI 4.1
Development

Successfully merging a pull request may close this issue.

Address the javadoc errors under jdk17 jakartaredhat/cdi-master
3 participants
@starksm64 @Ladicek @Emily-Jiang