mocobeta opened a new pull request #1242: LUCENE-9201: Port documentation-lint task to Gradle build URL: https://github.com/apache/lucene-solr/pull/1242 # Description This PR adds an equivalent to "documentation-lint" to Gradle build. # Solution The `gradle/validation/documentation-lint.gradle` includes - `documentationLint` task that supposed to be called from `precommit` task, - a root project level sub-task `checkBrokenLinks`, - sub-project level sub-tasks `ecjJavadocLint`, `checkMissingJavadocsClass`, and `checkMissingJavadocsMethod`. # 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. e.g.; - 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?
---------------------------------------------------------------- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: us...@infra.apache.org With regards, Apache Git Services --------------------------------------------------------------------- To unsubscribe, e-mail: issues-unsubscr...@lucene.apache.org For additional commands, e-mail: issues-h...@lucene.apache.org
