Bug 205052 - [javadoc] error in rendering @link in @return when it is the first element
Summary: [javadoc] error in rendering @link in @return when it is the first element
Status: VERIFIED WORKSFORME
Alias: None
Product: JDT
Classification: Eclipse Project
Component: Core (show other bugs)
Version: 3.3   Edit
Hardware: PC Windows 2000
: P3 minor (vote)
Target Milestone: 3.4 RC3   Edit
Assignee: Eric Jodet CLA
QA Contact:
URL:
Whiteboard:
Keywords:
Depends on:
Blocks:
 
Reported: 2007-10-01 09:35 EDT by Mauro Molinari CLA
Modified: 2008-05-30 05:35 EDT (History)
2 users (show)

See Also:

Attachments
[screen shot] hover over a() (20.52 KB, image/jpeg)
2008-05-29 09:15 EDT, Eric Jodet CLA 		no flags Details
View All Add an attachment (proposed patch, testcase, etc.)

Note You need to log in before you can comment on or make changes to this bug.
Description Mauro Molinari CLA 2007-10-01 09:35:40 EDT 
Build ID: I20070625-1500

Steps To Reproduce:
1. create a new Java class:

public class A
{
  public static int RET = 1;
  
  /**
   * @return {@link #RET}
   */
  public int a()
  {
    return RET;
  }
}

2. click on a() and hit F2

EXPECTED BEHAVIOUR:
The hint is:

---
int A.a()

Returns:
RET
---

OBSERVED BEHAVIOUR:
The hint is:

---
int A.a()

Returns:
{@link #RET}
---

More information:
If you change A into:

public class A
{
  public static int RET = 1;
  
  /**
   * @return value {@link #RET}
   */
  public int a()
  {
    return RET;
  }
}

and then you hit F2 on a() you correctly see the hint as:

---
int A.a()

Returns:
value RET
---

It seems that the problem in rendering the @link only occurs when you start the @return content with a @link tag.
Comment 1 Eric Jodet CLA 2008-05-29 09:14:35 EDT 
Reviewing bug: using build I20080528-2000, I did not manage to reproduce this issue (see to be attached screen shot): the display is now correct (no {@link anymore).

Also found that this was fixed between 3.4M4 and 3.4M5, though I was not able to identify the bug that fixed this issue.

May you please verify that this problem does not occur anymore using a recent build? Thanks.
Comment 2 Eric Jodet CLA 2008-05-29 09:15:20 EDT 
Created attachment 102629 [details]
[screen shot] hover over a()
Comment 3 Mauro Molinari CLA 2008-05-29 09:46:26 EDT 
Hi Eric,
I just tried with Eclipse 3.4RC2 and this problem actually seems to be fixed (I compared the behaviour with that of 3.3.2).

Can I mark this bug as resolved/fixed or should you do it?

Mauro.
Comment 4 Eric Jodet CLA 2008-05-29 09:55:24 EDT 
(Mauro: closing this one with proper target / resolution as per jdt.core process)

Resolution will be WORKSFORME as I was unable to find which bug integrated into 3.4M5 fixed this one.
Comment 5 Mauro Molinari CLA 2008-05-29 10:02:03 EDT 
I verified it's fixed, thank you.

Mauro.
Comment 6 Eric Jodet CLA 2008-05-29 10:12:55 EDT 
sorry, reopening as the verification will be performed during RC3 bug verification (internal process).
Comment 7 Eric Jodet CLA 2008-05-29 10:13:40 EDT 
Change resolution to WORKSFORME
Comment 8 Mauro Molinari CLA 2008-05-30 03:19:32 EDT 
(In reply to comment #6)
> sorry, reopening as the verification will be performed during RC3 bug
> verification (internal process).

Sorry Eric, I thought I could be of help for you by marking this bug as verified.

Mauro.
Comment 9 Eric Jodet CLA 2008-05-30 04:00:59 EDT 
(In reply to comment #8)
my fault: you marking this bug as VERIFIED was OK.
Comment 10 Mauro Molinari CLA 2008-05-30 04:16:09 EDT 
(In reply to comment #9)
> my fault: you marking this bug as VERIFIED was OK. 

So, may I do it again? :-)

Mauro.
Comment 11 Eric Jodet CLA 2008-05-30 04:35:39 EDT 
(In reply to comment #10)
yes please - thanks