From 5cb476942a19de815b1bf19ebb73a2cb08e69499 Mon Sep 17 00:00:00 2001 From: the_fiddler Date: Sun, 17 May 2009 15:06:26 +0000 Subject: [PATCH] Fixed a large number of XML documentation warnings. --- Source/Utilities/Audio/AudioReader.cs | 3 +-- Source/Utilities/Fonts/Glyph.cs | 6 +----- Source/Utilities/Fonts/TextureFont.cs | 10 +++++----- Source/Utilities/Graphics/ITextPrinter.cs | 3 --- Source/Utilities/Graphics/Text/Glyph.cs | 2 +- Source/Utilities/TexturePacker.cs | 8 +------- 6 files changed, 9 insertions(+), 23 deletions(-) diff --git a/Source/Utilities/Audio/AudioReader.cs b/Source/Utilities/Audio/AudioReader.cs index 5b70de0a..27813e7a 100644 --- a/Source/Utilities/Audio/AudioReader.cs +++ b/Source/Utilities/Audio/AudioReader.cs @@ -16,7 +16,6 @@ namespace OpenTK.Audio /// /// Encapsulates a sound stream and provides decoding and streaming capabilities. /// - /// public class AudioReader : IDisposable { static object reader_lock = new object(); @@ -119,7 +118,7 @@ namespace OpenTK.Audio /// /// When overriden in a derived class, reads and decodes the specified number of samples from the sound stream. /// - /// The number of samples to read and decode. + /// The number of samples to read and decode. /// An OpenTK.Audio.SoundData object that contains the decoded buffer. public virtual SoundData ReadSamples(long count) { diff --git a/Source/Utilities/Fonts/Glyph.cs b/Source/Utilities/Fonts/Glyph.cs index 72bc7649..8cbb83c4 100644 --- a/Source/Utilities/Fonts/Glyph.cs +++ b/Source/Utilities/Fonts/Glyph.cs @@ -25,11 +25,7 @@ namespace OpenTK.Graphics #region --- Constructors --- - /// - /// Constructs a new Glyph that represents the given character and Font. - /// - /// The character to represent. - /// The Font of the character. + // Constructs a new Glyph that represents the given character and Font. public Glyph(char c, Font f, SizeF s) { if (f == null) diff --git a/Source/Utilities/Fonts/TextureFont.cs b/Source/Utilities/Fonts/TextureFont.cs index 705cd631..57cf80cf 100644 --- a/Source/Utilities/Fonts/TextureFont.cs +++ b/Source/Utilities/Fonts/TextureFont.cs @@ -81,7 +81,7 @@ namespace OpenTK.Graphics /// /// Constructs a new TextureFont, using the specified parameters. /// - /// The System.Drawing.FontFamily to use for the typeface. + /// The System.Drawing.FontFamily to use for the typeface. /// The em size to use for the typeface. public TextureFont(FontFamily family, float emSize) : this(new Font(family, emSize)) @@ -90,9 +90,9 @@ namespace OpenTK.Graphics /// /// Constructs a new TextureFont, using the specified parameters. /// - /// The System.Drawing.FontFamily to use for the typeface. + /// The System.Drawing.FontFamily to use for the typeface. /// The em size to use for the typeface. - /// The style to use for the typeface. + /// The style to use for the typeface. public TextureFont(FontFamily family, float emSize, FontStyle style) : this(new Font(family, emSize, style)) { } @@ -135,7 +135,7 @@ namespace OpenTK.Graphics /// /// Prepares the specified glyph for rendering. /// - /// The glyph to prepare for rendering. + /// The glyph to prepare for rendering. public void LoadGlyph(char glyph) { RectangleF rect = new RectangleF(); @@ -225,7 +225,7 @@ namespace OpenTK.Graphics /// The string to measure. /// The measured width. /// The measured height. - /// + /// [Obsolete("Returns invalid results - use MeasureText() instead")] public void MeasureString(string str, out float width, out float height) { diff --git a/Source/Utilities/Graphics/ITextPrinter.cs b/Source/Utilities/Graphics/ITextPrinter.cs index 953ab101..fb85def2 100644 --- a/Source/Utilities/Graphics/ITextPrinter.cs +++ b/Source/Utilities/Graphics/ITextPrinter.cs @@ -78,7 +78,6 @@ namespace OpenTK.Graphics /// /// The System.String to measure. /// The System.Drawing.Font that will be used to measure text. - /// The System.Drawing.Rectangle that defines the bounds for text layout. /// An OpenTK.Graphics.TextExtents instance that contains the results of the measurement. TextExtents Measure(string text, Font font); @@ -88,7 +87,6 @@ namespace OpenTK.Graphics /// The System.String to measure. /// The System.Drawing.Font that will be used to measure text. /// The System.Drawing.Rectangle that defines the bounds for text layout. - /// The OpenTK.Graphics.TextPrinterOptions that will be used to measure text. /// An OpenTK.Graphics.TextExtents instance that contains the results of the measurement. TextExtents Measure(string text, Font font, RectangleF rect); @@ -99,7 +97,6 @@ namespace OpenTK.Graphics /// The System.Drawing.Font that will be used to measure text. /// The System.Drawing.Rectangle that defines the bounds for text layout. /// The OpenTK.Graphics.TextPrinterOptions that will be used to measure text. - /// The OpenTK.Graphics.TextAlignment that will be used to measure text. /// An OpenTK.Graphics.TextExtents instance that contains the results of the measurement. TextExtents Measure(string text, Font font, RectangleF rect, TextPrinterOptions options); diff --git a/Source/Utilities/Graphics/Text/Glyph.cs b/Source/Utilities/Graphics/Text/Glyph.cs index abd584ed..e19ff328 100644 --- a/Source/Utilities/Graphics/Text/Glyph.cs +++ b/Source/Utilities/Graphics/Text/Glyph.cs @@ -43,7 +43,7 @@ namespace OpenTK.Graphics.Text /// Constructs a new Glyph that represents the given character and Font. /// /// The character to represent. - /// The Font of the character. + /// The Font of the character. public Glyph(char c, Font font) { if (font == null) diff --git a/Source/Utilities/TexturePacker.cs b/Source/Utilities/TexturePacker.cs index deace4d1..41be16a6 100644 --- a/Source/Utilities/TexturePacker.cs +++ b/Source/Utilities/TexturePacker.cs @@ -35,13 +35,7 @@ namespace OpenTK #region public Rectangle Add(T item) - /// - /// Packs the given item into the free space of the TexturePacker. - /// - /// The item to pack. - /// A System.Drawing.Rectangle containing the coordinates of the packed item. - /// Occurs if the item is larger than the available TexturePacker area - /// Occurs if the item already exists in the TexturePacker. + // Packs the given item into the free space of the TexturePacker. Returns the Rectangle of the packed item. public void Add(T item, out Rectangle rect) { if (item.Width > root.Rect.Width || item.Height > root.Rect.Height)