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

Bug 9142

Summary:	Wishlist for 3.0: JavaDoc generation similar to DocCheck [javadoc]
Product:	[Eclipse Project] JDT	Reporter:	Magnus Ihse Bursie <magnus.ihse.bursie>
Component:	UI	Assignee:	JDT-UI-Inbox <jdt-ui-inbox>
Status:	RESOLVED WONTFIX	QA Contact:
Severity:	enhancement
Priority:	P5	CC:	martinae, mp
Version:	2.0	Keywords:	helpwanted
Target Milestone:	---
Hardware:	All
OS:	All
Whiteboard:

Description Magnus Ihse Bursie

2002-02-05 18:06:09 EST

Sun has produced a JavaDoc doclet, DocCheck, which has some nice features. It 
detects incorrect javadoc tags and missing information, and suggests 
corrections and additions, some of which are quite clever and a good starting 
point for writing a more specified JavaDoc comment.

The DocCheck is available at http://java.sun.com/j2se/javadoc/doccheck/, and if 
you don't know about it I recommend you check it out.

Since DocCheck is so centered around creating an HTML page, I don't think it's 
a good idea to try and incorporate it in Eclipse. But some functionality 
similar to DocCheck (but much more integrated) in Eclipse would be really, 
really nice.

Comment 1 Erich Gamma

2002-02-05 18:46:02 EST

Thanks for the pointer. The JavaDoc generation wizard that we are currently 
working on will allow you to define the doclet to be used so you could at least 
use this doclet from eclipse. However, I agree that a tighter integration for 
JavaDoc checking is highly desirable. I also have to agree with your priority 
from above, i.e., unlikely for 2.0. Moving to Later for now.

Comment 2 Dirk Baeumer

2002-07-25 06:03:53 EDT

Would be a great thrid party opportunity

Comment 3 Dr. Michael Paus

2003-02-13 07:03:08 EST

I don't know what happened to this feature request because it is already quite
old and nothing seems to have happened. I would consider some of the aspects of
the original report a bug in Eclipse rather than a feature request.

The Eclipse environment goes a long way to help you ensure the integrity of
your code base. Especially the Java editor tells you about almost any typo
you make but the only area where Eclipse doesn't do anything is to ensure
the integrity of your javadoc. For me javadoc is an essential part of the code
and its integrity should be enforced with the same priority as it is done for the
code itself. So what I ask for is to at least warn about inconsistent javadoc
comments.
A simple rule could be to either not provide any javadoc at all or do it right
and in the later case Eclipse should provide some indication if this condition
is not met.

Comment 4 Martin Aeschlimann

2003-02-13 09:03:54 EST

There was unfortunatly no time left to go more in this direction. We are hoping 
that the community will pick this up and add e.g. a new action that executes 
the doccheck tool, analyse its output, create markers and offer quick fixes for 
the problems. There's some great opportunity here.
AFIK, Instantiations offers a free plugin to check and fix Javadoc.

But you're right, show errors as you type would be even better.

Comment 5 Dirk Baeumer

2003-04-28 06:02:44 EDT

Chaning state from assigned later to resolved later. Assigned later got 
introduced by the last bug conversion and is not a supported Eclipse bug state.

Comment 6 Denis Roy

2009-08-30 02:17:38 EDT

As of now 'LATER' and 'REMIND' resolutions are no longer supported.
Please reopen this bug if it is still valid for you.