opendev/gerrit
Code Issues Proposed changes

Fix @see to external class in api to allow compilation with Java 8

Browse Source 
The recently added GarbageCollectorListener came with a @see to a JGit
class. While Java 7 did not error out on that, Java 8 does:

  [...]/events/GarbageCollectorListener.java:34: error: reference not found
     * @see org.eclipse.jgit.api.GarbageCollectCommand#call()
            ^

As Java 8's javadoc currently (1.8.0_45) even complains when adding a
“-link”, we work around the issue by transforming the @see to the
classname into a @see with a full <a/>.

Change-Id: I1c061d5219b4fe8818d3fca8a56b4a433aa557d4
This commit is contained in:
Christian Aistleitner
2015-05-20 15:04:42 +02:00
parent 17a6fb08d7
commit 9e8343c135
1 changed files with 1 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
gerrit-extension-api/src/main/java/com/google/gerrit/extensions/events/GarbageCollectorListener.java
View File

@@ -31,7 +31,7 @@ public interface GarbageCollectorListener {
* Properties describing the result of the garbage collection performed by
* JGit
*
* @see org.eclipse.jgit.api.GarbageCollectCommand#call()
* @see <a href="http://download.eclipse.org/jgit/site/3.7.0.201502260915-r/apidocs/org/eclipse/jgit/api/GarbageCollectCommand.html#call%28%29">GarbageCollectCommand</a>
*/
Properties getStatistics();
}