liberodark/ryujinx
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

doc: update documentation for Shared property in Switch class (ryubing/ryujinx!137)

Browse source 
See merge request ryubing/ryujinx!137
This commit is contained in:
VewDev 2025-09-03 03:25:43 -05:00 • committed by GreemDev
parent 3309fb2351
commit 959af3613d
1 changed files with 12 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

12
src/Ryujinx.HLE/Switch.cs
View file

@ -20,6 +20,18 @@ namespace Ryujinx.HLE
{ {
public class Switch : IDisposable public class Switch : IDisposable
{ {
/// <summary>
/// Currently running emulated Switch, if there is one.
/// <para>
/// Proper usage of this property null checks it before use, unless the caller is certain that the emulation is running.
/// </para>
/// <para>
/// In case the emulation is running, there might be a way to directly pass the <see cref="Switch" /> instance, which is preferred.
/// </para>
/// <para>
/// The instance is set to <c>this</c> on any <see cref="Switch" /> instantiation, and set to <c>null</c> on any <see cref="Switch" /> disposal.
/// </para>
/// </summary>
public static Switch Shared { get; private set; } public static Switch Shared { get; private set; }
public HleConfiguration Configuration { get; } public HleConfiguration Configuration { get; }