Added several missing XML comments.

This commit is contained in:
the_fiddler 2009-06-28 10:33:32 +00:00
parent 305a6a2749
commit c43407e77e
2 changed files with 50 additions and 0 deletions

View file

@ -258,6 +258,9 @@ namespace OpenTK
#region public void Transpose() #region public void Transpose()
/// <summary>
/// Calculates the transpose of this instance.
/// </summary>
public void Transpose() public void Transpose()
{ {
this = Matrix4.Transpose(this); this = Matrix4.Transpose(this);

View file

@ -633,6 +633,12 @@ namespace OpenTK
#region Operators #region Operators
/// <summary>
/// Adds two instances.
/// </summary>
/// <param name="left">The left instance.</param>
/// <param name="right">The right instance.</param>
/// <returns>The result of the operation.</returns>
public static Vector2d operator +(Vector2d left, Vector2d right) public static Vector2d operator +(Vector2d left, Vector2d right)
{ {
left.X += right.X; left.X += right.X;
@ -640,6 +646,12 @@ namespace OpenTK
return left; return left;
} }
/// <summary>
/// Subtracts two instances.
/// </summary>
/// <param name="left">The left instance.</param>
/// <param name="right">The right instance.</param>
/// <returns>The result of the operation.</returns>
public static Vector2d operator -(Vector2d left, Vector2d right) public static Vector2d operator -(Vector2d left, Vector2d right)
{ {
left.X -= right.X; left.X -= right.X;
@ -647,6 +659,11 @@ namespace OpenTK
return left; return left;
} }
/// <summary>
/// Negates an instance.
/// </summary>
/// <param name="left">The instance.</param>
/// <returns>The result of the operation.</returns>
public static Vector2d operator -(Vector2d vec) public static Vector2d operator -(Vector2d vec)
{ {
vec.X = -vec.X; vec.X = -vec.X;
@ -654,6 +671,12 @@ namespace OpenTK
return vec; return vec;
} }
/// <summary>
/// Multiplies an instance by a scalar.
/// </summary>
/// <param name="left">The instance.</param>
/// <param name="right">The scalar.</param>
/// <returns>The result of the operation.</returns>
public static Vector2d operator *(Vector2d vec, double f) public static Vector2d operator *(Vector2d vec, double f)
{ {
vec.X *= f; vec.X *= f;
@ -661,6 +684,12 @@ namespace OpenTK
return vec; return vec;
} }
/// <summary>
/// Multiply an instance by a scalar.
/// </summary>
/// <param name="left">The scalar.</param>
/// <param name="right">The instance.</param>
/// <returns>The result of the operation.</returns>
public static Vector2d operator *(double f, Vector2d vec) public static Vector2d operator *(double f, Vector2d vec)
{ {
vec.X *= f; vec.X *= f;
@ -668,6 +697,12 @@ namespace OpenTK
return vec; return vec;
} }
/// <summary>
/// Divides an instance by a scalar.
/// </summary>
/// <param name="left">The instance.</param>
/// <param name="right">The scalar.</param>
/// <returns>The result of the operation.</returns>
public static Vector2d operator /(Vector2d vec, double f) public static Vector2d operator /(Vector2d vec, double f)
{ {
double mult = 1.0f / f; double mult = 1.0f / f;
@ -676,11 +711,23 @@ namespace OpenTK
return vec; return vec;
} }
/// <summary>
/// Compares two instances for equality.
/// </summary>
/// <param name="left">The left instance.</param>
/// <param name="right">The right instance.</param>
/// <returns>True, if both instances are equal; false otherwise.</returns>
public static bool operator ==(Vector2d left, Vector2d right) public static bool operator ==(Vector2d left, Vector2d right)
{ {
return left.Equals(right); return left.Equals(right);
} }
/// <summary>
/// Compares two instances for ljequality.
/// </summary>
/// <param name="left">The left instance.</param>
/// <param name="right">The right instance.</param>
/// <returns>True, if the instances are not equal; false otherwise.</returns>
public static bool operator !=(Vector2d left, Vector2d right) public static bool operator !=(Vector2d left, Vector2d right)
{ {
return !left.Equals(right); return !left.Equals(right);