[
https://issues.apache.org/jira/browse/LUCENE-4011?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]
Chris Male updated LUCENE-4011:
-------------------------------
Attachment: LUCENE-4011-core-links.patch
IntelliJ can also identify what it deems to be broken links, primarily when a
class or method do not exist, or when a class is used in a link but not
imported.
I'm attaching a patch which fixes these for lucene-core. Tell me what you
think.
> Check for broken documentation links in hudson
> ----------------------------------------------
>
> Key: LUCENE-4011
> URL: https://issues.apache.org/jira/browse/LUCENE-4011
> Project: Lucene - Java
> Issue Type: Task
> Components: general/javadocs
> Reporter: Robert Muir
> Fix For: 4.0
>
> Attachments: LUCENE-4011-core-links.patch
>
>
> Mike added a cool script to dev-tools (checkJavadocLinks.py) that checks
> all local links in our documentation.
> I think we really need to check this in hudson and fail on any errors, for
> these reasons:
> * javadocs external linking is really broken, so 'ant javadocs' doesnt find
> all errors.
> for example you can do this:
> {noformat}
> {@link java.lang.JavaDocsSucks}
> {noformat}
> and nothing will ever give you any warning: just a broken link. thats
> because javadocs
> external linking is fundamentally package-driven, broken by design for
> compile-time
> verification of correctness.
> * some documentation files have internal href links which should be checked
> to be correct.
> * this checker finds broken html links like unescaped slashes that we
> currently don't catch.
> * this checker finds real API bugs that javadocs won't warn about, such as
> protected methods
> returning package-private classes and so on.
> Once we fix the broken links we should be able to enforce all of this stuff
> in hudson, helping
> to prevent our documentation from growing wildly out of date.
--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators:
https://issues.apache.org/jira/secure/ContactAdministrators!default.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscr...@lucene.apache.org
For additional commands, e-mail: dev-h...@lucene.apache.org
