visusnet/Blobby-Warriors — comment on commit 75eb4824e8c83d90bddea6eb74f9495b254f4940
File: BlobbyWarriors/Source/BlobbyWarriors/Model/Entity/Blobby.cpp line 31
By visusnet:

Accepted, but I propose to rename direction to movementDirection. Please use the Javadoc documentation style for methods that can be parsed with Doxygen to autogenerate documentation, e.g.:

/**
* Description text.
*
* @param int firstParamName
* @param char* secondParamName
*/

Annotated:

/**
* Description text. <-- Beginning with a capital letter and ending with a period.
* <-- Empty line.
* @param int firstParamName <-- Should be easy to understand.
* @param char* secondParamName
* @return void <-- Return value.
*/

Please omit the @author-tag. It is not neccessary since we can find out who is responsible for changes using "git blame -L ".