apache / apache/lucene

AttributeSource api has broken documentation due to java generics bug [LUCENE-4010]

Open
#5,083 3 comments 0 reactions 0 assignees View on GitHub
legacy-jira-priority:Minor type:documentation type:enhancement
Dominant language
Java
Stars
3.6k
Forks
1.4k
Avg merge
2d 11h
Merged PRs (30d)
88

Description

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...

---
Migrated from [LUCENE-4010](https://issues.apache.org/jira/browse/LUCENE-4010) by Michael McCandless (@mikemccand), updated Apr 23 2012

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.