From 1bdc6b6634e2a622fbc23a2641c8a606ee2fc17e Mon Sep 17 00:00:00 2001 From: the_fiddler Date: Sun, 28 Jun 2009 10:49:10 +0000 Subject: [PATCH] Added missing XML docs. --- .../Audio/OpenAL/AL/EffectsExtension.cs | 3 + .../Audio/OpenAL/AL/EffectsExtensionEnums.cs | 90 +++++++++++++++++++ Source/OpenTK/GameWindow.cs | 6 ++ Source/OpenTK/Math/Quaternion.cs | 12 +++ Source/OpenTK/Math/Quaterniond.cs | 12 +++ Source/Utilities/Audio/AudioReader.cs | 9 ++ Source/Utilities/Fonts/TextureFont.cs | 3 + 7 files changed, 135 insertions(+) diff --git a/Source/OpenTK/Audio/OpenAL/AL/EffectsExtension.cs b/Source/OpenTK/Audio/OpenAL/AL/EffectsExtension.cs index 3d3dd701..b48d6d5a 100644 --- a/Source/OpenTK/Audio/OpenAL/AL/EffectsExtension.cs +++ b/Source/OpenTK/Audio/OpenAL/AL/EffectsExtension.cs @@ -1209,6 +1209,9 @@ namespace OpenTK.Audio } } + /// + /// Constructs a new EffectsExtension instance. + /// public EffectsExtension() { _valid = false; diff --git a/Source/OpenTK/Audio/OpenAL/AL/EffectsExtensionEnums.cs b/Source/OpenTK/Audio/OpenAL/AL/EffectsExtensionEnums.cs index 1e860d70..d5fe17a5 100644 --- a/Source/OpenTK/Audio/OpenAL/AL/EffectsExtensionEnums.cs +++ b/Source/OpenTK/Audio/OpenAL/AL/EffectsExtensionEnums.cs @@ -226,35 +226,125 @@ namespace OpenTK.Audio ///Vocal morpher effect parameters. If both parameters are set to the same phoneme, that determines the filtering effect that will be heard. If these two parameters are set to different phonemes, the filtering effect will morph between the two settings at a rate specified by EfxEffectf.VocalMorpherRate. public enum EfxFormantFilterSettings : int { + /// + /// Phoneme A of the vocal morpher. + /// VocalMorpherPhonemeA = 0, + /// + /// Phoneme E of the vocal morpher. + /// VocalMorpherPhonemeE = 1, + /// + /// Phoneme I of the vocal morpher. + /// VocalMorpherPhonemeI = 2, + /// + /// Phoneme O of the vocal morpher. + /// VocalMorpherPhonemeO = 3, + /// + /// Phoneme U of the vocal morpher. + /// VocalMorpherPhonemeU = 4, + /// + /// Phoneme AA of the vocal morpher. + /// VocalMorpherPhonemeAA = 5, + /// + /// Phoneme AE of the vocal morpher. + /// VocalMorpherPhonemeAE = 6, + /// + /// Phoneme AH of the vocal morpher. + /// VocalMorpherPhonemeAH = 7, + /// + /// Phoneme AO of the vocal morpher. + /// VocalMorpherPhonemeAO = 8, + /// + /// Phoneme EH of the vocal morpher. + /// VocalMorpherPhonemeEH = 9, + /// + /// Phoneme ER of the vocal morpher. + /// VocalMorpherPhonemeER = 10, + /// + /// Phoneme IH of the vocal morpher. + /// VocalMorpherPhonemeIH = 11, + /// + /// Phoneme IY of the vocal morpher. + /// VocalMorpherPhonemeIY = 12, + /// + /// Phoneme UH of the vocal morpher. + /// VocalMorpherPhonemeUH = 13, + /// + /// Phoneme UW of the vocal morpher. + /// VocalMorpherPhonemeUW = 14, + /// + /// Phoneme B of the vocal morpher. + /// VocalMorpherPhonemeB = 15, + /// + /// Phoneme D of the vocal morpher. + /// VocalMorpherPhonemeD = 16, + /// + /// Phoneme F of the vocal morpher. + /// VocalMorpherPhonemeF = 17, + /// + /// Phoneme G of the vocal morpher. + /// VocalMorpherPhonemeG = 18, + /// + /// Phoneme J of the vocal morpher. + /// VocalMorpherPhonemeJ = 19, + /// + /// Phoneme K of the vocal morpher. + /// VocalMorpherPhonemeK = 20, + /// + /// Phoneme L of the vocal morpher. + /// VocalMorpherPhonemeL = 21, + /// + /// Phoneme M of the vocal morpher. + /// VocalMorpherPhonemeM = 22, + /// + /// Phoneme N of the vocal morpher. + /// VocalMorpherPhonemeN = 23, + /// + /// Phoneme P of the vocal morpher. + /// VocalMorpherPhonemeP = 24, + /// + /// Phoneme R of the vocal morpher. + /// VocalMorpherPhonemeR = 25, + /// + /// Phoneme S of the vocal morpher. + /// VocalMorpherPhonemeS = 26, + /// + /// Phoneme T of the vocal morpher. + /// VocalMorpherPhonemeT = 27, + /// + /// Phoneme V of the vocal morpher. + /// VocalMorpherPhonemeV = 28, + /// + /// Phoneme Z of the vocal morpher. + /// VocalMorpherPhonemeZ = 29, } diff --git a/Source/OpenTK/GameWindow.cs b/Source/OpenTK/GameWindow.cs index 47bb9330..9969e88c 100644 --- a/Source/OpenTK/GameWindow.cs +++ b/Source/OpenTK/GameWindow.cs @@ -1349,6 +1349,9 @@ namespace OpenTK #region InputDriver + /// + /// This property is deprecated. + /// [Obsolete] public IInputDriver InputDriver { @@ -1365,6 +1368,9 @@ namespace OpenTK #region Close + /// + /// Closes the GameWindow. Equivalent to calling . + /// public void Close() { Exit(); diff --git a/Source/OpenTK/Math/Quaternion.cs b/Source/OpenTK/Math/Quaternion.cs index 96eb83f0..3fdc5383 100644 --- a/Source/OpenTK/Math/Quaternion.cs +++ b/Source/OpenTK/Math/Quaternion.cs @@ -260,6 +260,12 @@ namespace OpenTK #region Sub + /// + /// Subtracts two instances. + /// + /// The left instance. + /// The right instance. + /// The result of the operation. public static Quaternion Sub(Quaternion left, Quaternion right) { return new Quaternion( @@ -267,6 +273,12 @@ namespace OpenTK left.W - right.W); } + /// + /// Subtracts two instances. + /// + /// The left instance. + /// The right instance. + /// The result of the operation. public static void Sub(ref Quaternion left, ref Quaternion right, out Quaternion result) { result = new Quaternion( diff --git a/Source/OpenTK/Math/Quaterniond.cs b/Source/OpenTK/Math/Quaterniond.cs index 16f0612f..1c4bdb52 100644 --- a/Source/OpenTK/Math/Quaterniond.cs +++ b/Source/OpenTK/Math/Quaterniond.cs @@ -260,6 +260,12 @@ namespace OpenTK #region Sub + /// + /// Subtracts two instances. + /// + /// The left instance. + /// The right instance. + /// The result of the operation. public static Quaterniond Sub(Quaterniond left, Quaterniond right) { return new Quaterniond( @@ -267,6 +273,12 @@ namespace OpenTK left.W - right.W); } + /// + /// Subtracts two instances. + /// + /// The left instance. + /// The right instance. + /// The result of the operation. public static void Sub(ref Quaterniond left, ref Quaterniond right, out Quaterniond result) { result = new Quaterniond( diff --git a/Source/Utilities/Audio/AudioReader.cs b/Source/Utilities/Audio/AudioReader.cs index 27813e7a..fc0abf29 100644 --- a/Source/Utilities/Audio/AudioReader.cs +++ b/Source/Utilities/Audio/AudioReader.cs @@ -171,6 +171,9 @@ namespace OpenTK.Audio #region public virtual bool EndOfFile + /// + /// Returns true if the AudioReader has reached the end of the file. + /// public virtual bool EndOfFile { get @@ -187,6 +190,9 @@ namespace OpenTK.Audio #region --- Protected Members --- + /// + /// Gets or sets the input of the AudioReader. + /// protected virtual Stream Stream { get { return stream; } @@ -216,6 +222,9 @@ namespace OpenTK.Audio } } + /// + /// Finalizes this AudioReader. + /// ~AudioReader() { this.Dispose(false); diff --git a/Source/Utilities/Fonts/TextureFont.cs b/Source/Utilities/Fonts/TextureFont.cs index cddce112..d3af128a 100644 --- a/Source/Utilities/Fonts/TextureFont.cs +++ b/Source/Utilities/Fonts/TextureFont.cs @@ -550,6 +550,9 @@ namespace OpenTK.Graphics } } + /// + /// Finalizes this TextureFont. + /// ~TextureFont() { Dispose(false);