From 958ab3e6013672463ca2e2504f9bfd738d7a2a97 Mon Sep 17 00:00:00 2001
From: Ben Parsons <9parsonsb@gmail.com>
Date: Thu, 11 Nov 2021 21:57:13 +1100
Subject: [PATCH] Update XmlDoc comments
---
Raylib-cs/Raylib.cs | 13 ++++++++++---
1 file changed, 10 insertions(+), 3 deletions(-)
diff --git a/Raylib-cs/Raylib.cs b/Raylib-cs/Raylib.cs
index 4d54d10..beaf96f 100644
--- a/Raylib-cs/Raylib.cs
+++ b/Raylib-cs/Raylib.cs
@@ -8,7 +8,9 @@ namespace Raylib_cs
[SuppressUnmanagedCodeSecurity]
public static class Raylib
{
- // Used by DllImport to load the native library.
+ ///
+ /// Used by DllImport to load the native library.
+ ///
public const string nativeLibName = "raylib";
public const string RAYLIB_VERSION = "4.0";
@@ -17,15 +19,17 @@ namespace Raylib_cs
public const float RAD2DEG = 180.0f / MathF.PI;
// Callbacks to hook some internal functions
- // WARNING: This callbacks are intended for advance users
+ // WARNING: These callbacks are intended for advance users
///
- /// Logging: Redirect trace log messages
+ /// Logging: Redirect trace log messages
+ /// WARNING: This callback is intended for advance users
///
[UnmanagedFunctionPointer(CallingConvention.Cdecl)]
public delegate void TraceLogCallback(TraceLogLevel logLevel, string text, IntPtr args);
///
/// FileIO: Load binary data
+ /// WARNING: This callback is intended for advance users
///
/// refers to a unsigned char *
[UnmanagedFunctionPointer(CallingConvention.Cdecl)]
@@ -33,6 +37,7 @@ namespace Raylib_cs
///
/// FileIO: Save binary data
+ /// WARNING: This callback is intended for advance users
///
/// refers to a void *
[UnmanagedFunctionPointer(CallingConvention.Cdecl)]
@@ -40,12 +45,14 @@ namespace Raylib_cs
///
/// FileIO: Load text data
+ /// WARNING: This callback is intended for advance users
///
[UnmanagedFunctionPointer(CallingConvention.Cdecl)]
public delegate string LoadFileTextCallback(string fileName);
///
/// FileIO: Save text data
+ /// WARNING: This callback is intended for advance users
///
[UnmanagedFunctionPointer(CallingConvention.Cdecl)]
public delegate bool SaveFileTextCallback(string fileName, string text);