Add XML documentation to matrix Add methods.
authorFraser Waters <frassle@gmail.com>
Tue, 21 Oct 2014 18:34:44 +0000 (20:34 +0200)
committerFraser Waters <frassle@gmail.com>
Mon, 3 Nov 2014 00:33:27 +0000 (01:33 +0100)
Fixes warnings [#61] about missing documentation on public members.

Source/OpenTK/Math/Matrix3.cs
Source/OpenTK/Math/Matrix3d.cs

index 18b5c6f..9d720c8 100644 (file)
@@ -670,6 +670,12 @@ namespace OpenTK
 
         #region Add Functions
 
+        /// <summary>
+        /// Adds two instances.
+        /// </summary>
+        /// <param name="left">The left operand of the addition.</param>
+        /// <param name="right">The right operand of the addition.</param>
+        /// <returns>A new instance that is the result of the addition.</returns>
         public static Matrix3 Add(Matrix3 left, Matrix3 right)
         {
             Matrix3 result;
@@ -677,6 +683,12 @@ namespace OpenTK
             return result;
         }
 
+        /// <summary>
+        /// Adds two instances.
+        /// </summary>
+        /// <param name="left">The left operand of the addition.</param>
+        /// <param name="right">The right operand of the addition.</param>
+        /// <param name="result">A new instance that is the result of the addition.</param>
         public static void Add(ref Matrix3 left, ref Matrix3 right, out Matrix3 result)
         {
             Vector3.Add(ref left.Row0, ref right.Row0, out result.Row0);
index 7963353..ca270b8 100644 (file)
@@ -667,6 +667,12 @@ namespace OpenTK
 
         #region Add Functions
 
+        /// <summary>
+        /// Adds two instances.
+        /// </summary>
+        /// <param name="left">The left operand of the addition.</param>
+        /// <param name="right">The right operand of the addition.</param>
+        /// <returns>A new instance that is the result of the addition.</returns>
         public static Matrix3d Add(Matrix3d left, Matrix3d right)
         {
             Matrix3d result;
@@ -674,6 +680,12 @@ namespace OpenTK
             return result;
         }
 
+        /// <summary>
+        /// Adds two instances.
+        /// </summary>
+        /// <param name="left">The left operand of the addition.</param>
+        /// <param name="right">The right operand of the addition.</param>
+        /// <param name="result">A new instance that is the result of the addition.</param>
         public static void Add(ref Matrix3d left, ref Matrix3d right, out Matrix3d result)
         {
             Vector3d.Add(ref left.Row0, ref right.Row0, out result.Row0);