[
https://issues.apache.org/jira/browse/LUCENE-9201?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17034357#comment-17034357
]
Robert Muir commented on LUCENE-9201:
-------------------------------------
"documentation-lint" checker lints more than just javadocs. Some of the stuff
is generated from markdown etc.
Look at main page: http://lucene.apache.org/core/8_4_1/
That's the start to our generated documentation page. It links to every module
:)
Implicit links:
These implicit links (case 1 and case 2) go to the appropriate dependency based
on java package. This is the linkoffline stuff.
Have a look at: http://lucene.apache.org/core/8_4_1/analyzers-icu/index.html
Case 1: Look at ICUTokenizerFactory and how e.g. ResourceLoaderAware links to
analyzers-common
Case 2: On the other hand look at ICUTokenizerFactory and how Tokenizer links
to lucene-core
Explicit links:
Have a look at
http://lucene.apache.org/core/8_4_1/core/org/apache/lucene/analysis/Analyzer.html
See where it says "For some concrete implementations bundled with Lucene, look
in the analysis modules" and then it links to different implementations across
different modules. This uses a different type of link, not auto-generated
magically based on packages but instead explicitly referenced based on docRoot.
So for example, core Analyzer class links to whole "analyzers-icu" module via
{{<a href="{@docRoot}/../analyzers-icu/overview-summary.html">ICU</a>}}
Currently, documentation is not structured "per-module" but really as a whole
package for all of lucene. (at least that is how i think about it). There are a
lot of dependencies and references implemented via links, that is why the links
checker is critical. It is also why "per-module build" is a huge mismatch to
how the documentation is structured.
> 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: 50m
> 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
