[
https://issues.apache.org/jira/browse/LUCENE-9201?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17031702#comment-17031702
]
Tomoko Uchida commented on LUCENE-9201:
---------------------------------------
[~erickerickson] I added sub-tasks equivalent to the ant targets.
- -check-broken-links (this internally calls
{{dev-tools/scripts/checkJavadocLinks.py}})
- -check-missing-javadocs (this internally calls
{{dev-tools/scripts/checkJavaDocs.py}} )
And I opened a PR :)
[https://github.com/apache/lucene-solr/pull/1242]
I think this is almost equivalent to Ant's "documentation-lint", with some
notes below. [~erickerickson] [~dweiss] Could you review it?
*Note:*
For now, Python linters - {{checkBrokenLinks}}, {{checkMissingJavadocsClass}}
and {{checkMissingJavadocsMethod}} - will fail because the Gradle-generated
Javadocs seems to be slightly different to Ant-generated ones.
* Javadoc directory structure: "ant documentation" generates
"analyzers-common" docs dir for "analysis/common" module, but "gradlew javadoc"
generates "analysis/common" for the same module. I think we can adjust the
structure, but where is the suitable place to do so?
* Package summary: "ant documentation" uses "package.html" as package summary
description, but "gradlew javadoc" ignores "package.html" (so some packages
lacks summary description in "package-summary.html" when building javadocs by
Gradle). We might be able to make Gradle Javadoc task to properly handle
"package.html" files with some options. Or, should we replace all
"package.html" with "package-info.java" at this time?
After Gradle generated Javadoc is fixed, we can return to here and complete
this sub-task.
> 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
> Time Spent: 10m
> 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
