[
https://issues.apache.org/jira/browse/LUCENE-9209?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17032088#comment-17032088
]
ASF subversion and git services commented on LUCENE-9209:
---------------------------------------------------------
Commit 0d339043e378d8333c376bae89411b813de25b10 in lucene-solr's branch
refs/heads/master from Robert Muir
[ https://gitbox.apache.org/repos/asf?p=lucene-solr.git;h=0d33904 ]
LUCENE-9209: fix javadocs to be html5, enable doclint html checks, remove jtidy
Current javadocs declare an HTML5 doctype: !DOCTYPE HTML. Some HTML5
features are used, but unfortunately also some constructs that do not
exist in HTML5 are used as well.
Because of this, we have no checking of any html syntax. jtidy is
disabled because it works with html4. doclint is disabled because it
works with html5. our docs are neither.
javadoc "doclint" feature can efficiently check that the html isn't
crazy. we just have to fix really ancient removed/deprecated stuff
(such as use of tt tag).
This enables the html checking in both ant and gradle. The docs are
fixed via straightforward transformations.
One exception is table cellpadding, for this some helper CSS classes
were added to make the transition easier (since it must apply padding
to inner th/td, not possible inline). I added TODOs, we should clean
this up. Most problems look like they may have been generated from a
GUI or similar and not a human.
> fix javadocs to be html5, enable doclint html checks, remove jtidy
> ------------------------------------------------------------------
>
> Key: LUCENE-9209
> URL: https://issues.apache.org/jira/browse/LUCENE-9209
> Project: Lucene - Core
> Issue Type: Task
> Reporter: Robert Muir
> Priority: Major
> Attachments: LUCENE-9209.patch, LUCENE-9209_current_state.patch
>
>
> Currently doclint is very angry about all the {{<tt>}} elements and similar
> stuff going on. We claim to be emitting html5 documentation so it is about
> time to clean it up.
> Then the html check can simply be enabled and we can remove the jtidy stuff
> completely.
--
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
