Fix formatting/update doc comments in Raylib.cs

Raylib-cs/Raylib.cs

@@ -374,7 +374,7 @@ namespace Raylib_cs
         /// </summary>
         public int triangleCount;
 
-#region Default vertex data
+        #region Default vertex data
 
         /// <summary>
         /// Vertex position (XYZ - 3 components per vertex) (shader-location = 0, float *)
@@ -411,9 +411,9 @@ namespace Raylib_cs
         /// </summary>
         public IntPtr indices;
 
-#endregion
+        #endregion
 
-#region Animation vertex data
+        #region Animation vertex data
 
         /// <summary>
         /// Animated vertex positions (after bones transformations, float *)
@@ -435,9 +435,9 @@ namespace Raylib_cs
         /// </summary>
         public IntPtr boneWeights;
 
-#endregion
+        #endregion
 
-#region OpenGL identifiers
+        #region OpenGL identifiers
 
         /// <summary>
         /// OpenGL Vertex Array Object id
@@ -449,7 +449,7 @@ namespace Raylib_cs
         /// </summary>
         public IntPtr vboId;
 
-#endregion
+        #endregion
     }
 
     /// <summary>
@@ -608,7 +608,6 @@ namespace Raylib_cs
     [StructLayout(LayoutKind.Sequential)]
     public struct ModelAnimation
     {
-
         /// <summary>
         /// Number of bones
         /// </summary>
@@ -634,7 +633,6 @@ namespace Raylib_cs
     [StructLayout(LayoutKind.Sequential)]
     public struct Ray
     {
-
         /// <summary>
         /// Ray position (origin)
         /// </summary>
@@ -656,7 +654,6 @@ namespace Raylib_cs
     [StructLayout(LayoutKind.Sequential)]
     public struct RayHitInfo
     {
-
         /// <summary>
         /// Did the ray hit something?
         /// </summary>
@@ -682,7 +679,6 @@ namespace Raylib_cs
     [StructLayout(LayoutKind.Sequential)]
     public struct BoundingBox
     {
-
         /// <summary>
         /// Minimum vertex box-corner
         /// </summary>
@@ -704,7 +700,6 @@ namespace Raylib_cs
     [StructLayout(LayoutKind.Sequential)]
     public struct Wave
     {
-
         /// <summary>
         /// Number of samples
         /// </summary>
@@ -736,7 +731,6 @@ namespace Raylib_cs
     [StructLayout(LayoutKind.Sequential)]
     public struct AudioStream
     {
-
         /// <summary>
         /// Pointer to internal data(rAudioBuffer *) used by the audio system
         /// </summary>
@@ -762,7 +756,6 @@ namespace Raylib_cs
     [StructLayout(LayoutKind.Sequential)]
     public struct Sound
     {
-
         /// <summary>
         /// Audio stream
         /// </summary>
@@ -779,7 +772,6 @@ namespace Raylib_cs
     [StructLayout(LayoutKind.Sequential)]
     public struct Music
     {
-
         /// <summary>
         /// Audio stream
         /// </summary>
@@ -810,7 +802,6 @@ namespace Raylib_cs
     [StructLayout(LayoutKind.Sequential)]
     public unsafe struct VrDeviceInfo
     {
-
         /// <summary>
         /// HMD horizontal resolution in pixels
         /// </summary>
@@ -866,7 +857,6 @@ namespace Raylib_cs
     [StructLayout(LayoutKind.Sequential)]
     public struct VrStereoConfig
     {
-
         /// <summary>
         /// VR projection matrices (per eye)
         /// </summary>
@@ -924,7 +914,6 @@ namespace Raylib_cs
     [Flags]
     public enum ConfigFlags
     {
-
         /// <summary>
         /// Set to try enabling V-Sync on GPU
         /// </summary>
@@ -996,19 +985,43 @@ namespace Raylib_cs
         FLAG_INTERLACED_HINT = 0x00010000,
     }
 
-    /// <summary>Trace log level</summary>
+    /// <summary>Trace log level
+    /// NOTE: Organized by priority level</summary>
     public enum TraceLogLevel
     {
-
         /// <summary>
         /// Display all logs
         /// </summary>
         LOG_ALL = 0,
+
+        /// <summary>
+        /// Trace logging, intended for internal use only
+        /// </summary>
         LOG_TRACE,
+
+        /// <summary>
+        /// Debug logging, used for internal debugging, it should be disabled on release builds
+        /// </summary>
         LOG_DEBUG,
+
+        /// <summary>
+        /// Info logging, used for program execution info
+        /// </summary>
         LOG_INFO,
+
+        /// <summary>
+        /// Warning logging, used on recoverable failures
+        /// </summary>
         LOG_WARNING,
+
+        /// <summary>
+        /// Error logging, used on unrecoverable failures
+        /// </summary>
         LOG_ERROR,
+
+        /// <summary>
+        /// Fatal logging, used to abort program: exit(EXIT_FAILURE)
+        /// </summary>
         LOG_FATAL,
 
         /// <summary>
@@ -1022,6 +1035,9 @@ namespace Raylib_cs
     /// required keys for alternative layouts</summary>
     public enum KeyboardKey
     {
+        /// <summary>
+        /// NULL, used for no key pressed
+        /// </summary>
         KEY_NULL = 0,
 
         // Alphanumeric keys
@@ -1145,32 +1161,62 @@ namespace Raylib_cs
     /// <summary>Mouse buttons</summary>
     public enum MouseButton
     {
-        MOUSE_LEFT_BUTTON = 0,
+        /// <summary>
-        MOUSE_RIGHT_BUTTON = 1,
+        /// Mouse button left
-        MOUSE_MIDDLE_BUTTON = 2
+        /// </summary>
+        MOUSE_BUTTON_LEFT = 0,
+
+        /// <summary>
+        /// Mouse button right
+        /// </summary>
+        MOUSE_BUTTON_RIGHT = 1,
+
+        /// <summary>
+        /// Mouse button middle (pressed wheel)
+        /// </summary>
+        MOUSE_BUTTON_MIDDLE = 2,
     }
 
     /// <summary>Mouse cursor</summary>
     public enum MouseCursor
     {
+        /// <summary>
+        /// Default pointer shape
+        /// </summary>
         MOUSE_CURSOR_DEFAULT = 0,
+
+        /// <summary>
+        /// Arrow shape
+        /// </summary>
         MOUSE_CURSOR_ARROW = 1,
+
+        /// <summary>
+        /// Text writing cursor shape
+        /// </summary>
         MOUSE_CURSOR_IBEAM = 2,
+
+        /// <summary>
+        /// Cross shape
+        /// </summary>
         MOUSE_CURSOR_CROSSHAIR = 3,
+
+        /// <summary>
+        /// Pointing hand cursor
+        /// </summary>
         MOUSE_CURSOR_POINTING_HAND = 4,
 
         /// <summary>
-        /// The horizontal resize/move arrow shape
+        /// Horizontal resize/move arrow shape
         /// </summary>
         MOUSE_CURSOR_RESIZE_EW = 5,
 
         /// <summary>
-        /// The vertical resize/move arrow shape
+        /// Vertical resize/move arrow shape
         /// </summary>
         MOUSE_CURSOR_RESIZE_NS = 6,
 
         /// <summary>
-        /// The top-left to bottom-right diagonal resize/move arrow shape
+        /// Top-left to bottom-right diagonal resize/move arrow shape
         /// </summary>
         MOUSE_CURSOR_RESIZE_NWSE = 7,
 
@@ -1193,22 +1239,49 @@ namespace Raylib_cs
     /// <summary>Gamepad buttons</summary>
     public enum GamepadButton
     {
-        // This is here just for error checking
+        /// <summary>
+        /// This is here just for error checking
+        /// </summary>
         GAMEPAD_BUTTON_UNKNOWN = 0,
 
-        // This is normally a DPAD
+        /// <summary>
+        /// Gamepad left DPAD up button
+        /// </summary>
         GAMEPAD_BUTTON_LEFT_FACE_UP,
+
+        /// <summary>
+        /// Gamepad left DPAD right button
+        /// </summary>
         GAMEPAD_BUTTON_LEFT_FACE_RIGHT,
+
+        /// <summary>
+        /// Gamepad left DPAD down button
+        /// </summary>
         GAMEPAD_BUTTON_LEFT_FACE_DOWN,
+
+        /// <summary>
+        /// Gamepad left DPAD left button
+        /// </summary>
         GAMEPAD_BUTTON_LEFT_FACE_LEFT,
 
-        // This normally corresponds with PlayStation and Xbox controllers
+        /// <summary>
-        // XBOX: [Y,X,A,B]
+        /// Gamepad right button up (i.e. PS3: Triangle, Xbox: Y)
-        // PS3: [Triangle,Square,Cross,Circle]
+        /// </summary>
-        // No support for 6 button controllers though..
         GAMEPAD_BUTTON_RIGHT_FACE_UP,
+
+        /// <summary>
+        /// Gamepad right button right (i.e. PS3: Square, Xbox: X)
+        /// </summary>
         GAMEPAD_BUTTON_RIGHT_FACE_RIGHT,
+
+        /// <summary>
+        /// Gamepad right button down (i.e. PS3: Cross, Xbox: A)
+        /// </summary>
         GAMEPAD_BUTTON_RIGHT_FACE_DOWN,
+
+        /// <summary>
+        /// Gamepad right button left (i.e. PS3: Circle, Xbox: B)
+        /// </summary>
         GAMEPAD_BUTTON_RIGHT_FACE_LEFT,
 
         // Triggers
@@ -1248,7 +1321,6 @@ namespace Raylib_cs
     /// <summary>Gamepad axis</summary>
     public enum GamepadAxis
     {
-
         /// <summary>
         /// Gamepad left stick X axis
         /// </summary>
@@ -1283,7 +1355,6 @@ namespace Raylib_cs
     /// <summary>Material map index</summary>
     public enum MaterialMapIndex
     {
-
         /// <summary>
         /// MAP_DIFFUSE
         /// </summary>
@@ -1293,12 +1364,13 @@ namespace Raylib_cs
         /// MAP_SPECULAR
         /// </summary>
         MATERIAL_MAP_METALNESS = 1,
+
         MATERIAL_MAP_NORMAL = 2,
         MATERIAL_MAP_ROUGHNESS = 3,
         MATERIAL_MAP_OCCLUSION,
         MATERIAL_MAP_EMISSION,
         MATERIAL_MAP_HEIGHT,
-        MATERIAL_MAP_BRDF,
+
         /// <summary>
         /// NOTE: Uses GL_TEXTURE_CUBE_MAP
         /// </summary>
@@ -1314,6 +1386,8 @@ namespace Raylib_cs
         /// </summary>
         MATERIAL_MAP_PREFILTER,
 
+        MATERIAL_MAP_BRDF,
+
         MATERIAL_MAP_DIFFUSE = MATERIAL_MAP_ALBEDO,
         MATERIAL_MAP_SPECULAR = MATERIAL_MAP_METALNESS,
     }
@@ -1336,15 +1410,7 @@ namespace Raylib_cs
         SHADER_LOC_COLOR_DIFFUSE,
         SHADER_LOC_COLOR_SPECULAR,
         SHADER_LOC_COLOR_AMBIENT,
-
-        /// <summary>
-        /// SHADER_LOC_MAP_DIFFUSE
-        /// </summary>
         SHADER_LOC_MAP_ALBEDO,
-
-        /// <summary>
-        /// SHADER_LOC_MAP_SPECULAR
-        /// </summary>
         SHADER_LOC_MAP_METALNESS,
         SHADER_LOC_MAP_NORMAL,
         SHADER_LOC_MAP_ROUGHNESS,
@@ -1378,7 +1444,6 @@ namespace Raylib_cs
     /// NOTE: Support depends on OpenGL version and platform</summary>
     public enum PixelFormat
     {
-
         /// <summary>
         /// 8 bit per pixel (no alpha)
         /// </summary>
@@ -1490,7 +1555,6 @@ namespace Raylib_cs
     /// NOTE 2: Filter is accordingly set for minification and magnification</summary>
     public enum TextureFilter
     {
-
         /// <summary>
         /// No filter, just pixel aproximation
         /// </summary>
@@ -1525,7 +1589,6 @@ namespace Raylib_cs
     /// <summary>Texture parameters: wrap mode</summary>
     public enum TextureWrap
     {
-
         /// <summary>
         /// Repeats texture in tiled mode
         /// </summary>
@@ -1550,7 +1613,6 @@ namespace Raylib_cs
     /// <summary>Cubemap layouts</summary>
     public enum CubemapLayout
     {
-
         /// <summary>
         /// Automatically detect layout type
         /// </summary>
@@ -1585,7 +1647,6 @@ namespace Raylib_cs
     /// <summary>Font type, defines generation method</summary>
     public enum FontType
     {
-
         /// <summary>
         /// Default font generation, anti-aliased
         /// </summary>
@@ -1605,7 +1666,6 @@ namespace Raylib_cs
     /// <summary>Color blending modes (pre-defined)</summary>
     public enum BlendMode
     {
-
         /// <summary>
         /// Blend textures considering alpha (default)
         /// </summary>
@@ -1632,7 +1692,7 @@ namespace Raylib_cs
         BLEND_SUBTRACT_COLORS,
 
         /// <summary>
-        /// Belnd textures using custom src/dst factors (use rlSetBlendMode())
+        /// Blend textures using custom src/dst factors (use rlSetBlendMode())
         /// </summary>
         BLEND_CUSTOM
     }
@@ -1675,7 +1735,6 @@ namespace Raylib_cs
     /// <summary>N-patch layout</summary>
     public enum NPatchLayout
     {
-
         /// <summary>
         /// Npatch defined by 3x3 tiles
         /// </summary>