PHPDoc: @return void necessary?

If it makes it clear for the documentation, then leave it in, but it isn't strictly necessary. It's an entirely subjective decision Personally, I would leave it out EDIT I stand corrected. After a liitle googleing, the wikipedia page says: return type description This tag should not be used for constructors or methods defined with a void return type The phpdoc.Org website says: return datatype description return datatype1|datatype2 description The @return tag is used to document the return value of functions or methods.

@returns is an alias for @return to support tag formats of other automatic documentors The datatype should be a valid PHP type (int, string, bool, etc), a class name for the type of object returned, or simply "mixed". If you want to explicitly show multiple possible return types, list them pipe-delimited without spaces (e.g."@return int|string"). If a class name is used as the datatype in the @return tag, phpDocumentor will automatically create a link to that class's documentation.

In addition, if a function returns multiple possible values, separate them using the | character, and phpDocumentor will parse out any class names in the return value. PhpDocumentor will display the optional description unmodified Sooo..... Based on that, I would say leave out the void. It's non-standard, at least.

If it makes it clear for the documentation, then leave it in, but it isn't strictly necessary. It's an entirely subjective decision. Personally, I would leave it out.

EDIT I stand corrected. After a liitle googleing, the wikipedia page says: @return type description This tag should not be used for constructors or methods defined with a void return type. The phpdoc.Org website says: @return datatype description @return datatype1|datatype2 description The @return tag is used to document the return value of functions or methods.

@returns is an alias for @return to support tag formats of other automatic documentors The datatype should be a valid PHP type (int, string, bool, etc), a class name for the type of object returned, or simply "mixed". If you want to explicitly show multiple possible return types, list them pipe-delimited without spaces (e.g."@return int|string"). If a class name is used as the datatype in the @return tag, phpDocumentor will automatically create a link to that class's documentation.

In addition, if a function returns multiple possible values, separate them using the | character, and phpDocumentor will parse out any class names in the return value. PhpDocumentor will display the optional description unmodified. Sooo..... Based on that, I would say leave out the void.

It's non-standard, at least.

I believe in PHPDoc if you don't document a return type it automatically assumes void and puts it into the method signature in the docs. – Marc W Jan 14 '10 at 1:16 @Marc W: see my edit. Not only is it not necessary, it is not supposed to be used.

– Jonathan Fingland Jan 14 '10 at 1:33.

I cant really gove you an answer,but what I can give you is a way to a solution, that is you have to find the anglde that you relate to or peaks your interest. A good paper is one that people get drawn into because it reaches them ln some way.As for me WW11 to me, I think of the holocaust and the effect it had on the survivors, their families and those who stood by and did nothing until it was too late.