[
https://issues.apache.org/jira/browse/LUCENE-9496?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17189349#comment-17189349
]
Dawid Weiss commented on LUCENE-9496:
-------------------------------------
There is definitely some effort in parsing those links (especially cross-code
links) and verifying what's valid and what's suspicious (or wrong). It is quite
fun though (like I said, I touched that API before) and isolated. Maybe
somebody with some time on their hands would be willing to undertake it.
I'd really like to move forward the build split that's needed for Solr TLP
task. This part is crucial for other things (proper packaging, maven, etc.) -
they're all intertwined. All this isn't in any way related to my daily job or
life in general so apologies for slow progress; open source is still a hobby
for some of us. :)
> Replace (or accelerate) check-broken-links.gradle with a doclet pass
> --------------------------------------------------------------------
>
> Key: LUCENE-9496
> URL: https://issues.apache.org/jira/browse/LUCENE-9496
> Project: Lucene - Core
> Issue Type: Task
> Reporter: Dawid Weiss
> Priority: Minor
>
> This is just a placeholder, but perhaps somebody will find the time to push
> this forward. The current python script in check-broken-links reparses all
> emitted HTML files to find links. I have a strong feeling this could be done
> better.
> Javadoc doclets have access to parse trees for both the code and the javadoc
> comments (including information about HTML tags, code links, etc.). For
> example, this information is used by the built-in javac HTML linter.
> Maybe we could replace the python linter entirely; verify where code links
> will point at, where existing HTML links point to and validate this
> information. I wrote some of that link-parsing code in Carrot2 (to convert
> javadocs into a structured JSON format used in other documentation). The code
> there is free to eyeball and borrow, if needed.
> https://docs.oracle.com/en/java/javase/11/docs/api/jdk.compiler/com/sun/source/util/DocTreeScanner.html
> https://github.com/carrot2/carrot2/blob/master/infra/jsondoclet/src/main/java/com/carrotsearch/jsondoclet/JavaDocsVisitor.java#L135
> https://github.com/carrot2/carrot2/blob/master/infra/jsondoclet/src/main/java/com/carrotsearch/jsondoclet/PlainReferenceConverter.java
--
This message was sent by Atlassian Jira
(v8.3.4#803005)
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]