Skip to content

apidoc html compliance part 1 - #8302

Merged
ebarboni merged 1 commit into
apache:masterfrom
ebarboni:apidocstructbulk1
Mar 10, 2025
Merged

ebarboni merged 1 commit into
apache:masterfrom
ebarboni:apidocstructbulk1

Conversation

@ebarboni

@ebarboni ebarboni commented Mar 7, 2025 •

Copy link
Copy Markdown
Contributor

This is a PR out of 5 (I hope) where I execute the apidoc not using codesnippet-doclet.

<arg value="--allow-script-in-comments" if:true="${javadoc23.or.later}" `/>`
<arg value="--snippet-path ${javadoc.base}/test/unit/src:${javadoc.base}/src" if:true="${javadoc23.or.later}" />
<arg value="-Xdoclint:all" />
<arg value="-Xdoclint:-missing" />

javadoc 23 is checking hard for correct header sequence, removed attribute and element, and if an error is detected it break generation for the current module.

I would like to anticipate and having apidoc base clean to this aspect so I could focus on xslt management to get jdk23 looking docs later.

As header sequence changed I added more header to the link checker.

With default apidoc pages like https://bits.netbeans.org/dev/javadoc/org-netbeans-api-visual/org/netbeans/api/visual/widget/doc-files/documentation.html that render out of structure looks a bit better integrated:

image

@ebarboni ebarboni added the JavaDoc [ci] enable java/javadoc tests and build-javadoc target label Mar 7, 2025
@ebarboni ebarboni added this to the NB26 milestone Mar 7, 2025
@ebarboni
ebarboni requested a review from mbien March 7, 2025 16:40

@mbien mbien left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a PR out of 5 (I hope)

can you update commit and PR title to indicate what clusters/modules this covers if this is a multi-part PR?

@ebarboni

Copy link
Copy Markdown
Contributor Author

it's 25 out of approx 140 modules in the javadoc build order (on master branch). It goes to ide folder and back to platform. Not sure how to present that.

@mbien

mbien commented Mar 10, 2025

Copy link
Copy Markdown
Member

well. give it a number at least, e.g: apidoc html compliance part 1

@ebarboni
ebarboni force-pushed the apidocstructbulk1 branch from ce45887 to a1a3077 Compare March 10, 2025 14:17
@ebarboni ebarboni changed the title apidoc html compliance apidoc html compliance part 1 Mar 10, 2025
@ebarboni

Copy link
Copy Markdown
Contributor Author

roger

@ebarboni
ebarboni merged commit 3f056f4 into apache:master Mar 10, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

JavaDoc [ci] enable java/javadoc tests and build-javadoc target

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants