Win a copy of Kotlin in Action this week in the Kotlin forum!
  • Post Reply Bookmark Topic Watch Topic
  • New Topic

utility tool that generates java doc complaint documentation in source code.  RSS feed

 
Srinivas Ramgopal
Ranch Hand
Posts: 63
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Hi all,

There are tons of java classes in my current project that have zero documentation at class and method level.
I tried using eclipse 3.2's tool for generating java docs for these classes but was not helpful in terms of knowing the PURPOSE of the class/method.

It is being a tedious task to hand write the class/method level documentation/purpose. Thus wondering if there is any open source utility tool that intutively auto generates the java doc complaint documentation blocks within the class ALONG with the purpose of the method/class by understanding the code??

Example: I want the tool to generate the following block for a method as follows:



Any help is HIGHLY appreciated.

Thanks a ton in advance.
[ March 03, 2007: Message edited by: Srinivas Ramgopal ]
 
kri shan
Ranch Hand
Posts: 1489
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
try XDoclet http://xdoclet.sourceforge.net/xdoclet/index.html
 
Ulf Dittmer
Rancher
Posts: 42972
73
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Wow. You're looking for a piece of code that looks at another piece of code and figures out what it does, and then generates a textual description of that? I think if you could come up with that you might get a PhD out of it.
 
  • Post Reply Bookmark Topic Watch Topic
  • New Topic
Boost this thread!