Document `IMemoryDomains` invariants

This commit is contained in:
YoshiRulz 2023-01-25 02:04:10 +10:00
parent 9e8b0c604d
commit c66d0c746e
No known key found for this signature in database
GPG Key ID: C4DE31C245353FB7
1 changed files with 6 additions and 0 deletions

View File

@ -17,10 +17,16 @@ namespace BizHawk.Emulation.Common
{
MemoryDomain? this[string name] { get; }
/// <remarks>implementation note: must also be in the collection</remarks>
MemoryDomain MainMemory { get; }
bool HasSystemBus { get; }
/// <remarks>
/// if <see cref="HasSystemBus"/> is <see langword="false"/>, the getter behaviour is undefined
/// (it may return <see cref="MainMemory"/> or another domain)<br/>
/// implementation note: must also be in the collection
/// </remarks>
MemoryDomain SystemBus { get; }
bool Has(string name);