[
https://issues.apache.org/jira/browse/XERCESJ-1781?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=18010011#comment-18010011
]
Samael Bate edited comment on XERCESJ-1781 at 7/26/25 3:47 PM:
---------------------------------------------------------------
[~elharo] I've done a lot more on [https://github.com/apache/xerces-j/pull/28]
which is now resolving a lot of issues. However, the ant build does a
_javadoc-replace_ target which is injecting unsupported tags into the javadoc
note that whilst all these tags are supported, using a heading tag inside a
*dt* tag isn't strictly valid.
{code:java}
<target name="javadoc-replace" unless="additional.param">
<replace token="@xerces.internal" dir="${build.src}">
<replacevalue><![CDATA[<dl><dt><h1
style="font-size:110%">INTERNAL:</h1><dd>Usage of this class is not supported.
It may be altered or removed at any time.</dd></dt></dl>]]></replacevalue>
</replace>
<replace token="@xerces.experimental" dir="${build.src}">
<replacevalue><![CDATA[<dl><dt><h1
style="font-size:150%">EXPERIMENTAL:</h1><dd>This class should not be
considered stable. It is likely to be altered or replaced in the
future.</dd></dt></dl>]]></replacevalue>
</replace>
</target> {code}
this results in a lot of errors like the following (as it's going into lots of
the built Java sources):
{noformat}
[javadoc] * <dl><dt><h1 style="font-size:110%">INTERNAL:</h1><dd>Usage of
this class is not supported. It may be altered or removed at any
time.</dd></dt></dl>
[javadoc] ^
[javadoc]
/home/user/repos/xerces-j/build/src/org/apache/html/dom/HTMLIsIndexElementImpl.java:22:
error: unexpected end tag: </dt>
[javadoc] * <dl><dt><h1 style="font-size:110%">INTERNAL:</h1><dd>Usage of
this class is not supported. It may be altered or removed at any
time.</dd></dt></dl>
[javadoc]
^
[javadoc]
/home/user/repos/xerces-j/build/src/org/apache/html/dom/HTMLLIElementImpl.java:22:
error: tag not allowed here: <h1>
[javadoc] * <dl><dt><h1 style="font-size:110%">INTERNAL:</h1><dd>Usage of
this class is not supported. It may be altered or removed at any
time.</dd></dt></dl>
[javadoc] ^
[javadoc]
/home/user/repos/xerces-j/build/src/org/apache/html/dom/HTMLLIElementImpl.java:22:
error: unexpected heading used: <H1>, compared to implicit preceding heading:
<H1>
[javadoc] * <dl><dt><h1 style="font-size:110%">INTERNAL:</h1><dd>Usage of
this class is not supported. It may be altered or removed at any
time.</dd></dt></dl>
[javadoc] ^
[javadoc]
/home/user/repos/xerces-j/build/src/org/apache/html/dom/HTMLLIElementImpl.java:22:
error: unexpected end tag: </dt>
[javadoc] * <dl><dt><h1 style="font-size:110%">INTERNAL:</h1><dd>Usage of
this class is not supported. It may be altered or removed at any
time.</dd></dt></dl>
[javadoc]
^
[javadoc]
/home/user/repos/xerces-j/build/src/org/apache/html/dom/HTMLLabelElementImpl.java:22:
error: tag not allowed here: <h1>
[javadoc] * <dl><dt><h1 style="font-size:110%">INTERNAL:</h1><dd>Usage of
this class is not supported. It may be altered or removed at any
time.</dd></dt></dl>
[javadoc] ^
[javadoc]
/home/user/repos/xerces-j/build/src/org/apache/html/dom/HTMLLabelElementImpl.java:22:
error: unexpected heading used: <H1>, compared to implicit preceding heading:
<H1>
[javadoc] * <dl><dt><h1 style="font-size:110%">INTERNAL:</h1><dd>Usage of
this class is not supported. It may be altered or removed at any
time.</dd></dt></dl>{noformat}
Ultimately the replacement html needs to be changed. As the current PR is
already fairly big I'd prefer to do this in a separate PR and just get the
current one merged for now.
I suspect the best solution will be to use:
{code:java}
<dl>
<dt>INTERNAL:</dt>
<dd>Usage of this class is not supported. It may be altered or removed at any
time.</dd>
</dl>{code}
was (Author: singingbush):
[~elharo] I've done a lot more on [https://github.com/apache/xerces-j/pull/28]
which is now resolving a lot of issues. However, the ant build does a
_javadoc-replace_ target which is injecting unsupported tags into the javadoc
{code:java}
<target name="javadoc-replace" unless="additional.param">
<replace token="@xerces.internal" dir="${build.src}">
<replacevalue><![CDATA[<dl><dt><h1
style="font-size:110%">INTERNAL:</h1><dd>Usage of this class is not supported.
It may be altered or removed at any time.</dd></dt></dl>]]></replacevalue>
</replace>
<replace token="@xerces.experimental" dir="${build.src}">
<replacevalue><![CDATA[<dl><dt><h1
style="font-size:150%">EXPERIMENTAL:</h1><dd>This class should not be
considered stable. It is likely to be altered or replaced in the
future.</dd></dt></dl>]]></replacevalue>
</replace>
</target> {code}
this results in a lot of errors like the following (as it's going into lots of
the built Java sources):
{noformat}
[javadoc] * <dl><dt><h1 style="font-size:110%">INTERNAL:</h1><dd>Usage of
this class is not supported. It may be altered or removed at any
time.</dd></dt></dl>
[javadoc] ^
[javadoc]
/home/user/repos/xerces-j/build/src/org/apache/html/dom/HTMLIsIndexElementImpl.java:22:
error: unexpected end tag: </dt>
[javadoc] * <dl><dt><h1 style="font-size:110%">INTERNAL:</h1><dd>Usage of
this class is not supported. It may be altered or removed at any
time.</dd></dt></dl>
[javadoc]
^
[javadoc]
/home/user/repos/xerces-j/build/src/org/apache/html/dom/HTMLLIElementImpl.java:22:
error: tag not allowed here: <h1>
[javadoc] * <dl><dt><h1 style="font-size:110%">INTERNAL:</h1><dd>Usage of
this class is not supported. It may be altered or removed at any
time.</dd></dt></dl>
[javadoc] ^
[javadoc]
/home/user/repos/xerces-j/build/src/org/apache/html/dom/HTMLLIElementImpl.java:22:
error: unexpected heading used: <H1>, compared to implicit preceding heading:
<H1>
[javadoc] * <dl><dt><h1 style="font-size:110%">INTERNAL:</h1><dd>Usage of
this class is not supported. It may be altered or removed at any
time.</dd></dt></dl>
[javadoc] ^
[javadoc]
/home/user/repos/xerces-j/build/src/org/apache/html/dom/HTMLLIElementImpl.java:22:
error: unexpected end tag: </dt>
[javadoc] * <dl><dt><h1 style="font-size:110%">INTERNAL:</h1><dd>Usage of
this class is not supported. It may be altered or removed at any
time.</dd></dt></dl>
[javadoc]
^
[javadoc]
/home/user/repos/xerces-j/build/src/org/apache/html/dom/HTMLLabelElementImpl.java:22:
error: tag not allowed here: <h1>
[javadoc] * <dl><dt><h1 style="font-size:110%">INTERNAL:</h1><dd>Usage of
this class is not supported. It may be altered or removed at any
time.</dd></dt></dl>
[javadoc] ^
[javadoc]
/home/user/repos/xerces-j/build/src/org/apache/html/dom/HTMLLabelElementImpl.java:22:
error: unexpected heading used: <H1>, compared to implicit preceding heading:
<H1>
[javadoc] * <dl><dt><h1 style="font-size:110%">INTERNAL:</h1><dd>Usage of
this class is not supported. It may be altered or removed at any
time.</dd></dt></dl>{noformat}
Ultimately the replacement html needs to be changed. As the current PR is
already fairly big I'd prefer to do this in a separate PR and just get the
current one merged for now.
> Fix Javadoc errors in build
> ---------------------------
>
> Key: XERCESJ-1781
> URL: https://issues.apache.org/jira/browse/XERCESJ-1781
> Project: Xerces2-J
> Issue Type: Task
> Reporter: Elliotte Rusty Harold
> Priority: Minor
>
> and they are numerous
--
This message was sent by Atlassian Jira
(v8.20.10#820010)
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
