You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
/// A "raw" native detour, acting as a wrapper around NativeDetourData with a few helpers.
I feel like NativeDetourData was also meant to be DetourHelper.
As a suggestion, you may want to use VS's xml comment syntax <see> e.g. <see cref="MonoMod.RuntimeDetour.DetourHelper"/>. The advantage is that a) it allows for faster navigation (you may just press F12) and b) it is updated when you rename the class/method/whatever, e.g. via F2.
TIL about see, thanks for telling me about this! I'll implement those changes shortly.
The documentation is very unfinished and heavily work in progress in the current state anyway, I just don't have the time to properly maintain it at this moment.
DetourManager.Native is supposed to refer to DetourHelper.Native. NativeDetourData is meant to refer to NativeDetourData, but can refer to both NativeDetourData and DetourHelper.
I'll remark this from a "bug" to an "enhancement", and will update the title to refer to the ongoing documentation process. Please let me know if you want me to undo the changes.
0x0ade
changed the title
Codebase: Possibly invalid reference to DetourManager in comment
Fix references in documentation using <see> tags
Jan 26, 2020
While reading the code to understand how to use this (or related) library, I found following comment in
MonoMod.RuntimeDetour/NativeDetour.cs
:MonoMod/MonoMod.RuntimeDetour/NativeDetour.cs
Line 18 in 86f3be6
I didn't find the
DetourManager
and I think this was meant to beDetourHelper
. If so, correcting this would make everything more understandable.The text was updated successfully, but these errors were encountered: