Skip to content

Conversation

@SingingBush
Copy link
Contributor

@SingingBush SingingBush commented Nov 10, 2025

Some more html fixes for errors in Javadoc generation. Mostly handling chars like < and & correctly. Not that tables need to have a caption tag. 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)

Copy link
Contributor

@elharo elharo left a 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

@SingingBush
Copy link
Contributor Author

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

@SingingBush SingingBush requested a review from elharo November 11, 2025 00:23
Copy link
Contributor

@elharo elharo left a 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

@SingingBush
Copy link
Contributor Author

SingingBush commented Nov 13, 2025

You need to remove the empty captions

I'll push another commit that reverts them. That will of course leave errors such as:

  [javadoc] /home/user/apache/xerces-j/build/src/org/apache/xerces/xs/datatypes/package.html:220: error: no caption for table
  [javadoc] </TABLE>
  [javadoc] ^

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

Copy link
Contributor

@elharo elharo left a 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>
Copy link
Contributor

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

Copy link
Contributor Author

Choose a reason for hiding this comment

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

updated

@SingingBush SingingBush requested a review from elharo November 14, 2025 08:56
@elharo elharo merged commit 4dc851c into apache:main Nov 14, 2025
4 checks passed
@SingingBush SingingBush deleted the javadoc/XERCES-1781-part-9 branch November 14, 2025 13:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants