You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@lucene.apache.org by "Michael McCandless (JIRA)" <ji...@apache.org> on 2012/04/22 19:17:32 UTC
[jira] [Created] (LUCENE-4010) AttributeSource api has broken
documentation due to java generics bug
Michael McCandless created LUCENE-4010:
------------------------------------------
Summary: 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
[jira] [Commented] (LUCENE-4010) AttributeSource api has broken
documentation due to java generics bug
Posted by "Uwe Schindler (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/LUCENE-4010?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13259210#comment-13259210 ]
Uwe Schindler commented on LUCENE-4010:
---------------------------------------
I checked it, it *always* produces invalid HTML, you can use any type param you want. Same happens with <B>,... We should simply remove the @link.
> 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
[jira] [Commented] (LUCENE-4010) AttributeSource api has broken
documentation due to java generics bug
Posted by "Michael McCandless (JIRA)" <ji...@apache.org>.
[ 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
[jira] [Issue Comment Edited] (LUCENE-4010) AttributeSource api has
broken documentation due to java generics bug
Posted by "Uwe Schindler (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/LUCENE-4010?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13259210#comment-13259210 ]
Uwe Schindler edited comment on LUCENE-4010 at 4/22/12 6:31 PM:
----------------------------------------------------------------
I checked it, it *always* produces invalid HTML, you can use any type param you want. Same happens with <B>,... We should simply remove the @link and never use @link pointing to anything that uses generics.
was (Author: thetaphi):
I checked it, it *always* produces invalid HTML, you can use any type param you want. Same happens with <B>,... We should simply remove the @link.
> 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
[jira] [Commented] (LUCENE-4010) AttributeSource api has broken
documentation due to java generics bug
Posted by "Robert Muir (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/LUCENE-4010?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13259184#comment-13259184 ]
Robert Muir commented on LUCENE-4010:
-------------------------------------
{quote}
The 3.6.0 javadocs are OK because we used java7 to generate them...
{quote}
Well not totally ok. Only OK on the website. The ones actually included in the release were generated
with Java 5 (because i didnt want anything but a java5 compiler coming anywhere near the actual artifacts).
The website javadocs were separately regenerated with java7: http://wiki.apache.org/lucene-java/HowToGenerateNiceJavadocs
> 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