[
https://issues.apache.org/jira/browse/LUCENE-9201?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17034121#comment-17034121
]
Tomoko Uchida edited comment on LUCENE-9201 at 2/11/20 4:43 AM:
----------------------------------------------------------------
One small thing about the equivalent "ant documentation" (gradle built-in
Javadoc task or our customized one),
I think it'd be better the javadoc generation task outputs all javadocs to
module-wide common directory (e.g., {{lucene/build/docs}} or
{{solr/build/docs}}) just like ant build does, instead of each module's build
directory. This makes things easy for succeeding "broken links check" (running
{{checkJavadocLinks.py}} - or its replacement?) and release managers work that
should includes updating the official documentation site
([https://cwiki.apache.org/confluence/display/LUCENE/ReleaseTodo#ReleaseTodo-Pushdocs,changesandjavadocstotheCMSproductiontree]).
was (Author: tomoko uchida):
One small thing about the equivalent "ant documentation" (gradle built-in
Javadoc task or our customized one),
I think it'd be better the javadoc generation task should output all javadocs
to module-wide common directory (e.g., {{lucene/build/docs}} or
{{solr/build/docs}}) just ant build does, instead of each module's build
directory. This makes things easy for succeeding "broken links check" (running
{{checkJavadocLinks.py}} - or its replacement?) and release managers work that
should includes updating the official documentation site
([https://cwiki.apache.org/confluence/display/LUCENE/ReleaseTodo#ReleaseTodo-Pushdocs,changesandjavadocstotheCMSproductiontree]).
> 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: [email protected]
For additional commands, e-mail: [email protected]