Summary: | [javadoc][assist] JavaDoc assist for @see does not include information for generics | ||
---|---|---|---|
Product: | [Eclipse Project] JDT | Reporter: | Victor Toni <victor.toni> |
Component: | Core | Assignee: | JDT-Core-Inbox <jdt-core-inbox> |
Status: | RESOLVED INVALID | QA Contact: | |
Severity: | normal | ||
Priority: | P3 | CC: | daniel_megert |
Version: | 3.2 | ||
Target Milestone: | 3.2 M6 | ||
Hardware: | PC | ||
OS: | Windows XP | ||
Whiteboard: |
Description
Victor Toni
2006-03-23 19:12:26 EST
Moving to JDT Core for comment. Additional note: navigation (Ctrl+F3 + linking) inside Javadoc only works for @see #doSomething(List) it does not work when having: @see #doSomething(List<String>) or @see #doSomething(List<String>) /** * @see #doSomething(List<String>) */ This is an invalid syntax, javadoc.exe would not accept it: warning - Tag @see:illegal character: "38" in "#doSomething(List<String>)" warning - Tag @see:illegal character: "59" in "#doSomething(List<String>)" warning - Tag @see:illegal character: "38" in "#doSomething(List<String>)" warning - Tag @see:illegal character: "59" in "#doSomething(List<String>)" warning - Tag @see: can't find doSomething(List<String>) in generics.DocHint /** * @see #doSomething(List<String>) */ Is also an invalid syntax: warning - Tag @see:illegal character: "60" in "#doSomething(List<String>)" warning - Tag @see:illegal character: "62" in "#doSomething(List<String>)" warning - Tag @see: can't find doSomething(List<String>) in generics.DocHint Please have a look on Sun javadoc 1.5.0 tags spec: http://java.sun.com/j2se/1.5.0/docs/tooldocs/windows/javadoc.html#@see and you'll see that generic syntax is not accepted in @see tag references. The only change for 1.5 syntax in Sun javadoc spec were for @param tag. You can use this tag to specify class/method type parameters: /** * @param <T> */ class X<T> {} I should have done the test myself, but it seemed so "natural". Sorry for the noise. |