mark smith
mark smith

Reputation: 20907

JavaDoc plugin for eclipse?

I was looking for a javadoc plugin for eclipse so that I can document for methods etc. I know in eclipse you can do ALT + SHIFT + J but I was wondering if there was a more powerful plugin.

I use GhostDoc in VS 2008 which basically when you say document it enters all the parameters and return values and even starts the paragraph for you.

I was hoping for something like that in eclipse because with ALT + SHIFT + J the only this it does is install the

     / ***** /* lines

Any help really appreciated

GhostDoc isn't available for eclipse, its c# only, I use - its great.
Does something exist similar for eclipse?

Upvotes: 8

Views: 17914

Answers (3)

Taras
Taras

Reputation: 582

This is not for Eclipse but also may be useful. I have used JavaDoc utility to generate HTML documentation for project:

javadoc -sourcepath "ROOT\src" com.package.name1 com.package.name2 com.package.nameN -d "javadoc_output_dir"

Upvotes: 1

Trick
Trick

Reputation: 3859

http://jautodoc.sourceforge.net/ - Maybe this will satisfy you.

Upvotes: 6

Daff
Daff

Reputation: 44215

If you are on your method declaration with the cursor and press ALT + SHIFT + J (or right click on the method you want to document in the outline, then Source -> Generate Element Comment) Eclipse will insert all the @param and @return tags accordingly and sets the cursor to the comment.

Another nice feature is that you can press CTRL + Space in the JavaDoc comment to create links to other classes.

Upvotes: 2

Related Questions