[commons-geometry] 02/04: adding documentation to checkstyle suppression rules

[er...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

erans pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-geometry.git

commit 5b5ea797a61d3988b7b2943bc4acccaad9298216
Author: Matt Juntunen <ma...@hotmail.com>
AuthorDate: Sun Nov 24 12:11:45 2019 -0500

    adding documentation to checkstyle suppression rules
---
 src/main/resources/checkstyle/checkstyle-suppressions.xml | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/src/main/resources/checkstyle/checkstyle-suppressions.xml b/src/main/resources/checkstyle/checkstyle-suppressions.xml
index f352d2a..bc75f02 100644
--- a/src/main/resources/checkstyle/checkstyle-suppressions.xml
+++ b/src/main/resources/checkstyle/checkstyle-suppressions.xml
@@ -19,11 +19,17 @@
     "-//Checkstyle//DTD SuppressionFilter Configuration 1.2//EN"
     "https://checkstyle.org/dtds/suppressions_1_2.dtd">
 <suppressions>
+  <!-- allow internal Matrices.determinant() method for 3x3 matrices -->
   <suppress checks="ParameterNumber" files=".*/internal/Matrices" />
+  <!-- allow Vector1D.linearCombination() methods -->
   <suppress checks="ParameterNumber" files=".*/oned/Vector1D" />
+  <!-- allow internal, non-array constructor -->
   <suppress checks="ParameterNumber" files=".*/threed/AffineTransformMatrix3D" />
+  <!-- allow Vector3D.linearCombination() methods -->
   <suppress checks="ParameterNumber" files=".*/threed/Vector3D" />
+  <!-- allow internal, non-array QuaterionRotation.orthogonalRotationMatrixToQuaternion() method -->
   <suppress checks="ParameterNumber" files=".*/threed/rotation/QuaternionRotation" />
+  <!-- allow Vector2D.linearCombination() methods -->
   <suppress checks="ParameterNumber" files=".*/twod/Vector2D" />
 
   <!-- Be more lenient on tests. -->