From 9b17ee15596250be08220c6943e0923b73e249b3 Mon Sep 17 00:00:00 2001 From: the_fiddler Date: Sun, 28 Jun 2009 10:33:32 +0000 Subject: [PATCH] Added several missing XML comments. --- Source/OpenTK/Math/Matrix4.cs | 3 +++ Source/OpenTK/Math/Vector2d.cs | 47 ++++++++++++++++++++++++++++++++++ 2 files changed, 50 insertions(+) diff --git a/Source/OpenTK/Math/Matrix4.cs b/Source/OpenTK/Math/Matrix4.cs index c3e8e685..ab975154 100644 --- a/Source/OpenTK/Math/Matrix4.cs +++ b/Source/OpenTK/Math/Matrix4.cs @@ -258,6 +258,9 @@ namespace OpenTK #region public void Transpose() + /// + /// Calculates the transpose of this instance. + /// public void Transpose() { this = Matrix4.Transpose(this); diff --git a/Source/OpenTK/Math/Vector2d.cs b/Source/OpenTK/Math/Vector2d.cs index 67e30773..64c6cc42 100644 --- a/Source/OpenTK/Math/Vector2d.cs +++ b/Source/OpenTK/Math/Vector2d.cs @@ -633,6 +633,12 @@ namespace OpenTK #region Operators + /// + /// Adds two instances. + /// + /// The left instance. + /// The right instance. + /// The result of the operation. public static Vector2d operator +(Vector2d left, Vector2d right) { left.X += right.X; @@ -640,6 +646,12 @@ namespace OpenTK return left; } + /// + /// Subtracts two instances. + /// + /// The left instance. + /// The right instance. + /// The result of the operation. public static Vector2d operator -(Vector2d left, Vector2d right) { left.X -= right.X; @@ -647,6 +659,11 @@ namespace OpenTK return left; } + /// + /// Negates an instance. + /// + /// The instance. + /// The result of the operation. public static Vector2d operator -(Vector2d vec) { vec.X = -vec.X; @@ -654,6 +671,12 @@ namespace OpenTK return vec; } + /// + /// Multiplies an instance by a scalar. + /// + /// The instance. + /// The scalar. + /// The result of the operation. public static Vector2d operator *(Vector2d vec, double f) { vec.X *= f; @@ -661,6 +684,12 @@ namespace OpenTK return vec; } + /// + /// Multiply an instance by a scalar. + /// + /// The scalar. + /// The instance. + /// The result of the operation. public static Vector2d operator *(double f, Vector2d vec) { vec.X *= f; @@ -668,6 +697,12 @@ namespace OpenTK return vec; } + /// + /// Divides an instance by a scalar. + /// + /// The instance. + /// The scalar. + /// The result of the operation. public static Vector2d operator /(Vector2d vec, double f) { double mult = 1.0f / f; @@ -676,11 +711,23 @@ namespace OpenTK return vec; } + /// + /// Compares two instances for equality. + /// + /// The left instance. + /// The right instance. + /// True, if both instances are equal; false otherwise. public static bool operator ==(Vector2d left, Vector2d right) { return left.Equals(right); } + /// + /// Compares two instances for ljequality. + /// + /// The left instance. + /// The right instance. + /// True, if the instances are not equal; false otherwise. public static bool operator !=(Vector2d left, Vector2d right) { return !left.Equals(right);