CheckStyle and JAVAdoc for override methods

2 Message(s) by 2 Author(s) originally posted in java software tools

From: Efi Merdler

Date: Saturday, March 17, 2007

Hello,
When adding JAVA docs for methods that I override under eclipse, I get
the following JAVA doc:
/*
* (non-JAVAdoc)
*
* @xxxxxxxxxxx JAVA.lang.Runnable#run()
*/

which is fine, however checkstyle thinks that I did not write

1. <chat> {Unix}'s simple {talk} command and {protocol}.
	write has been largely superseded by {talk} and then {irc}.

	An enhancement, {RWP}, has been proposed.

	2. <tool> A simple {text editor} for {Windows}.

	(1998-04-28)

any
comments, is there a rule that allows me to add this type

<theory, programming> (Or "data type") A set of values from
	which a {variable}, {constant}, {function}, or other
	{expression} may take its value.  A type is a classification
	of data that tells the {compiler} or {interpreter} how the
	programmer intends to use it.  For example, the process and
	result of adding two variables differs greatly according to
	whether they are integers, floating point numbers, or strings.

	Types supported by most programming languages include
	{integers} (usually limited to some range so they will fit in
	one {word} of storage), {Booleans}, {floating point numbers},
	and characters.  {Strings} are also common, and are
	represented as {lists} of characters in some languages.

	If s and t are types, then so is s -> t, the type of
	{functions} from s to t; that is, give them a term of type s,
	functions of type s -> t will return a term of type t.

	Some types are {primitive} - built-in to the language, with no
	visible internal structure - e.g. Boolean; others are
	composite - constructed from one or more other types (of
	either kind) - e.g. {lists}, {arrays}, {structures}, {unions}.
	{Object-oriented programming} extends this with {classes}
	which encapsulate both the structure of a type and the
	operations that can be performed on it.

	Some languages provide {strong typing}, others allow {implicit
	type conversion} and/or {explicit type conversion}.

	(2003-12-22)

of special
condition?

Thank you,
Efi

From: Daniel Dyer

Date: Monday, March 19, 2007

wrote in message:

Hello,
When adding JAVA docs for methods that I override under eclipse, I get
the following JAVA doc:
/*
* (non-JAVAdoc)
*
* @xxxxxxxxxxx JAVA.lang.Runnable#run()
*/
which is fine, however checkstyle thinks that I did not write any
comments, is there a rule that allows me to add this type of special
condition?
Thank you,
Efi

That's not a JAVAdoc comment, it has to start with two stars (i.e. /**).

Dan.

--
Daniel Dyer
http://www.uncommons.org

Next Message: Connect to JAVA application from JAVA login form

Blogs related to CheckStyle and JAVAdoc for override methods

FAQs-1 (updated)
Jdk14Logger does not implement Log'* when using the maven-checkstyle-plugin mean?] Where do I configure report plug-ins, like javadoc? [How do I deploy my binary during the deploy phase?] [How do I add main class in a generated jar's ...

Checkclipse
check your code formatting (indentation, spaces, long lines) * watch for very long methods and long parameter lists * check for complete javadoc tags * watch identifier naming conventions for classes, parameters, members etc. ...

CheckStyle and javadoc for override methods
Hello, When adding java docs for methods that I override under eclipse, I get the following java doc: /* * (non-Javadoc) * * @see java.lang.Runnable#run() */ which is fine, however checkstyle thinks that I didn't write any comments, ...