Should @param specify variable type? (since it isn't stated in the function declaration)
Also, should @return do the same?
For example, would you rather have this:
(vote yes in poll)
//Checks whether a drop-off is located between two points.
//@param point3F posA The starting point.
//@param point3F posB The ending point.
//@param float intervalFraction A cliff detection will be performed every fraction of the way between the points.
//@param float maxCliffHeight The maximum height that is not blocking.
//@param string groundType A typemask for the ground.
//@param object excludeObj An object to exclude from raycast checks.
//@return bool True if a drop-off is located between the points, otherwise false.
function Slayer_PathHandlerSG::checkCliffBlocking(%this,%posA,%posB,%intervalFraction,%maxCliffHeight,%groundType,%excludeObj)
{
}
(vote no in poll)
//Checks whether a drop-off is located between two points.
//@param posA The starting point.
//@param posB The ending point.
//@param intervalFraction A cliff detection will be performed every fraction of the way between the points.
//@param maxCliffHeight The maximum height that is not blocking.
//@param groundType A typemask for the ground.
//@param excludeObj An object to exclude from raycast checks.
//@return True if a drop-off is located between the points, otherwise false.
function Slayer_PathHandlerSG::checkCliffBlocking(%this,%posA,%posB,%intervalFraction,%maxCliffHeight,%groundType,%excludeObj)
{
}
Personally, I would say that yes they should specify variable types.