mirror of
https://github.com/Ryujinx/Opentk.git
synced 2025-01-11 11:55:38 +00:00
Fixed a large number of XML documentation warnings.
This commit is contained in:
parent
083478e8a5
commit
5cb476942a
|
@ -16,7 +16,6 @@ namespace OpenTK.Audio
|
|||
/// <summary>
|
||||
/// Encapsulates a sound stream and provides decoding and streaming capabilities.
|
||||
/// </summary>
|
||||
/// <typeparam name="SampleType"></typeparam>
|
||||
public class AudioReader : IDisposable
|
||||
{
|
||||
static object reader_lock = new object();
|
||||
|
@ -119,7 +118,7 @@ namespace OpenTK.Audio
|
|||
/// <summary>
|
||||
/// When overriden in a derived class, reads and decodes the specified number of samples from the sound stream.
|
||||
/// </summary>
|
||||
/// <param name="samples">The number of samples to read and decode.</param>
|
||||
/// <param name="count">The number of samples to read and decode.</param>
|
||||
/// <returns>An OpenTK.Audio.SoundData object that contains the decoded buffer.</returns>
|
||||
public virtual SoundData ReadSamples(long count)
|
||||
{
|
||||
|
|
|
@ -25,11 +25,7 @@ namespace OpenTK.Graphics
|
|||
|
||||
#region --- Constructors ---
|
||||
|
||||
/// <summary>
|
||||
/// Constructs a new Glyph that represents the given character and Font.
|
||||
/// </summary>
|
||||
/// <param name="c">The character to represent.</param>
|
||||
/// <param name="f">The Font of the character.</param>
|
||||
// Constructs a new Glyph that represents the given character and Font.
|
||||
public Glyph(char c, Font f, SizeF s)
|
||||
{
|
||||
if (f == null)
|
||||
|
|
|
@ -81,7 +81,7 @@ namespace OpenTK.Graphics
|
|||
/// <summary>
|
||||
/// Constructs a new TextureFont, using the specified parameters.
|
||||
/// </summary>
|
||||
/// <param name="font">The System.Drawing.FontFamily to use for the typeface.</param>
|
||||
/// <param name="family">The System.Drawing.FontFamily to use for the typeface.</param>
|
||||
/// <param name="emSize">The em size to use for the typeface.</param>
|
||||
public TextureFont(FontFamily family, float emSize)
|
||||
: this(new Font(family, emSize))
|
||||
|
@ -90,9 +90,9 @@ namespace OpenTK.Graphics
|
|||
/// <summary>
|
||||
/// Constructs a new TextureFont, using the specified parameters.
|
||||
/// </summary>
|
||||
/// <param name="font">The System.Drawing.FontFamily to use for the typeface.</param>
|
||||
/// <param name="family">The System.Drawing.FontFamily to use for the typeface.</param>
|
||||
/// <param name="emSize">The em size to use for the typeface.</param>
|
||||
/// <param name="family">The style to use for the typeface.</param>
|
||||
/// <param name="style">The style to use for the typeface.</param>
|
||||
public TextureFont(FontFamily family, float emSize, FontStyle style)
|
||||
: this(new Font(family, emSize, style))
|
||||
{ }
|
||||
|
@ -135,7 +135,7 @@ namespace OpenTK.Graphics
|
|||
/// <summary>
|
||||
/// Prepares the specified glyph for rendering.
|
||||
/// </summary>
|
||||
/// <param name="glyphs">The glyph to prepare for rendering.</param>
|
||||
/// <param name="glyph">The glyph to prepare for rendering.</param>
|
||||
public void LoadGlyph(char glyph)
|
||||
{
|
||||
RectangleF rect = new RectangleF();
|
||||
|
@ -225,7 +225,7 @@ namespace OpenTK.Graphics
|
|||
/// <param name="str">The string to measure.</param>
|
||||
/// <param name="width">The measured width.</param>
|
||||
/// <param name="height">The measured height.</param>
|
||||
/// <seealso cref="public void MeasureString(string str, out float width, out float height, bool accountForOverhangs)"/>
|
||||
/// <seealso cref="MeasureString(string, out float, out float, bool)"/>
|
||||
[Obsolete("Returns invalid results - use MeasureText() instead")]
|
||||
public void MeasureString(string str, out float width, out float height)
|
||||
{
|
||||
|
|
|
@ -78,7 +78,6 @@ namespace OpenTK.Graphics
|
|||
/// </summary>
|
||||
/// <param name="text">The System.String to measure.</param>
|
||||
/// <param name="font">The System.Drawing.Font that will be used to measure text.</param>
|
||||
/// <param name="rect">The System.Drawing.Rectangle that defines the bounds for text layout.</param>
|
||||
/// <returns>An OpenTK.Graphics.TextExtents instance that contains the results of the measurement.</returns>
|
||||
TextExtents Measure(string text, Font font);
|
||||
|
||||
|
@ -88,7 +87,6 @@ namespace OpenTK.Graphics
|
|||
/// <param name="text">The System.String to measure.</param>
|
||||
/// <param name="font">The System.Drawing.Font that will be used to measure text.</param>
|
||||
/// <param name="rect">The System.Drawing.Rectangle that defines the bounds for text layout.</param>
|
||||
/// <param name="options">The OpenTK.Graphics.TextPrinterOptions that will be used to measure text.</param>
|
||||
/// <returns>An OpenTK.Graphics.TextExtents instance that contains the results of the measurement.</returns>
|
||||
TextExtents Measure(string text, Font font, RectangleF rect);
|
||||
|
||||
|
@ -99,7 +97,6 @@ namespace OpenTK.Graphics
|
|||
/// <param name="font">The System.Drawing.Font that will be used to measure text.</param>
|
||||
/// <param name="rect">The System.Drawing.Rectangle that defines the bounds for text layout.</param>
|
||||
/// <param name="options">The OpenTK.Graphics.TextPrinterOptions that will be used to measure text.</param>
|
||||
/// <param name="alignment">The OpenTK.Graphics.TextAlignment that will be used to measure text.</param>
|
||||
/// <returns>An OpenTK.Graphics.TextExtents instance that contains the results of the measurement.</returns>
|
||||
TextExtents Measure(string text, Font font, RectangleF rect, TextPrinterOptions options);
|
||||
|
||||
|
|
|
@ -43,7 +43,7 @@ namespace OpenTK.Graphics.Text
|
|||
/// Constructs a new Glyph that represents the given character and Font.
|
||||
/// </summary>
|
||||
/// <param name="c">The character to represent.</param>
|
||||
/// <param name="f">The Font of the character.</param>
|
||||
/// <param name="font">The Font of the character.</param>
|
||||
public Glyph(char c, Font font)
|
||||
{
|
||||
if (font == null)
|
||||
|
|
|
@ -35,13 +35,7 @@ namespace OpenTK
|
|||
|
||||
#region public Rectangle Add(T item)
|
||||
|
||||
/// <summary>
|
||||
/// Packs the given item into the free space of the TexturePacker.
|
||||
/// </summary>
|
||||
/// <param name="item">The item to pack.</param>
|
||||
/// <returns>A System.Drawing.Rectangle containing the coordinates of the packed item.</returns>
|
||||
/// <exception cref="InvalidOperationException">Occurs if the item is larger than the available TexturePacker area</exception>
|
||||
/// <exception cref="ArgumentException">Occurs if the item already exists in the TexturePacker.</exception>
|
||||
// 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)
|
||||
|
|
Loading…
Reference in a new issue