2
0
mirror of https://github.com/raylib-cs/raylib-cs synced 2025-09-09 03:01:41 -04:00

Update XmlDoc comments

This commit is contained in:
2021-11-11 12:00:42 +00:00
parent 5014ebbfe0
commit de6caec6f1
8 changed files with 67 additions and 63 deletions

View File

@@ -36,7 +36,7 @@ namespace Raylib_cs
}
/// <summary>
/// Audio stream type
/// Audio stream type<br/>
/// NOTE: Useful to create custom audio streams not bound to a specific file
/// </summary>
[StructLayout(LayoutKind.Sequential)]
@@ -81,7 +81,7 @@ namespace Raylib_cs
}
/// <summary>
/// Music stream type (audio file streaming from memory)
/// Music stream type (audio file streaming from memory)<br/>
/// NOTE: Anything longer than ~10 seconds should be streamed
/// </summary>
[StructLayout(LayoutKind.Sequential)]

View File

@@ -3,8 +3,10 @@ using System.Runtime.InteropServices;
namespace Raylib_cs
{
/// <summary>Pixel formats
/// NOTE: Support depends on OpenGL version and platform</summary>
/// <summary>
/// Pixel formats<br/>
/// NOTE: Support depends on OpenGL version and platform
/// </summary>
public enum PixelFormat
{
/// <summary>

View File

@@ -4,9 +4,10 @@ using System.Runtime.InteropServices;
namespace Raylib_cs
{
/// <summary>Keyboard keys (US keyboard layout)
/// NOTE: Use GetKeyPressed() to allow redefining
/// required keys for alternative layouts</summary>
/// <summary>
/// Keyboard keys (US keyboard layout)<br/>
/// NOTE: Use GetKeyPressed() to allow redefining required keys for alternative layouts
/// </summary>
public enum KeyboardKey
{
/// <summary>
@@ -350,8 +351,10 @@ namespace Raylib_cs
GAMEPAD_BUTTON_RIGHT_THUMB
}
/// <summary>Gesture
/// NOTE: It could be used as flags to enable only some gestures</summary>
/// <summary>
/// Gesture<br/>
/// NOTE: It could be used as flags to enable only some gestures
/// </summary>
[Flags]
public enum Gesture
{

View File

@@ -27,7 +27,7 @@ namespace Raylib_cs
}
/// <summary>
/// Vertex data definning a mesh
/// Vertex data definning a mesh<br/>
/// NOTE: Data stored in CPU memory (and GPU)
/// </summary>
[StructLayout(LayoutKind.Sequential)]

View File

@@ -2,9 +2,11 @@ using System.Runtime.InteropServices;
namespace Raylib_cs
{
/// <summary>Texture parameters: filter mode
/// NOTE 1: Filtering considers mipmaps if available in the texture
/// NOTE 2: Filter is accordingly set for minification and magnification</summary>
/// <summary>
/// Texture parameters: filter mode<br/>
/// NOTE 1: Filtering considers mipmaps if available in the texture<br/>
/// NOTE 2: Filter is accordingly set for minification and magnification
/// </summary>
public enum TextureFilter
{
/// <summary>
@@ -97,8 +99,7 @@ namespace Raylib_cs
}
/// <summary>
/// Texture2D type
/// <br />
/// Texture2D type<br />
/// NOTE: Data stored in GPU memory
/// </summary>
[StructLayout(LayoutKind.Sequential)]