diff --git a/BizHawk.Emulation.Common/Base Implementations/BasicServiceProvider.cs b/BizHawk.Emulation.Common/Base Implementations/BasicServiceProvider.cs index 52df2946eb..1c2dcdb6ab 100644 --- a/BizHawk.Emulation.Common/Base Implementations/BasicServiceProvider.cs +++ b/BizHawk.Emulation.Common/Base Implementations/BasicServiceProvider.cs @@ -43,10 +43,9 @@ namespace BizHawk.Emulation.Common } } - /// - /// the core can call this to register an additional service - /// - /// The to register + /// the core can call this to register an additional service + /// The to register + /// is null public void Register(T provider) where T : IEmulatorService { diff --git a/BizHawk.Emulation.Common/Base Implementations/CallbackBasedTraceBuffer.cs b/BizHawk.Emulation.Common/Base Implementations/CallbackBasedTraceBuffer.cs index 8fd7086a88..e2bd12d69d 100644 --- a/BizHawk.Emulation.Common/Base Implementations/CallbackBasedTraceBuffer.cs +++ b/BizHawk.Emulation.Common/Base Implementations/CallbackBasedTraceBuffer.cs @@ -18,6 +18,7 @@ namespace BizHawk.Emulation.Common /// public abstract class CallbackBasedTraceBuffer : ITraceable { + /// does not provide memory callback support or does not implement protected CallbackBasedTraceBuffer(IDebuggable debuggableCore, IMemoryDomains memoryDomains, IDisassemblable disassembler) { if (!debuggableCore.MemoryCallbacksAvailable()) diff --git a/BizHawk.Emulation.Common/Base Implementations/CodeDataLog.cs b/BizHawk.Emulation.Common/Base Implementations/CodeDataLog.cs index b7051b3ab7..3634edc9fc 100644 --- a/BizHawk.Emulation.Common/Base Implementations/CodeDataLog.cs +++ b/BizHawk.Emulation.Common/Base Implementations/CodeDataLog.cs @@ -17,9 +17,8 @@ namespace BizHawk.Emulation.Common Active = true; } - /// - /// Pins the managed arrays. Not that we expect them to be allocated, but in case we do, seeing thish ere will remind us to check for the pin condition and abort - /// + /// Pins the managed arrays. Not that we expect them to be allocated, but in case we do, seeing this here will remind us to check for the pin condition and abort + /// if called more than once per instantiation public void Pin() { if (_pins.Count != 0) @@ -112,6 +111,10 @@ namespace BizHawk.Emulation.Common return true; } + /// + /// is not the same length as , or + /// any value differs in size from the corresponding value in + /// public void LogicalOrFrom(ICodeDataLog other) { if (Count != other.Count) @@ -187,6 +190,7 @@ namespace BizHawk.Emulation.Common return SaveInternal(new MemoryStream(), false); } + /// contents of do not begin with valid file header public void Load(Stream s) { var br = new BinaryReader(s); diff --git a/BizHawk.Emulation.Common/Base Implementations/ControllerDefinition.cs b/BizHawk.Emulation.Common/Base Implementations/ControllerDefinition.cs index d8c6aae7c8..fdda94a09b 100644 --- a/BizHawk.Emulation.Common/Base Implementations/ControllerDefinition.cs +++ b/BizHawk.Emulation.Common/Base Implementations/ControllerDefinition.cs @@ -122,7 +122,8 @@ namespace BizHawk.Emulation.Common Max = max; } - // for terse construction + /// for terse construction + /// length is not 3 public static implicit operator FloatRange(float[] f) { if (f.Length != 3) diff --git a/BizHawk.Emulation.Common/Base Implementations/MemoryCallbackSystem.cs b/BizHawk.Emulation.Common/Base Implementations/MemoryCallbackSystem.cs index 458cec1173..ad328f28ce 100644 --- a/BizHawk.Emulation.Common/Base Implementations/MemoryCallbackSystem.cs +++ b/BizHawk.Emulation.Common/Base Implementations/MemoryCallbackSystem.cs @@ -39,6 +39,7 @@ namespace BizHawk.Emulation.Common public string[] AvailableScopes { get; } + /// scope of isn't available public void Add(IMemoryCallback callback) { if (!AvailableScopes.Contains(callback.Scope)) diff --git a/BizHawk.Emulation.Common/Base Implementations/NullSound.cs b/BizHawk.Emulation.Common/Base Implementations/NullSound.cs index 1598dd5d1f..685f16358c 100644 --- a/BizHawk.Emulation.Common/Base Implementations/NullSound.cs +++ b/BizHawk.Emulation.Common/Base Implementations/NullSound.cs @@ -44,6 +44,7 @@ namespace BizHawk.Emulation.Common public SyncSoundMode SyncMode { get; private set; } + /// is not (call ) public void GetSamplesSync(out short[] samples, out int nsamp) { if (SyncMode != SyncSoundMode.Sync) @@ -72,6 +73,7 @@ namespace BizHawk.Emulation.Common SyncMode = mode; } + /// is not (call ) public void GetSamplesAsync(short[] samples) { if (SyncMode != SyncSoundMode.Async) diff --git a/BizHawk.Emulation.Common/Base Implementations/SimpleSyncSoundProvider.cs b/BizHawk.Emulation.Common/Base Implementations/SimpleSyncSoundProvider.cs index eab662fd25..9fa040d2b4 100644 --- a/BizHawk.Emulation.Common/Base Implementations/SimpleSyncSoundProvider.cs +++ b/BizHawk.Emulation.Common/Base Implementations/SimpleSyncSoundProvider.cs @@ -12,6 +12,7 @@ namespace BizHawk.Emulation.Common.Base_Implementations public bool CanProvideAsync => false; + /// is not public void SetSyncMode(SyncSoundMode mode) { if (mode != SyncSoundMode.Sync) @@ -48,6 +49,7 @@ namespace BizHawk.Emulation.Common.Base_Implementations _nsamp = 0; } + /// always public void GetSamplesAsync(short[] samples) { throw new NotImplementedException(); diff --git a/BizHawk.Emulation.Common/ControllerDefinitionMerger.cs b/BizHawk.Emulation.Common/ControllerDefinitionMerger.cs index 80fcaa295e..e46157b6af 100644 --- a/BizHawk.Emulation.Common/ControllerDefinitionMerger.cs +++ b/BizHawk.Emulation.Common/ControllerDefinitionMerger.cs @@ -76,6 +76,7 @@ namespace BizHawk.Emulation.Common _remaps = remaps; } + /// always public ControllerDefinition Definition => throw new NotImplementedException(); public bool IsPressed(string button) diff --git a/BizHawk.Emulation.Common/Interfaces/IMemoryCallbackSystem.cs b/BizHawk.Emulation.Common/Interfaces/IMemoryCallbackSystem.cs index dc891c4ae0..97fdf1c5ca 100644 --- a/BizHawk.Emulation.Common/Interfaces/IMemoryCallbackSystem.cs +++ b/BizHawk.Emulation.Common/Interfaces/IMemoryCallbackSystem.cs @@ -60,7 +60,7 @@ namespace BizHawk.Emulation.Common /// If no address is specified the callback will be hooked to all addresses /// Note: an execute callback can not be added without an address, else an InvalidOperationException will occur /// - /// Thrown when the property of the is not in the + /// Thrown when the property of the is not in the void Add(IMemoryCallback callback); /// diff --git a/BizHawk.Emulation.Common/Interfaces/Services/IDebuggable.cs b/BizHawk.Emulation.Common/Interfaces/Services/IDebuggable.cs index 748d93fe90..05d376b275 100644 --- a/BizHawk.Emulation.Common/Interfaces/Services/IDebuggable.cs +++ b/BizHawk.Emulation.Common/Interfaces/Services/IDebuggable.cs @@ -49,6 +49,7 @@ namespace BizHawk.Emulation.Common public ulong Value { get; } public byte BitSize { get; } + /// not in 1..64 public RegisterValue(ulong val, byte bitSize) { if (bitSize == 64) diff --git a/BizHawk.Emulation.Common/Interfaces/Services/IDisassemblable.cs b/BizHawk.Emulation.Common/Interfaces/Services/IDisassemblable.cs index 378b7090e2..d1e0aabde4 100644 --- a/BizHawk.Emulation.Common/Interfaces/Services/IDisassemblable.cs +++ b/BizHawk.Emulation.Common/Interfaces/Services/IDisassemblable.cs @@ -40,6 +40,7 @@ namespace BizHawk.Emulation.Common { private string _cpu; + /// (from setter) isn't the name of an available CPU public virtual string Cpu { get => _cpu; diff --git a/BizHawk.Emulation.Common/Interfaces/Services/ISettable.cs b/BizHawk.Emulation.Common/Interfaces/Services/ISettable.cs index ec92488bf1..661777b102 100644 --- a/BizHawk.Emulation.Common/Interfaces/Services/ISettable.cs +++ b/BizHawk.Emulation.Common/Interfaces/Services/ISettable.cs @@ -103,6 +103,7 @@ namespace BizHawk.Emulation.Common private readonly MethodInfo _getss; private readonly MethodInfo _putss; + /// does not have non-sync settings public object GetSettings() { if (!HasSettings) @@ -113,6 +114,7 @@ namespace BizHawk.Emulation.Common return _gets.Invoke(_emu, _tmp0); } + /// does not have sync settings public object GetSyncSettings() { if (!HasSyncSettings) @@ -123,6 +125,7 @@ namespace BizHawk.Emulation.Common return _getss.Invoke(_emu, _tmp0); } + /// does not have non-sync settings public bool PutSettings(object o) { if (!HasSettings) @@ -134,6 +137,7 @@ namespace BizHawk.Emulation.Common return (bool)_puts.Invoke(_emu, _tmp1); } + /// does not have sync settings public bool PutSyncSettings(object o) { if (!HasSyncSettings) diff --git a/BizHawk.Emulation.Common/Interfaces/Services/ISoundProvider.cs b/BizHawk.Emulation.Common/Interfaces/Services/ISoundProvider.cs index 88143e84b9..5a4ab1c08e 100644 --- a/BizHawk.Emulation.Common/Interfaces/Services/ISoundProvider.cs +++ b/BizHawk.Emulation.Common/Interfaces/Services/ISoundProvider.cs @@ -25,6 +25,7 @@ /// If a core can not provide async sound and the mode is set to sync, /// an NotSupportedException should be thrown /// + /// void SetSyncMode(SyncSoundMode mode); /// @@ -36,12 +37,14 @@ /// Provides samples in sync mode /// If the core is not in sync mode, this should throw an InvalidOperationException /// + /// void GetSamplesSync(out short[] samples, out int nsamp); /// /// Provides samples in async mode /// If the core is not in async mode, this should throw an InvalidOperationException /// + /// void GetSamplesAsync(short[] samples); /// diff --git a/BizHawk.Emulation.Common/SaveController.cs b/BizHawk.Emulation.Common/SaveController.cs index 8db556f656..d3de8be678 100644 --- a/BizHawk.Emulation.Common/SaveController.cs +++ b/BizHawk.Emulation.Common/SaveController.cs @@ -54,9 +54,8 @@ namespace BizHawk.Emulation.Common } } - /// - /// This controller's definition changes to that of source - /// + /// replace this controller's definition with that of + /// definition of has a button and an analog control with the same name public void CopyFrom(IController source) { Definition = source.Definition; diff --git a/BizHawk.Emulation.Common/Sound/Utilities/BlipBuffer.cs b/BizHawk.Emulation.Common/Sound/Utilities/BlipBuffer.cs index 42d57dbef6..84aed3d122 100644 --- a/BizHawk.Emulation.Common/Sound/Utilities/BlipBuffer.cs +++ b/BizHawk.Emulation.Common/Sound/Utilities/BlipBuffer.cs @@ -77,6 +77,7 @@ namespace BizHawk.Emulation.Common private IntPtr _context; + /// unmanaged call failed public BlipBuffer(int sampleCount) { _context = BlipBufDll.blip_new(sampleCount); @@ -140,6 +141,7 @@ namespace BizHawk.Emulation.Common return BlipBufDll.blip_samples_avail(_context); } + /// can't hold samples (or twice that if is ) public int ReadSamples(short[] output, int count, bool stereo) { if (output.Length < count * (stereo ? 2 : 1)) @@ -150,6 +152,7 @@ namespace BizHawk.Emulation.Common return BlipBufDll.blip_read_samples(_context, output, count, stereo ? 1 : 0); } + /// can't hold 2 * samples public int ReadSamplesLeft(short[] output, int count) { if (output.Length < count * 2) @@ -160,6 +163,7 @@ namespace BizHawk.Emulation.Common return BlipBufDll.blip_read_samples(_context, output, count, 1); } + /// can't hold 2 * samples public int ReadSamplesRight(short[] output, int count) { if (output.Length < count * 2) diff --git a/BizHawk.Emulation.Common/Sound/Utilities/DCFilter.cs b/BizHawk.Emulation.Common/Sound/Utilities/DCFilter.cs index 0fb52e423a..0e292fdfa8 100644 --- a/BizHawk.Emulation.Common/Sound/Utilities/DCFilter.cs +++ b/BizHawk.Emulation.Common/Sound/Utilities/DCFilter.cs @@ -27,6 +27,8 @@ namespace BizHawk.Emulation.Common return ret; } + /// is null + /// is not in 8..65536 public DCFilter(ISoundProvider input, int filterWidth) { if (input == null) @@ -44,7 +46,8 @@ namespace BizHawk.Emulation.Common _soundProvider = input; } - // Detached mode + /// detached mode + /// is not in 8..65536 public DCFilter(int filterWidth) { if (filterWidth < 8 || filterWidth > 65536) diff --git a/BizHawk.Emulation.Common/Sound/Utilities/Metaspu.cs b/BizHawk.Emulation.Common/Sound/Utilities/Metaspu.cs index a4b4de202f..1cf62afeda 100644 --- a/BizHawk.Emulation.Common/Sound/Utilities/Metaspu.cs +++ b/BizHawk.Emulation.Common/Sound/Utilities/Metaspu.cs @@ -54,6 +54,7 @@ namespace BizHawk.Emulation.Common public SyncSoundMode SyncMode => SyncSoundMode.Async; + /// is not public void SetSyncMode(SyncSoundMode mode) { if (mode != SyncSoundMode.Async) @@ -62,6 +63,7 @@ namespace BizHawk.Emulation.Common } } + /// always public void GetSamplesSync(out short[] samples, out int nsamp) { throw new InvalidOperationException("Sync mode not supported"); diff --git a/BizHawk.Emulation.Common/Sound/Utilities/SpeexResampler.cs b/BizHawk.Emulation.Common/Sound/Utilities/SpeexResampler.cs index ff25d2276c..4754b555e5 100644 --- a/BizHawk.Emulation.Common/Sound/Utilities/SpeexResampler.cs +++ b/BizHawk.Emulation.Common/Sound/Utilities/SpeexResampler.cs @@ -288,9 +288,6 @@ namespace BizHawk.Emulation.Common } } - /// - /// Initializes a new instance of the class - /// /// 0 to 10 /// numerator of sample rate change ratio (inrate / outrate) /// denominator of sample rate change ratio (inrate / outrate) @@ -298,6 +295,8 @@ namespace BizHawk.Emulation.Common /// sampling rate out, rounded to nearest hz /// function which accepts output as produced. if null, act as an /// source to take input from when output is requested. if null, no auto-fetching + /// and are both non-null + /// unmanaged call failed public SpeexResampler(Quality quality, uint rationum, uint ratioden, uint sratein, uint srateout, Action drainer = null, ISoundProvider input = null) { if (drainer != null && input != null) @@ -369,9 +368,8 @@ namespace BizHawk.Emulation.Common } } - /// - /// flush as many input samples as possible, generating output samples right now - /// + /// flush as many input samples as possible, generating output samples right now + /// unmanaged call failed public void Flush() { uint inal = (uint)_inbufpos / 2; @@ -448,11 +446,13 @@ namespace BizHawk.Emulation.Common public SyncSoundMode SyncMode => SyncSoundMode.Sync; + /// always public void GetSamplesAsync(short[] samples) { throw new InvalidOperationException("Async mode is not supported."); } + /// is public void SetSyncMode(SyncSoundMode mode) { if (mode == SyncSoundMode.Async) diff --git a/BizHawk.Emulation.Common/TextState.cs b/BizHawk.Emulation.Common/TextState.cs index 0b6b1b7c6b..7fb548620b 100644 --- a/BizHawk.Emulation.Common/TextState.cs +++ b/BizHawk.Emulation.Common/TextState.cs @@ -55,6 +55,7 @@ namespace BizHawk.Emulation.Common Current.Data.Add(name, d); // will except for us if the key is already present } + /// does not match the length of the data saved as public void Load(IntPtr data, int length, string name) { byte[] d = Current.Data[name]; @@ -93,6 +94,7 @@ namespace BizHawk.Emulation.Common Nodes.Push(next); } + /// doesn't match the section being closed public void ExitSection(string name) { Node last = Nodes.Pop();