Re: JavaDoc for Interfaces

Thanks I didnt see that hint on the checkstyle page before!
 
 

________________________________

From: [email protected]
[mailto:[email protected]] On Behalf Of
Oliver Burn
Sent: Mittwoch, 27. Juni 2007 11:43
To: [email protected]
Subject: Re: [Checkstyle-user] JavaDoc for Interfaces


Suggest reading the notes for
http://checkstyle.sourceforge.net/config_javadoc.html#JavadocMethod as
it has what you want.

To quote:



	It can be extremely painful writing or duplicating Javadoc for a
method required for an interface. Hence checkstyle supports using the
convention of using a single {@inheritDoc} tag instead of all the other
tags. 
	


On 6/27/07, Remo Liechti <[email protected]> wrote: 

	Hi Guys
	
	We have some checkstyle checks for javadoc but we are not
statisfied with it.
	Basically, it checks all public methods but ignoring getters and
setters.
	
	Let's say we have an interface with 3 implementing classes. We
document the javadoc in the interface only. The JavaDoc generation just
copies this javadoc to the methods of the implementing classes
automatically, therefor we do not comment the methods on the
implementing classes manually. 
	
	I did not find any option how to implement this in checkstyle.
Checkstyle also complains about missing javadoc in the implementing
classes...
	
	Do you know how this could be solved?
	
	Thanks,
	Remo
	
	
	
	
	Regards,
	
	Remo Liechti
	Application Developer
	Swisslog Warehouse and Distribution Solutions
	
	Direct: +41 (0)62 837 4345
	Mobile: +41 (0)76 329 8660
	CH Fax: +41 (0)62 837 4197
	Internet: www.swisslog.com
	----------------------------------------------------------------
	About Swisslog
	Swisslog is a global provider of logistic solutions for
warehouses, distribution centers and hospitals.Swisslog's solutions
increase their customers' flexibility, responsiveness, and quality of
service, while minimizing logistics costs.
	
	
	This message may contain legally privileged or confidential
information and is therefore addressed to the named persons only. The
recipient should inform the sender and delete this message, if he/she is
not named as addressee. 
	The sender disclaims any and all liability for the integrity and
punctuality of this message. The sender has activated an automatic virus
scanning, but does not guarantee the virus free transmission of this
message.
	
	
	
------------------------------------------------------------------------
-
	This SF.net email is sponsored by DB2 Express
	Download DB2 Express C - the FREE version of DB2 express and
take
	control of your XML. No limits. Just data. Click to get it now. 
	http://sourceforge.net/powerbar/db2/
	_______________________________________________
	Checkstyle-user mailing list
	[email protected]
	https://lists.sourceforge.net/lists/listinfo/checkstyle-user
	



This message may contain legally privileged or confidential information and is therefore addressed to the named persons only. The recipient should inform the sender and delete this message, if he/she is not named as addressee.
The sender disclaims any and all liability for the integrity and punctuality of this message. The sender has activated an automatic virus scanning, but does not guarantee the virus free transmission of this message.

-------------------------------------------------------------------------
This SF.net email is sponsored by DB2 Express
Download DB2 Express C - the FREE version of DB2 express and take
control of your XML. No limits. Just data. Click to get it now.
http://sourceforge.net/powerbar/db2/

_______________________________________________
Checkstyle-user mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/checkstyle-user