Skip to content

disable doclint #38

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

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

disable doclint #38

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8d4f38c
disable doclint
elharo Oct 24, 2025
049c748
Merge branch 'main' into doclint
elharo Oct 26, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 16 additions & 7 deletions build.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -133,7 +133,7 @@ Authors:
<echo message=" jars-schema11 --> 'jars' + XML Schema 1.1 support"/>
<echo message=" xjavac-jar --> generates the xjavac.jar file"/>
<echo message=" docs --> generates the HTML documentation"/>
<echo message=" javadocs --> generates the API docs (needs Java 1.2 or higher)"/>
<echo message=" javadocs --> generates the API docs"/>
<echo message=" samples --> compiles the samples source code"/>
<echo message=" compile --> compiles the source code"/>
<echo message=" deprecatedjar --> generates the xerces.jar file"/>
Expand Down Expand Up @@ -525,7 +525,9 @@ Authors:
windowtitle='XML Standard API' doctitle='XML Standard API'
bottom='${copyright}'
additionalparam='${additional.param}'
/>
>
<arg value="-Xdoclint:none"/>
</javadoc>
Comment on lines +528 to +530
Copy link

Copilot AI Oct 26, 2025

Choose a reason for hiding this comment

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

[nitpick] The indentation of the <arg> element is inconsistent with the surrounding XML structure. The <arg> element should be indented to align with other child elements of the <javadoc> tag. Consider using consistent indentation (typically 2 or 4 spaces per level) throughout all javadoc tasks.

Copilot uses AI. Check for mistakes.
<mkdir dir='${build.dir}/docs/javadocs/xni'/>
<javadoc packagenames='org.apache.xerces.xni.*'
locale='en_US'
Expand All @@ -535,7 +537,9 @@ Authors:
doctitle='Xerces Native Interface'
bottom='${copyright}'
additionalparam='${additional.param}'
/>
>
<arg value="-Xdoclint:none"/>
</javadoc>
Comment on lines +540 to +542
Copy link

Copilot AI Oct 26, 2025

Choose a reason for hiding this comment

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

[nitpick] The indentation of the <arg> element is inconsistent with the surrounding XML structure. The <arg> element should be indented to align with other child elements of the <javadoc> tag. Consider using consistent indentation (typically 2 or 4 spaces per level) throughout all javadoc tasks.

Copilot uses AI. Check for mistakes.
<mkdir dir='${build.dir}/docs/javadocs/xs'/>
<javadoc packagenames='org.apache.xerces.xs, org.apache.xerces.xs.datatypes'
locale='en_US'
Expand All @@ -545,7 +549,9 @@ Authors:
doctitle='XML Schema API'
bottom='${copyright}'
additionalparam='${additional.param}'
/>
>
<arg value="-Xdoclint:none"/>
</javadoc>
Comment on lines +552 to +554
Copy link

Copilot AI Oct 26, 2025

Choose a reason for hiding this comment

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

[nitpick] The indentation of the <arg> element is inconsistent with the surrounding XML structure. The <arg> element should be indented to align with other child elements of the <javadoc> tag. Consider using consistent indentation (typically 2 or 4 spaces per level) throughout all javadoc tasks.

Copilot uses AI. Check for mistakes.

<mkdir dir='${build.dir}/docs/javadocs/xerces2'/>
<javadoc packagenames='org.apache.xerces.dom.*,
Expand All @@ -564,7 +570,9 @@ Authors:
doctitle='Xerces2 Implementation'
bottom='${copyright}'
additionalparam='${additional.param}'
/>
>
<arg value="-Xdoclint:none"/>
Copy link
Contributor

@SingingBush SingingBush Oct 26, 2025

Choose a reason for hiding this comment

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

Setting -Xdoclint:none for javax.xml.*,org.w3c.*,org.xml.* is reasonable but for the packages under org.apache.xerces it should really be -Xdoclint:all (perhaps -Xdoclint:all -Xdoclint:-missing is reasonable).

Also it would be preferable to set the following on the xerces code:

      failonerror='yes'
      failonwarning='yes'

these Javadoc issues can be resolved with minimal effort. A lot of the errors are just invalid html in classes like EncodingMap. As for the warnings, as long as publicly accessible methods have all params and return values documented then it should be acceptable. Potentially failonwarning could be no as long as those things are covered

</javadoc>
Comment on lines +573 to +575
Copy link

Copilot AI Oct 26, 2025

Choose a reason for hiding this comment

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

[nitpick] The indentation of the <arg> element is inconsistent with the surrounding XML structure. The <arg> element should be indented to align with other child elements of the <javadoc> tag. Consider using consistent indentation (typically 2 or 4 spaces per level) throughout all javadoc tasks.

Copilot uses AI. Check for mistakes.
<mkdir dir='${build.dir}/docs/javadocs/other'/>
<javadoc packagenames='org.apache.html.*,
org.apache.wml.*,
Expand All @@ -575,7 +583,9 @@ Authors:
windowtitle='Other Classes' doctitle='Other Classes'
bottom='${copyright}'
additionalparam='${additional.param}'
/>
>
<arg value="-Xdoclint:none"/>
</javadoc>
Comment on lines +586 to +588
Copy link

Copilot AI Oct 26, 2025

Choose a reason for hiding this comment

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

[nitpick] The indentation of the <arg> element is inconsistent with the surrounding XML structure. The <arg> element should be indented to align with other child elements of the <javadoc> tag. Consider using consistent indentation (typically 2 or 4 spaces per level) throughout all javadoc tasks.

Copilot uses AI. Check for mistakes.
</target>

<!-- =================================================================== -->
Expand All @@ -600,7 +610,6 @@ Authors:
/>
</copy>


<copy todir="${distsrc.dir}/data" >
<fileset
dir="${data.dir}"
Expand Down