Fixed missing documentation warnings.

This commit is contained in:
the_fiddler 2009-06-04 10:56:07 +00:00
parent 972cdcdae1
commit 6ff0ed17c4
2 changed files with 32 additions and 2 deletions

View file

@ -11,7 +11,9 @@ using System;
namespace OpenTK.Audio
{
/// <summary>
/// Defines available context attributes.
/// </summary>
public enum AlcContextAttributes : int
{
///<summary>Followed by System.Int32 Hz</summary>
@ -33,6 +35,9 @@ namespace OpenTK.Audio
EfxMaxAuxiliarySends = 0x20003,
}
/// <summary>
/// Defines OpenAL context errors.
/// </summary>
public enum AlcError : int
{
///<summary>There is no current error.</summary>
@ -54,6 +59,9 @@ namespace OpenTK.Audio
OutOfMemory = 0xA005,
}
/// <summary>
/// Defines available parameters for <see cref="OpenTK.Audio.Alc.GetString(IntPtr, AlcGetString)"/>.
/// </summary>
public enum AlcGetString : int
{
///<summary>The specifier string for the default device.</summary>
@ -80,6 +88,9 @@ namespace OpenTK.Audio
AllDevicesSpecifier = 0x1013,
}
/// <summary>
/// Defines available parameters for <see cref="OpenTK.Audio.Alc.GetString(IntPtr, AlcGetStringList)"/>.
/// </summary>
public enum AlcGetStringList : int
{
///<summary>The name of the specified capture device, or a list of all available capture devices if no capture device is specified. ALC_EXT_CAPTURE_EXT </summary>
@ -92,6 +103,9 @@ namespace OpenTK.Audio
AllDevicesSpecifier = 0x1013,
}
/// <summary>
/// Defines available parameters for <see cref="OpenTK.Audio.Alc.GetInteger(IntPtr, AlcGetInteger, int, out int)"/>.
/// </summary>
public enum AlcGetInteger : int
{
///<summary>The specification revision for this implementation (major version). NULL is an acceptable device.</summary>

View file

@ -11,7 +11,9 @@ using System;
namespace OpenTK.Audio
{
/// <summary>
/// Defines the version of the Alut library.
/// </summary>
public enum AlutVersions : int
{
/// <summary>Defines the A in OpenAL A.B</summary>
@ -20,6 +22,9 @@ namespace OpenTK.Audio
ApiMinorVersion = 1,
}
/// <summary>
/// Defines available alut error codes.
/// </summary>
public enum AlutError : int
{
/// <summary>No ALUT error found.</summary>
@ -62,15 +67,26 @@ namespace OpenTK.Audio
CorruptOrTruncatedData = 0x211,
}
/// <summary>
/// Defines available alut waveform types.
/// </summary>
public enum AlutWaveform : int
{
/// <summary>A sine waveform</summary>
Sine = 0x100,
/// <summary>A square waveform</summary>
Square = 0x101,
/// <summary>A sawtooth waveform</summary>
SawTooth = 0x102,
/// <summary>A waveform containing white noise</summary>
WhiteNoise = 0x103,
/// <summary>A waveform containing an impusle</summary>
Impulse = 0x104,
}
/// <summary>
/// Defines parameters for alut loaders.
/// </summary>
public enum AlutLoader : int
{
///<summary>For the loaders returning sound buffer in an OpenAL buffer, e.g. Alut.CreateBufferFromFile and Alut.CreateBufferFromFileImage</summary>