Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix references in documentation using <see> tags #61

Open
mcpiroman opened this issue Jan 25, 2020 · 3 comments
Open

Fix references in documentation using <see> tags #61

mcpiroman opened this issue Jan 25, 2020 · 3 comments

Comments

@mcpiroman
Copy link

While reading the code to understand how to use this (or related) library, I found following comment in MonoMod.RuntimeDetour/NativeDetour.cs:

/// If you don't need the trampoline generator or any of the management helpers, use DetourManager.Native directly.

I didn't find the DetourManager and I think this was meant to be DetourHelper. If so, correcting this would make everything more understandable.

@mcpiroman mcpiroman added the bug label Jan 25, 2020
@mcpiroman
Copy link
Author

Also, I'm uncertain about some line above in this comment:

/// 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.

@0x0ade
Copy link
Member

0x0ade commented Jan 25, 2020

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.

@0x0ade
Copy link
Member

0x0ade commented Jan 26, 2020

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 0x0ade added enhancement and removed bug labels Jan 26, 2020
@0x0ade 0x0ade changed the title Codebase: Possibly invalid reference to DetourManager in comment Fix references in documentation using <see> tags Jan 26, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants