ToxicMushroom/Dalamud
1
0
Fork 0
mirror of https://github.com/goatcorp/Dalamud.git synced 2026-01-02 13:53:40 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

docs fixed

Browse source
This commit is contained in:
goat 2023-09-23 10:39:29 +02:00
parent eb2a5f36f9
commit 1304c54eff
No known key found for this signature in database
GPG key ID: 49E2AA8C6A76498B
2 changed files with 5 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

4
Dalamud/Plugin/Services/IGameInteropProvider.cs
View file

@ -34,13 +34,15 @@ public interface IGameInteropProvider
/// <summary> /// <summary>
/// Initialize <see cref="Hook{T}"/> members decorated with the <see cref="SignatureAttribute"/>. /// Initialize <see cref="Hook{T}"/> members decorated with the <see cref="SignatureAttribute"/>.
/// Initialize any delegate members decorated with the <see cref="SignatureAttribute"/>.
/// Fill out any IntPtr members decorated with the <see cref="SignatureAttribute"/> with the resolved address.
/// Errors for fallible signatures will be logged. /// Errors for fallible signatures will be logged.
/// </summary> /// </summary>
/// <param name="self">The object to initialize.</param> /// <param name="self">The object to initialize.</param>
public void InitializeFromAttributes(object self); public void InitializeFromAttributes(object self);
/// <summary> /// <summary>
/// Creates a hook by rewriting import table address. /// Creates a hook by replacing the original address with an address pointing to a newly created jump to the detour.
/// </summary> /// </summary>
/// <param name="address">A memory address to install a hook.</param> /// <param name="address">A memory address to install a hook.</param>
/// <param name="detour">Callback function. Delegate must have a same original function prototype.</param> /// <param name="detour">Callback function. Delegate must have a same original function prototype.</param>

4
Dalamud/Utility/Signatures/SignatureHelper.cs
View file

@ -21,10 +21,10 @@ internal static class SignatureHelper
private const BindingFlags Flags = BindingFlags.Instance | BindingFlags.Static | BindingFlags.Public | BindingFlags.NonPublic; private const BindingFlags Flags = BindingFlags.Instance | BindingFlags.Static | BindingFlags.Public | BindingFlags.NonPublic;
/// <summary> /// <summary>
/// Initialises an object's fields and properties that are annotated with a /// Initializes an object's fields and properties that are annotated with a
/// <see cref="SignatureAttribute"/>. /// <see cref="SignatureAttribute"/>.
/// </summary> /// </summary>
/// <param name="self">The object to initialise.</param> /// <param name="self">The object to initialize.</param>
/// <param name="log">If warnings should be logged using <see cref="PluginLog"/>.</param> /// <param name="log">If warnings should be logged using <see cref="PluginLog"/>.</param>
/// <returns>Collection of created IDalamudHooks.</returns> /// <returns>Collection of created IDalamudHooks.</returns>
internal static IEnumerable<IDalamudHook> Initialize(object self, bool log = true) internal static IEnumerable<IDalamudHook> Initialize(object self, bool log = true)