Some Eclipse Foundation services are deprecated, or will be soon. Please ensure you've read this important communication.

Bug 359533

Summary:	[JavaDoc] Avoid JavaDoc warning about unresolved type when reference is commented out (<!-- -->)
Product:	[Eclipse Project] JDT	Reporter:	Rüdiger Herrmann <ruediger.herrmann>
Component:	Core	Assignee:	JDT-Core-Inbox <jdt-core-inbox>
Status:	CLOSED WONTFIX	QA Contact:
Severity:	normal
Priority:	P3	CC:	amj87.iitr, ruediger.herrmann
Version:	3.7
Target Milestone:	---
Hardware:	PC
OS:	Windows 7
Whiteboard:	stalebug

Description Rüdiger Herrmann

2011-09-30 04:49:57 EDT

The Process JavaDoc comments setting is turned on and the severity for malformed JavaDoc comments is set to "warning". With the following JavaDoc snippet, I get a warning "JavaDoc: NonExistingClass cannot be resolved to a type"
	/**
	 * bla bla
	 * <!--
	 * @see NonExistingClass
	 * -->
	 */

Though I couldn't find any reference about the use of HTML comments in JavaDoc, I would except the @see NonExisintingClass to be ignored by the JavaDoc verifier.

[1] http://download.oracle.com/javase/1,5.0/docs/tooldocs/windows/javadoc.html

Comment 1 Ayushman Jain

2011-09-30 07:27:15 EDT

I don't think we would like to touch this unless there's any official reference about such HTML comments, or atleast popular demand for ignoring them from javadoc warnings.

Comment 2 Rüdiger Herrmann

2011-10-04 08:38:24 EDT

For block tags (such as @see) I couldn't find an official reference. Moreover, the JavaDoc tool does not regard HTML comments (<!-- -->) in block tags. Hence I understand that you don't want to change the current behavior.

Comments in the main description however behave differently. There, the Javadoc tool (from JDK 1.5) omits the content between <!-- and -->
The doc comment below
/**
  * bla <!-- {@link NonExistingClass} --> bla
  */
results in "bla bla". Consistently, the JavaDoc verifier should not issue a warning about an unresolved reference (what it currently does). Does that make sense?

Comment 3 Eclipse Genie

2020-02-04 17:02:39 EST

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. As such, we're closing this bug.

If you have further information on the current state of the bug, please add it and reopen this bug. 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.