Fixed a large number of documentation warnings.
This commit is contained in:
parent
48008d1e6a
commit
685b646efa
8 changed files with 75 additions and 14 deletions
|
@ -82,6 +82,10 @@ namespace OpenTK.Audio
|
||||||
|
|
||||||
#region public AudioContext(string device)
|
#region public AudioContext(string device)
|
||||||
|
|
||||||
|
/// <summary>
|
||||||
|
/// Constructs a new AudioContext instance.
|
||||||
|
/// </summary>
|
||||||
|
/// <param name="device">The device name that will host this instance.</param>
|
||||||
public AudioContext(string device) : this(device, 0, 0, false, true, MaxAuxiliarySends.UseDriverDefault) { }
|
public AudioContext(string device) : this(device, 0, 0, false, true, MaxAuxiliarySends.UseDriverDefault) { }
|
||||||
|
|
||||||
#endregion
|
#endregion
|
||||||
|
|
|
@ -89,7 +89,7 @@ namespace OpenTK.Audio.OpenAL
|
||||||
}
|
}
|
||||||
|
|
||||||
/// <summary>
|
/// <summary>
|
||||||
/// Defines available parameters for <see cref="OpenTK.Audio.Alc.GetString(IntPtr, AlcGetStringList)"/>.
|
/// Defines available parameters for <see cref="Alc.GetString(IntPtr, AlcGetStringList)"/>.
|
||||||
/// </summary>
|
/// </summary>
|
||||||
public enum AlcGetStringList : int
|
public enum AlcGetStringList : int
|
||||||
{
|
{
|
||||||
|
@ -104,7 +104,7 @@ namespace OpenTK.Audio.OpenAL
|
||||||
}
|
}
|
||||||
|
|
||||||
/// <summary>
|
/// <summary>
|
||||||
/// Defines available parameters for <see cref="OpenTK.Audio.Alc.GetInteger(IntPtr, AlcGetInteger, int, out int)"/>.
|
/// Defines available parameters for <see cref="Alc.GetInteger(IntPtr, AlcGetInteger, int, out int)"/>.
|
||||||
/// </summary>
|
/// </summary>
|
||||||
public enum AlcGetInteger : int
|
public enum AlcGetInteger : int
|
||||||
{
|
{
|
||||||
|
|
|
@ -177,6 +177,12 @@ namespace OpenTK
|
||||||
|
|
||||||
#region --- Operator Overloads ---
|
#region --- Operator Overloads ---
|
||||||
|
|
||||||
|
/// <summary>
|
||||||
|
/// Compares two instances for equality.
|
||||||
|
/// </summary>
|
||||||
|
/// <param name="left">The first instance.</param>
|
||||||
|
/// <param name="right">The second instance.</param>
|
||||||
|
/// <returns>True, if left equals right; false otherwise.</returns>
|
||||||
public static bool operator== (DisplayResolution left, DisplayResolution right)
|
public static bool operator== (DisplayResolution left, DisplayResolution right)
|
||||||
{
|
{
|
||||||
if (((object)left) == null && ((object)right) == null)
|
if (((object)left) == null && ((object)right) == null)
|
||||||
|
@ -187,6 +193,12 @@ namespace OpenTK
|
||||||
return left.Equals(right);
|
return left.Equals(right);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/// <summary>
|
||||||
|
/// Compares two instances for inequality.
|
||||||
|
/// </summary>
|
||||||
|
/// <param name="left">The first instance.</param>
|
||||||
|
/// <param name="right">The second instance.</param>
|
||||||
|
/// <returns>True, if left does not equal right; false otherwise.</returns>
|
||||||
public static bool operator !=(DisplayResolution left, DisplayResolution right)
|
public static bool operator !=(DisplayResolution left, DisplayResolution right)
|
||||||
{
|
{
|
||||||
return !(left == right);
|
return !(left == right);
|
||||||
|
|
|
@ -161,16 +161,7 @@ namespace OpenTK.Graphics
|
||||||
|
|
||||||
#region LoadDelegate
|
#region LoadDelegate
|
||||||
|
|
||||||
/// <summary>
|
// Tries to load the specified core or extension function.
|
||||||
/// Tries to load the specified core or extension function.
|
|
||||||
/// </summary>
|
|
||||||
/// <param name="function">The name of the function (i.e. glShaderSource)</param>
|
|
||||||
/// <returns>True if the function was found and reloaded, false otherwise.</returns>
|
|
||||||
/// <remarks>
|
|
||||||
/// <para>
|
|
||||||
/// Use this function if you require greater granularity when loading entry points.
|
|
||||||
/// </para>
|
|
||||||
/// </remarks>
|
|
||||||
Delegate LoadDelegate(string name, Type signature)
|
Delegate LoadDelegate(string name, Type signature)
|
||||||
{
|
{
|
||||||
MethodInfo m;
|
MethodInfo m;
|
||||||
|
|
|
@ -146,7 +146,8 @@ namespace OpenTK.Graphics
|
||||||
/// </summary>
|
/// </summary>
|
||||||
/// <returns>A new, dummy GraphicsContext instance.</returns>
|
/// <returns>A new, dummy GraphicsContext instance.</returns>
|
||||||
/// <remarks>
|
/// <remarks>
|
||||||
/// <para>Instances created by this methodwill not be functional. Instance methods will have no effect.</para>
|
/// <para>Instances created by this method will not be functional. Instance methods will have no effect.</para>
|
||||||
|
/// <para>This method requires that a context is current on the calling thread.</para>
|
||||||
/// </remarks>
|
/// </remarks>
|
||||||
public static GraphicsContext CreateDummyContext()
|
public static GraphicsContext CreateDummyContext()
|
||||||
{
|
{
|
||||||
|
@ -157,6 +158,14 @@ namespace OpenTK.Graphics
|
||||||
return CreateDummyContext(handle);
|
return CreateDummyContext(handle);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/// <summary>
|
||||||
|
/// Creates a dummy GraphicsContext to allow OpenTK to work with contexts created by external libraries.
|
||||||
|
/// </summary>
|
||||||
|
/// <param name="handle">The handle of a context.</param>
|
||||||
|
/// <returns>A new, dummy GraphicsContext instance.</returns>
|
||||||
|
/// <remarks>
|
||||||
|
/// <para>Instances created by this method will not be functional. Instance methods will have no effect.</para>
|
||||||
|
/// </remarks>
|
||||||
public static GraphicsContext CreateDummyContext(ContextHandle handle)
|
public static GraphicsContext CreateDummyContext(ContextHandle handle)
|
||||||
{
|
{
|
||||||
if (handle == ContextHandle.Zero)
|
if (handle == ContextHandle.Zero)
|
||||||
|
|
|
@ -121,11 +121,14 @@ namespace OpenTK
|
||||||
/// </summary>
|
/// </summary>
|
||||||
Size ClientSize { get; set; }
|
Size ClientSize { get; set; }
|
||||||
|
|
||||||
|
/// <summary>
|
||||||
|
/// This property is deprecated and should not be used.
|
||||||
|
/// </summary>
|
||||||
[Obsolete]
|
[Obsolete]
|
||||||
OpenTK.Input.IInputDriver InputDriver { get; }
|
OpenTK.Input.IInputDriver InputDriver { get; }
|
||||||
|
|
||||||
/// <summary>
|
/// <summary>
|
||||||
/// Closes this window. Equivalent to <see cref="INativeWindow.Dispose()"/>.
|
/// Closes this window.
|
||||||
/// </summary>
|
/// </summary>
|
||||||
void Close();
|
void Close();
|
||||||
|
|
||||||
|
|
|
@ -141,12 +141,18 @@ namespace OpenTK.Input
|
||||||
|
|
||||||
#region --- IInputDevice Members ---
|
#region --- IInputDevice Members ---
|
||||||
|
|
||||||
|
/// <summary>
|
||||||
|
/// Gets a <see cref="System.String"/> which describes this instance.
|
||||||
|
/// </summary>
|
||||||
public string Description
|
public string Description
|
||||||
{
|
{
|
||||||
get { return description; }
|
get { return description; }
|
||||||
internal set { description = value; }
|
internal set { description = value; }
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/// <summary>
|
||||||
|
/// Gets the <see cref="InputDeviceType"/> for this instance.
|
||||||
|
/// </summary>
|
||||||
public InputDeviceType DeviceType
|
public InputDeviceType DeviceType
|
||||||
{
|
{
|
||||||
get { return InputDeviceType.Keyboard; }
|
get { return InputDeviceType.Keyboard; }
|
||||||
|
|
|
@ -183,16 +183,47 @@ namespace OpenTK
|
||||||
|
|
||||||
#endregion
|
#endregion
|
||||||
|
|
||||||
|
#region Mathematical constants
|
||||||
|
|
||||||
|
/// <summary>
|
||||||
|
/// Obsolete. Do not use.
|
||||||
|
/// </summary>
|
||||||
public static readonly float PIF = 3.141592653589793238462643383279502884197169399375105820974944592307816406286208998628034825342117067982148086513282306647093844609550582231725359408128481117450284102701938521105559644622948954930382f;
|
public static readonly float PIF = 3.141592653589793238462643383279502884197169399375105820974944592307816406286208998628034825342117067982148086513282306647093844609550582231725359408128481117450284102701938521105559644622948954930382f;
|
||||||
|
|
||||||
|
/// <summary>
|
||||||
|
/// Obsolete. Do not use.
|
||||||
|
/// </summary>
|
||||||
public static readonly float RTODF = 180.0f / PIF;
|
public static readonly float RTODF = 180.0f / PIF;
|
||||||
|
|
||||||
|
/// <summary>
|
||||||
|
/// Obsolete. Do not use.
|
||||||
|
/// </summary>
|
||||||
public static readonly float DTORF = PIF / 180.0f;
|
public static readonly float DTORF = PIF / 180.0f;
|
||||||
|
|
||||||
|
/// <summary>
|
||||||
|
/// Obsolete. Do not use.
|
||||||
|
/// </summary>
|
||||||
public static readonly double PI = 3.141592653589793238462643383279502884197169399375105820974944592307816406286208998628034825342117067982148086513282306647093844609550582231725359408128481117450284102701938521105559644622948954930382d;
|
public static readonly double PI = 3.141592653589793238462643383279502884197169399375105820974944592307816406286208998628034825342117067982148086513282306647093844609550582231725359408128481117450284102701938521105559644622948954930382d;
|
||||||
|
|
||||||
|
/// <summary>
|
||||||
|
/// Obsolete. Do not use.
|
||||||
|
/// </summary>
|
||||||
public static readonly double RTOD = 180.0d / PIF;
|
public static readonly double RTOD = 180.0d / PIF;
|
||||||
|
|
||||||
|
/// <summary>
|
||||||
|
/// Obsolete. Do not use.
|
||||||
|
/// </summary>
|
||||||
public static readonly double DTOR = PIF / 180.0d;
|
public static readonly double DTOR = PIF / 180.0d;
|
||||||
|
|
||||||
|
#endregion
|
||||||
|
|
||||||
#region Swap
|
#region Swap
|
||||||
|
|
||||||
|
/// <summary>
|
||||||
|
/// Swaps two float values.
|
||||||
|
/// </summary>
|
||||||
|
/// <param name="a">The first value.</param>
|
||||||
|
/// <param name="b">The second value.</param>
|
||||||
public static void Swap(ref double a, ref double b)
|
public static void Swap(ref double a, ref double b)
|
||||||
{
|
{
|
||||||
double temp = a;
|
double temp = a;
|
||||||
|
@ -200,6 +231,11 @@ namespace OpenTK
|
||||||
b = temp;
|
b = temp;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/// <summary>
|
||||||
|
/// Swaps two float values.
|
||||||
|
/// </summary>
|
||||||
|
/// <param name="a">The first value.</param>
|
||||||
|
/// <param name="b">The second value.</param>
|
||||||
public static void Swap(ref float a, ref float b)
|
public static void Swap(ref float a, ref float b)
|
||||||
{
|
{
|
||||||
float temp = a;
|
float temp = a;
|
||||||
|
|
Loading…
Reference in a new issue