Bug 233428

Summary:

[javadoc] syntax of qualified references in @see and {@link} tags

Product:

[Eclipse Project] JDT

Reporter:

Eric Jodet <eric_jodet>

Component:

Core

Assignee:

JDT-Core-Inbox <jdt-core-inbox>

Status:

NEW ---

QA Contact:

Severity:

normal

Priority:

CC:

eric_jodet, frederic_fusier, jerome_lanneluc

Version:

3.4

Target Milestone:

---

Hardware:

OS:

Windows XP

Whiteboard:

stalebug

Attachments:

Description	Flags
[test cases]	none
[proposed patch + test case] on top v_873	none
[proposed patch + test case] on top v_874	none

Description Eric Jodet

2008-05-22 07:26:42 EDT

Created attachment 101468 [details]
[test cases]

Version: 3.4.0
Build id: I20080520-2000

(discovered while looking at bug 101139 - opening this more general bug as dealing with several syntaxes)

we currently accept blanks in qualified references within @see or {@link} tags
(qualified references on several lines are also accepted).

However, according to the javadoc tool spec
http://java.sun.com/j2se/1.5.0/docs/tooldocs/windows/javadoc.html#@see

when dealing with @see  package.class#member  label syntax,
"A space is the delimiter between package.class#member and label. A space inside parentheses does not indicate the start of a label, so spaces may be used between parameters in a method."

This is verified by generating the javadoc for the sample below:
/**
 * Sample link {@link java.lang.  String  label}.
 */

javadoc tool gives:
warning - Tag @link: reference not found: java.lang.  String  label

we currently do not raise any warning.

Comment 1 Eric Jodet

2008-06-13 07:00:00 EDT

Created attachment 104839 [details]
[proposed patch + test case] on top v_873

Note: modified one test case for bug 65174 (JavadocBugsTest#testBug65174b) as it contained a javadoc with a qualified reference than spanned on 2 lines.

Comment 2 Eric Jodet

2008-06-20 06:06:37 EDT

Created attachment 105479 [details]
[proposed patch + test case] on top v_874

better patch

Comment 3 Frederic Fusier

2008-09-12 12:32:38 EDT

Not sure I'll have enough time to review the proposed patch for 3.5...

Comment 4 Eclipse Genie

2021-08-11 16:16:11 EDT

This bug hasn't had any activity in quite some time. Maybe the problem got resolved, was a duplicate of something else, or became less pressing for some reason - or maybe it's still relevant but just hasn't been looked at yet.

If you have further information on the current state of the bug, please add it. The information can be, for example, that the problem still occurs, that you still want the feature, that more information is needed, or that the bug is (for whatever reason) no longer relevant.

--
The automated Eclipse Genie.

Comment 5 Eclipse Genie

2023-08-02 15:58:10 EDT

This bug hasn't had any activity in quite some time. Maybe the problem got resolved, was a duplicate of something else, or became less pressing for some reason - or maybe it's still relevant but just hasn't been looked at yet.

If you have further information on the current state of the bug, please add it. The information can be, for example, that the problem still occurs, that you still want the feature, that more information is needed, or that the bug is (for whatever reason) no longer relevant.

--
The automated Eclipse Genie.