From 918b7b49ce9422350e0da9620223546bd6a3faff Mon Sep 17 00:00:00 2001 From: the_fiddler Date: Thu, 4 Jun 2009 10:56:07 +0000 Subject: [PATCH] Fixed missing documentation warnings. --- Source/OpenTK/Audio/OpenAL/Alc/AlcEnums.cs | 16 +++++++++++++++- Source/OpenTK/Audio/OpenAL/Alut/AlutEnums.cs | 18 +++++++++++++++++- 2 files changed, 32 insertions(+), 2 deletions(-) diff --git a/Source/OpenTK/Audio/OpenAL/Alc/AlcEnums.cs b/Source/OpenTK/Audio/OpenAL/Alc/AlcEnums.cs index 89e8fd03..9c1dba7c 100644 --- a/Source/OpenTK/Audio/OpenAL/Alc/AlcEnums.cs +++ b/Source/OpenTK/Audio/OpenAL/Alc/AlcEnums.cs @@ -11,7 +11,9 @@ using System; namespace OpenTK.Audio { - + /// + /// Defines available context attributes. + /// public enum AlcContextAttributes : int { ///Followed by System.Int32 Hz @@ -33,6 +35,9 @@ namespace OpenTK.Audio EfxMaxAuxiliarySends = 0x20003, } + /// + /// Defines OpenAL context errors. + /// public enum AlcError : int { ///There is no current error. @@ -54,6 +59,9 @@ namespace OpenTK.Audio OutOfMemory = 0xA005, } + /// + /// Defines available parameters for . + /// public enum AlcGetString : int { ///The specifier string for the default device. @@ -80,6 +88,9 @@ namespace OpenTK.Audio AllDevicesSpecifier = 0x1013, } + /// + /// Defines available parameters for . + /// public enum AlcGetStringList : int { ///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 @@ -92,6 +103,9 @@ namespace OpenTK.Audio AllDevicesSpecifier = 0x1013, } + /// + /// Defines available parameters for . + /// public enum AlcGetInteger : int { ///The specification revision for this implementation (major version). NULL is an acceptable device. diff --git a/Source/OpenTK/Audio/OpenAL/Alut/AlutEnums.cs b/Source/OpenTK/Audio/OpenAL/Alut/AlutEnums.cs index 53901b19..4555fd13 100644 --- a/Source/OpenTK/Audio/OpenAL/Alut/AlutEnums.cs +++ b/Source/OpenTK/Audio/OpenAL/Alut/AlutEnums.cs @@ -11,7 +11,9 @@ using System; namespace OpenTK.Audio { - + /// + /// Defines the version of the Alut library. + /// public enum AlutVersions : int { /// Defines the A in OpenAL A.B @@ -20,6 +22,9 @@ namespace OpenTK.Audio ApiMinorVersion = 1, } + /// + /// Defines available alut error codes. + /// public enum AlutError : int { /// No ALUT error found. @@ -62,15 +67,26 @@ namespace OpenTK.Audio CorruptOrTruncatedData = 0x211, } + /// + /// Defines available alut waveform types. + /// public enum AlutWaveform : int { + /// A sine waveform Sine = 0x100, + /// A square waveform Square = 0x101, + /// A sawtooth waveform SawTooth = 0x102, + /// A waveform containing white noise WhiteNoise = 0x103, + /// A waveform containing an impusle Impulse = 0x104, } + /// + /// Defines parameters for alut loaders. + /// public enum AlutLoader : int { ///For the loaders returning sound buffer in an OpenAL buffer, e.g. Alut.CreateBufferFromFile and Alut.CreateBufferFromFileImage