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

Update comments to xmldoc

This commit is contained in:
2021-11-11 21:54:14 +11:00
parent e75368414d
commit 8684db9d10

View File

@@ -19,30 +19,41 @@ namespace Raylib_cs
// Callbacks to hook some internal functions // Callbacks to hook some internal functions
// WARNING: This callbacks are intended for advance users // WARNING: This callbacks are intended for advance users
// Logging: Redirect trace log messages /// <summary>
/// Logging: Redirect trace log messages
/// </summary>
[UnmanagedFunctionPointer(CallingConvention.Cdecl)] [UnmanagedFunctionPointer(CallingConvention.Cdecl)]
public delegate void TraceLogCallback(TraceLogLevel logLevel, string text, IntPtr args); public delegate void TraceLogCallback(TraceLogLevel logLevel, string text, IntPtr args);
/// <summary>
// FileIO: Load binary data /// FileIO: Load binary data
// IntPtr refers to a unsigned char * /// </summary>
/// <returns><see cref="IntPtr"/> refers to a unsigned char *</returns>
[UnmanagedFunctionPointer(CallingConvention.Cdecl)] [UnmanagedFunctionPointer(CallingConvention.Cdecl)]
public delegate IntPtr LoadFileDataCallback(string fileName, ref int bytesRead); public delegate IntPtr LoadFileDataCallback(string fileName, ref int bytesRead);
// FileIO: Save binary data /// <summary>
// IntPtr refers to a void * /// FileIO: Save binary data
/// </summary>
/// <returns><see cref="IntPtr"/> refers to a void *</returns>
[UnmanagedFunctionPointer(CallingConvention.Cdecl)] [UnmanagedFunctionPointer(CallingConvention.Cdecl)]
public delegate bool SaveFileDataCallback(string fileName, IntPtr data, ref int bytesToWrite); public delegate bool SaveFileDataCallback(string fileName, IntPtr data, ref int bytesToWrite);
// FileIO: Load text data /// <summary>
/// FileIO: Load text data
/// </summary>
[UnmanagedFunctionPointer(CallingConvention.Cdecl)] [UnmanagedFunctionPointer(CallingConvention.Cdecl)]
public delegate string LoadFileTextCallback(string fileName); public delegate string LoadFileTextCallback(string fileName);
// FileIO: Save text data /// <summary>
/// FileIO: Save text data
/// </summary>
[UnmanagedFunctionPointer(CallingConvention.Cdecl)] [UnmanagedFunctionPointer(CallingConvention.Cdecl)]
public delegate bool SaveFileTextCallback(string fileName, string text); public delegate bool SaveFileTextCallback(string fileName, string text);
// Returns color with alpha applied, alpha goes from 0.0f to 1.0f /// <summary>
// NOTE: Added for compatability with previous versions /// Returns color with alpha applied, alpha goes from 0.0f to 1.0f
/// NOTE: Added for compatability with previous versions
/// </summary>
public static Color Fade(Color color, float alpha) => ColorAlpha(color, alpha); public static Color Fade(Color color, float alpha) => ColorAlpha(color, alpha);
@@ -52,7 +63,9 @@ namespace Raylib_cs
// Window-related functions // Window-related functions
/// <summary>Initialize window and OpenGL context</summary> /// <summary>
/// Initialize window and OpenGL context
/// </summary>
[DllImport(nativeLibName, CallingConvention = CallingConvention.Cdecl)] [DllImport(nativeLibName, CallingConvention = CallingConvention.Cdecl)]
public static extern void InitWindow(int width, int height, [MarshalAs(UnmanagedType.LPUTF8Str)] string title); public static extern void InitWindow(int width, int height, [MarshalAs(UnmanagedType.LPUTF8Str)] string title);