lucene-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Michael McCandless (JIRA)" <j...@apache.org>
Subject [jira] [Commented] (LUCENE-4010) AttributeSource api has broken documentation due to java generics bug
Date Mon, 23 Apr 2012 13:31:34 GMT

    [ https://issues.apache.org/jira/browse/LUCENE-4010?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13259598#comment-13259598
] 

Michael McCandless commented on LUCENE-4010:
--------------------------------------------

Hmm, true.

But I think never linking to any API w/ generics is insanity (the cure is worse than the bug..).
 At least, the link works (it's just that the link text is missing the type param).

So I think this is a WONTFIX...?
                
> AttributeSource api has broken documentation due to java generics bug
> ---------------------------------------------------------------------
>
>                 Key: LUCENE-4010
>                 URL: https://issues.apache.org/jira/browse/LUCENE-4010
>             Project: Lucene - Java
>          Issue Type: Improvement
>          Components: general/javadocs
>            Reporter: Michael McCandless
>            Priority: Minor
>
> There seems to be a javadocs generation bug, whereby generic type params are not properly
escaped.  So if you use <A> as a type param (which we do in AttributeSource.java), it
produces invalid HTML.  The bug seems to be fixed in java 7...
> You can see the bug here (search for "after adding"):
>     http://lucene.apache.org/core/old_versioned_docs/versions/3_5_0/api/all/org/apache/lucene/util/AttributeSource.html
> The <A> generic type is gone, and that closing paren is red but should be blue.
> The 3.6.0 javadocs are OK because we used java7 to generate them...
> I think we should avoid <A> to workaround it until we are on java 7...

--
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-unsubscribe@lucene.apache.org
For additional commands, e-mail: dev-help@lucene.apache.org


Mime
View raw message