-
Notifications
You must be signed in to change notification settings - Fork 12
[XERCESJ-1781] Javadoc fixes for html in org.apache.xerces #47
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.
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
Conversation
elharo
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Near as I can tell captions on tables are not required in both XHTML 1.0 and the "Living Standard". They're recommended but not with empty content
yeah, it's odd that the Javadoc linter has been set to treat the lack of a captions block as an error |
elharo
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
You need to remove the empty captions
I'll push another commit that reverts them. That will of course leave errors such as: I'd recommend going the other way and just deciding on some text to use in the caption. I do agree that the javadoc process should not consider this an error though. Perhaps it should be raised with Open JDK |
elharo
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
You can add captions in a separate PR if you like, but they need to be meaningful and useful, not pro forma placeholders. If it makes more sense for a table to not have a caption it shouldn't have one, warning or not.
| * <p> | ||
| * <code>[10] AttValue ::= '"' ([^<&"] | Reference)* '"' | "'" ([^<&'] | Reference)* "'"</code> | ||
| * </p> | ||
| * <pre> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think p is more appropriate than pre here. Whitespace can be collapsed here
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
updated
Some more html fixes for errors in Javadoc generation. Mostly handling chars like
<and&correctly. Not that tables need to have acaptiontag. I've left it blank as there was previously no caption anyway. This at least prevents html errors in Javadoc (note that empty caption is a warning)