Added missing XML documentation and fixed invalid XML doc references.

Removed deprecated methods from IGraphicsContext.
This commit is contained in:
the_fiddler 2009-09-04 21:25:29 +00:00
parent 8b60cc2018
commit 6b03992812
7 changed files with 15 additions and 20 deletions

View file

@ -65,6 +65,9 @@ typedef void ALvoid;
namespace OpenTK.Audio.OpenAL namespace OpenTK.Audio.OpenAL
{ {
/// <summary>
/// Provides access to the OpenAL 1.1 flat API.
/// </summary>
public static partial class AL public static partial class AL
{ {

View file

@ -14,7 +14,10 @@ using System.Runtime.InteropServices;
namespace OpenTK.Audio.OpenAL namespace OpenTK.Audio.OpenAL
{ {
///<summary>The X-Ram Extension is provided on the top-end Sound Blaster X-Fi solutions (Sound Blaster X-Fi Fatal1ty, Sound Blaster X-Fi Elite Pro, or later). These products feature 64MB of X-Ram that can only be used for audio purposes, which can be controlled by this Extension.</summary> ///<summary>
///The X-Ram Extension is provided on the top-end Sound Blaster X-Fi solutions (Sound Blaster X-Fi Fatal1ty, Sound Blaster X-Fi Elite Pro, or later).
///These products feature 64MB of X-Ram that can only be used for audio purposes, which can be controlled by this Extension.
///</summary>
[CLSCompliant(true)] [CLSCompliant(true)]
public sealed class XRamExtension public sealed class XRamExtension
{ {
@ -56,6 +59,9 @@ namespace OpenTK.Audio.OpenAL
#region Constructor / Extension Loading #region Constructor / Extension Loading
/// <summary>
/// Constructs a new XRamExtension instance.
/// </summary>
public XRamExtension() public XRamExtension()
{ // Query if Extension supported and retrieve Tokens/Pointers if it is. { // Query if Extension supported and retrieve Tokens/Pointers if it is.
_valid = false; _valid = false;

View file

@ -60,7 +60,7 @@ namespace OpenTK.Audio.OpenAL
} }
/// <summary> /// <summary>
/// Defines available parameters for <see cref="OpenTK.Audio.Alc.GetString(IntPtr, AlcGetString)"/>. /// Defines available parameters for <see cref="OpenTK.Audio.OpenAL.Alc.GetString(IntPtr, AlcGetString)"/>.
/// </summary> /// </summary>
public enum AlcGetString : int public enum AlcGetString : int
{ {

View file

@ -66,9 +66,6 @@ namespace OpenTK.Graphics
bool ErrorChecking { get; set; } bool ErrorChecking { get; set; }
} }
[Obsolete]
public delegate void DestroyEvent<T>(T sender, EventArgs e);
// Functions for internal use by OpenTK. // Functions for internal use by OpenTK.
// TODO: RegisterForDisposal/DisposeResources for 0.3.15 (GC & OpenGL) // TODO: RegisterForDisposal/DisposeResources for 0.3.15 (GC & OpenGL)
// TODO: Remove or move GetDisplayModes to another class. // TODO: Remove or move GetDisplayModes to another class.

View file

@ -42,7 +42,6 @@ namespace OpenTK.Input
// Todo: The following line triggers bogus CS0214 in gmcs 2.0.1, sigh... // Todo: The following line triggers bogus CS0214 in gmcs 2.0.1, sigh...
// Need to add a workaround using either ExplicitLayout or another trick. // Need to add a workaround using either ExplicitLayout or another trick.
//unsafe fixed int Keys[NumKeys]; //unsafe fixed int Keys[NumKeys];
readonly int[] Keys;
#endregion #endregion

View file

@ -87,6 +87,10 @@ namespace OpenTK
/// </summary> /// </summary>
public float Height { get { return (float)System.Math.Abs(Bottom - Top); } } public float Height { get { return (float)System.Math.Abs(Bottom - Top); } }
/// <summary>
/// Returns a <see cref="System.String"/> describing the current instance.
/// </summary>
/// <returns></returns>
public override string ToString() public override string ToString()
{ {
return String.Format("({0},{1})-({2},{3})", Left, Top, Right, Bottom); return String.Format("({0},{1})-({2},{3})", Left, Top, Right, Bottom);

View file

@ -71,20 +71,6 @@ namespace OpenTK
/// </summary> /// </summary>
public const float Log2E = 1.442695041f; public const float Log2E = 1.442695041f;
[Obsolete]
public static readonly float PIF = 3.141592653589793238462643383279502884197169399375105820974944592307816406286208998628034825342117067982148086513282306647093844609550582231725359408128481117450284102701938521105559644622948954930382f;
[Obsolete]
public static readonly float RTODF = 180.0f / PIF;
[Obsolete]
public static readonly float DTORF = PIF / 180.0f;
[Obsolete]
public static readonly double PI = 3.141592653589793238462643383279502884197169399375105820974944592307816406286208998628034825342117067982148086513282306647093844609550582231725359408128481117450284102701938521105559644622948954930382d;
[Obsolete]
public static readonly double RTOD = 180.0d / PIF;
[Obsolete]
public static readonly double DTOR = PIF / 180.0d;
#endregion #endregion
#region Public Members #region Public Members