diff --git a/Source/OpenTK/Audio/AudioContext.cs b/Source/OpenTK/Audio/AudioContext.cs index a181e476..4a6faba7 100644 --- a/Source/OpenTK/Audio/AudioContext.cs +++ b/Source/OpenTK/Audio/AudioContext.cs @@ -82,6 +82,10 @@ namespace OpenTK.Audio #region public AudioContext(string device) + /// + /// Constructs a new AudioContext instance. + /// + /// The device name that will host this instance. public AudioContext(string device) : this(device, 0, 0, false, true, MaxAuxiliarySends.UseDriverDefault) { } #endregion diff --git a/Source/OpenTK/Audio/OpenAL/Alc/AlcEnums.cs b/Source/OpenTK/Audio/OpenAL/Alc/AlcEnums.cs index db298b3a..e905b6cc 100644 --- a/Source/OpenTK/Audio/OpenAL/Alc/AlcEnums.cs +++ b/Source/OpenTK/Audio/OpenAL/Alc/AlcEnums.cs @@ -89,7 +89,7 @@ namespace OpenTK.Audio.OpenAL } /// - /// Defines available parameters for . + /// Defines available parameters for . /// public enum AlcGetStringList : int { @@ -104,7 +104,7 @@ namespace OpenTK.Audio.OpenAL } /// - /// Defines available parameters for . + /// Defines available parameters for . /// public enum AlcGetInteger : int { diff --git a/Source/OpenTK/DisplayResolution.cs b/Source/OpenTK/DisplayResolution.cs index 76a5ddb2..56f71a6a 100644 --- a/Source/OpenTK/DisplayResolution.cs +++ b/Source/OpenTK/DisplayResolution.cs @@ -177,6 +177,12 @@ namespace OpenTK #region --- Operator Overloads --- + /// + /// Compares two instances for equality. + /// + /// The first instance. + /// The second instance. + /// True, if left equals right; false otherwise. public static bool operator== (DisplayResolution left, DisplayResolution right) { if (((object)left) == null && ((object)right) == null) @@ -187,6 +193,12 @@ namespace OpenTK return left.Equals(right); } + /// + /// Compares two instances for inequality. + /// + /// The first instance. + /// The second instance. + /// True, if left does not equal right; false otherwise. public static bool operator !=(DisplayResolution left, DisplayResolution right) { return !(left == right); diff --git a/Source/OpenTK/Graphics/BindingsBase.cs b/Source/OpenTK/Graphics/BindingsBase.cs index 64d1879f..a9f97b7d 100644 --- a/Source/OpenTK/Graphics/BindingsBase.cs +++ b/Source/OpenTK/Graphics/BindingsBase.cs @@ -161,16 +161,7 @@ namespace OpenTK.Graphics #region LoadDelegate - /// - /// Tries to load the specified core or extension function. - /// - /// The name of the function (i.e. glShaderSource) - /// True if the function was found and reloaded, false otherwise. - /// - /// - /// Use this function if you require greater granularity when loading entry points. - /// - /// + // Tries to load the specified core or extension function. Delegate LoadDelegate(string name, Type signature) { MethodInfo m; diff --git a/Source/OpenTK/Graphics/GraphicsContext.cs b/Source/OpenTK/Graphics/GraphicsContext.cs index 00699315..476c7ae5 100644 --- a/Source/OpenTK/Graphics/GraphicsContext.cs +++ b/Source/OpenTK/Graphics/GraphicsContext.cs @@ -146,7 +146,8 @@ namespace OpenTK.Graphics /// /// A new, dummy GraphicsContext instance. /// - /// Instances created by this methodwill not be functional. Instance methods will have no effect. + /// Instances created by this method will not be functional. Instance methods will have no effect. + /// This method requires that a context is current on the calling thread. /// public static GraphicsContext CreateDummyContext() { @@ -157,6 +158,14 @@ namespace OpenTK.Graphics return CreateDummyContext(handle); } + /// + /// Creates a dummy GraphicsContext to allow OpenTK to work with contexts created by external libraries. + /// + /// The handle of a context. + /// A new, dummy GraphicsContext instance. + /// + /// Instances created by this method will not be functional. Instance methods will have no effect. + /// public static GraphicsContext CreateDummyContext(ContextHandle handle) { if (handle == ContextHandle.Zero) diff --git a/Source/OpenTK/INativeWindow.cs b/Source/OpenTK/INativeWindow.cs index 68f15fd6..b46cd069 100644 --- a/Source/OpenTK/INativeWindow.cs +++ b/Source/OpenTK/INativeWindow.cs @@ -121,11 +121,14 @@ namespace OpenTK /// Size ClientSize { get; set; } + /// + /// This property is deprecated and should not be used. + /// [Obsolete] OpenTK.Input.IInputDriver InputDriver { get; } /// - /// Closes this window. Equivalent to . + /// Closes this window. /// void Close(); diff --git a/Source/OpenTK/Input/KeyboardDevice.cs b/Source/OpenTK/Input/KeyboardDevice.cs index 34f9e9be..a94f9a67 100644 --- a/Source/OpenTK/Input/KeyboardDevice.cs +++ b/Source/OpenTK/Input/KeyboardDevice.cs @@ -141,12 +141,18 @@ namespace OpenTK.Input #region --- IInputDevice Members --- + /// + /// Gets a which describes this instance. + /// public string Description { get { return description; } internal set { description = value; } } + /// + /// Gets the for this instance. + /// public InputDeviceType DeviceType { get { return InputDeviceType.Keyboard; } diff --git a/Source/OpenTK/Math/Functions.cs b/Source/OpenTK/Math/Functions.cs index 89deba33..15fd0f60 100644 --- a/Source/OpenTK/Math/Functions.cs +++ b/Source/OpenTK/Math/Functions.cs @@ -183,16 +183,47 @@ namespace OpenTK #endregion + #region Mathematical constants + + /// + /// Obsolete. Do not use. + /// public static readonly float PIF = 3.141592653589793238462643383279502884197169399375105820974944592307816406286208998628034825342117067982148086513282306647093844609550582231725359408128481117450284102701938521105559644622948954930382f; + + /// + /// Obsolete. Do not use. + /// public static readonly float RTODF = 180.0f / PIF; + + /// + /// Obsolete. Do not use. + /// public static readonly float DTORF = PIF / 180.0f; + /// + /// Obsolete. Do not use. + /// public static readonly double PI = 3.141592653589793238462643383279502884197169399375105820974944592307816406286208998628034825342117067982148086513282306647093844609550582231725359408128481117450284102701938521105559644622948954930382d; + + /// + /// Obsolete. Do not use. + /// public static readonly double RTOD = 180.0d / PIF; + + /// + /// Obsolete. Do not use. + /// public static readonly double DTOR = PIF / 180.0d; + #endregion + #region Swap + /// + /// Swaps two float values. + /// + /// The first value. + /// The second value. public static void Swap(ref double a, ref double b) { double temp = a; @@ -200,6 +231,11 @@ namespace OpenTK b = temp; } + /// + /// Swaps two float values. + /// + /// The first value. + /// The second value. public static void Swap(ref float a, ref float b) { float temp = a;