D23268: add code documentation and minimal code smells improvement

yurchor added a comment.


  Thanks in advance for fixing these minor issues. You might want to change the review request title as well.

INLINE COMMENTS

> ball.cpp:187
> + * @param vx velocity on x axis
> + * @param vy velocity on y axis
> + */

Same here.

> ball.h:100
> +         * @param vx velocity on x axis
> +         * @param vy velocity on y axis
>           */

That should be vX and vY to avoid Doxygen complaining about the correspondence of parameters.

> board.cpp:42
> + * Constructor to set game board configurations
> + * @param parent Superclass parameter
> + * @see board.h

@param renderer

> board.h:115
> +         * Set ball velocity
> +         * @param vel new velocity
> +         * @see board.cpp

@param velocity

> board.h:122
> +         * Set wall velocity
> +         * @param vel new velocity
> +         * @see board.cpp

@param velocity

> renderer.cpp:44
> + * Constructor.
> + * @param fileName path to SVG containing game graphics
> + */

This line does not belong here.

REPOSITORY
  R392 KBounce

REVISION DETAIL
  https://phabricator.kde.org/D23268

To: pedrohenriques, #kde_games
Cc: yurchor, kde-games-devel