Bug 20549 - Class generation from Interface generates @see - tags Javadoc doesn't understand [javadoc]
Summary: Class generation from Interface generates @see - tags Javadoc doesn't underst...
Status: RESOLVED FIXED
Alias: None
Product: JDT
Classification: Eclipse Project
Component: UI (show other bugs)
Version: 2.0   Edit
Hardware: PC Windows 2000
: P3 normal (vote)
Target Milestone: 2.1 M1   Edit
Assignee: Martin Aeschlimann CLA
QA Contact:
URL:
Whiteboard:
Keywords: investigate
Depends on:
Blocks:
 
Reported: 2002-06-18 12:24 EDT by Andreas Krüger CLA
Modified: 2002-09-16 09:55 EDT (History)
0 users

See Also:


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Andreas Krüger CLA 2002-06-18 12:24:34 EDT
I have an interface stack like this:

   public interface OuterI {
    
       public interface InnerI {}
    
       public void eatInner(InnerI innerI);
   }


I use New/Class to generate a class implementing OuterI.
Here is (a slightly boiled-down version of) what I get:


   import OuterI.InnerI;
   public class Impl implements OuterI {

       /**
        * @see OuterI#eatInner(InnerI)
        */
       public void eatInner(InnerI innerI) {}
   }

Neat trick, that import statement.
But unfortunately, the javadoc tool does not agree with us:

   javadoc: warning - Impl.eatInner(OuterI.InnerI):
      Tag @see: can't find eatInner(InnerI) in OuterI

I correct it manually, then it works:

   import OuterI.InnerI;
   public class Impl implements OuterI {
       /**
        * @see OuterI#eatInner(OuterI.InnerI)
        */
       public void eatInner(InnerI innerI) {}
   }
Comment 1 Dirk Baeumer CLA 2002-07-30 08:47:11 EDT
Problem still exists in 2.0. 
Comment 2 Martin Aeschlimann CLA 2002-09-16 09:55:07 EDT
We descided to fully qualify all type names in Javadoc comments.
Type names in the comment not looked at by organize import or other 
refactoring, so to avoid unresolved type names by the Javadoc tool, 
qualification is necessary.

Maybe we can improve this when JCore gives us more support with the Javadoc 
structure (planed for 2.1)

changed to use fully qualified type names > 20020911