Fix documentation warnings generated by JavaDoc (NFC) (#3428)

Some C++ Doxygen comments were updated to reflect any wording changes.

See `rg "(@return|@param \w+) TODO" | less` for list of incomplete docs.

wpimath/src/main/java/edu/wpi/first/math/kinematics/SwerveModuleState.java

@@ -56,6 +56,7 @@ public class SwerveModuleState implements Comparable<SwerveModuleState> {
    *
    * @param desiredState The desired state.
    * @param currentAngle The current module angle.
+   * @return Optimized swerve module state.
    */
   public static SwerveModuleState optimize(
       SwerveModuleState desiredState, Rotation2d currentAngle) {