[
https://issues.apache.org/jira/browse/LUCENE-9201?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17033936#comment-17033936
]
Robert Muir commented on LUCENE-9201:
-------------------------------------
maybe we should try to get the PR in and iterate from there? It find a lot of
problems! Maybe we should break into issues.
as far as the pr itself:
* if the new lint task fails, maybe that is ok for now? there are problems.
* i didnt look much into the actual innards of the PR, so I am not opinionated
on that. I have been trying to chase down what it finds.
as far as javadoc generation itself, it is buggy, and we should fix it.
* package.html (and maybe other files) are not included so we need to e.g. use
the ant-task from gradle or something else. solving the "split package problem"
and doing package-info.java seems much more difficult.
* some linkoffline is missing, this breaks cross-module links.
as far as checkers themselves:
* html validation is enabled and jtidy removed: LUCENE-9209.
* prototype doclet to replace checkJavaDocs.py: LUCENE-9215.
* checkJavadocLinks.py is tougher to replace, but a lot of the issues it finds
are better discovered with javac warnings if the module system is enabled.
These are API bugs (where public method returns package-private stuff, etc).
There are even some of these bugs today that python does not find. You will
find them if you start adding module-info.java's. This is a difficult issue
because it involves dealing with split-package problem.
* ecj-javadocs-lint is not really doing what it says. actually the main check
thing it does right now is to fail on unused imports. Would love to not need
the separate pass for that, but
https://bugs.openjdk.java.net/browse/JDK-4963930 is not encouraging.
> Port documentation-lint task to Gradle build
> --------------------------------------------
>
> Key: LUCENE-9201
> URL: https://issues.apache.org/jira/browse/LUCENE-9201
> Project: Lucene - Core
> Issue Type: Sub-task
> Affects Versions: master (9.0)
> Reporter: Tomoko Uchida
> Assignee: Tomoko Uchida
> Priority: Major
> Attachments: javadocGRADLE.png, javadocHTML4.png, javadocHTML5.png
>
> Time Spent: 40m
> Remaining Estimate: 0h
>
> Ant build's "documentation-lint" target consists of those two sub targets.
> * "-ecj-javadoc-lint" (Javadoc linting by ECJ)
> * "-documentation-lint"(Missing javadocs / broken links check by python
> scripts)
--
This message was sent by Atlassian Jira
(v8.3.4#803005)
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscr...@lucene.apache.org
For additional commands, e-mail: issues-h...@lucene.apache.org
