Win a copy of Svelte and Sapper in Action this week in the JavaScript forum!
  • Post Reply Bookmark Topic Watch Topic
  • New Topic
programming forums Java Mobile Certification Databases Caching Books Engineering Micro Controllers OS Languages Paradigms IDEs Build Tools Frameworks Application Servers Open Source This Site Careers Other all forums
this forum made possible by our volunteer staff, including ...
Marshals:
  • Campbell Ritchie
  • Ron McLeod
  • Paul Clapham
  • Bear Bibeault
  • Junilu Lacar
Sheriffs:
  • Jeanne Boyarsky
  • Tim Cooke
  • Henry Wong
Saloon Keepers:
  • Tim Moores
  • Stephan van Hulst
  • Tim Holloway
  • salvin francis
  • Frits Walraven
Bartenders:
  • Scott Selikoff
  • Piet Souris
  • Carey Brown

Checking Javadoc

 
Greenhorn
Posts: 7
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Hi all,

I'm getting ready to submit my project and I found 1 or 2 issues with the javadoc. I noticed that 1 of my methods was missing a @param tag for 1 of it's parameters, but javadoc didn't report this as a problem. Is there a flag for javadoc to show those discrepencies or any utilities that check for them? I'm going blind double checking all my code.

I'm using Standard Doclet version 1.5.0_01

Thanks,

Greg
 
Ranch Hand
Posts: 146
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
You could try checkstyle
 
Gregory Till
Greenhorn
Posts: 7
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Thanks Daniel,

My life got worse when Jalopy went commercial, but it looks like I'm on the up again!

Greg
 
author and jackaroo
Posts: 12199
280
Mac IntelliJ IDE Firefox Browser Oracle C++ Java
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Hi Gregory and Daniel,

You could try checkstyle



Another posibility is the Doc Check Doclet.

Regards, Andrew
 
Gregory Till
Greenhorn
Posts: 7
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Thanks, Andrew

I'll try Doc Check Doclet after I've fixed the 2675 warnings checkstyle came up with ;-)

No really...
 
Ranch Hand
Posts: 103
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Yeah, check style really checks for EVERYTHING. So you can make choices in the .xml file. For eg, I commented out the option for 'LocalFinalVariableName'.

Once you are done, I would also suggest you to try the 'DocCheck'.
 
Gregory Till
Greenhorn
Posts: 7
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Thanks for all the help folks.

I left all the scheckStyle default sun standards options turned on - BSTS. Surprising what improvements I've made to my code.

It might be worth mentioning that Doc Check Doclet pulled up a few things that checkStyle doesn't check for, so it's worth using both of them.

Should give me a bit more re-assurance when I submit.

Greg
 
Ranch Hand
Posts: 164
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
I use checkstyle for a long time but there are some warnings that I really think is annoying.
Example:

Method parameters as final.
Interface must have some methods (But I like to use them to store constants, not just behavior)
Modifyiers are redundant in Interfaces (I think it�s easier to read when a specify the �public static final�)
A parameters hides an instance property.


Anyone agree with me? Do I need to make my code perfect to checkstyle or can I follow my improved Sun code style

[ August 18, 2005: Message edited by: Samuel Pessorrusso ]
[ August 18, 2005: Message edited by: Samuel Pessorrusso ]
 
My pie came with a little toothpic holding up this tiny ad:
Thread Boost feature
https://coderanch.com/t/674455/Thread-Boost-feature
    Bookmark Topic Watch Topic
  • New Topic