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

Documentation: Indicate which types are from out of AsmResolver namespace #372

Open
th3spis opened this issue Oct 27, 2022 · 1 comment
Open
Labels
docs Issues related to the documentation of AsmResolver enhancement

Comments

@th3spis
Copy link

th3spis commented Oct 27, 2022

Description

Thank you for your incredible work.

While learning how to use it, and considering that Im a newby reversing advanced .NET assemblys, I got a little confused with the documentation. So it would be nice to indicate when you're referencing a type or an element from other namespace/library. For example, in the entry for dynamic-methods I think the DynamicMethod dynamicMethod = ... refers to the type/class from Assembly.Reflection. Please correct me if I'm wrong.

While it might seem obvious and immediate for experienced people, it can be confusing for learners trying to code a solution using this library and looking at the docs. I dont think this is the case, but for example using dnlib there was even some overlaping with names and visual studio required to specify.

By specifying this, it would be more clear from the beginning if (and when) we need to Load an assembly using Reflection or AsmResolver and where to use each.

@Washi1337 Washi1337 added enhancement docs Issues related to the documentation of AsmResolver labels Oct 29, 2022
@Washi1337
Copy link
Owner

I agree, some of the documentation can indeed use some work in clarity.

For what it is worth though, none of the examples in the documentation except for one section in the reference importing chapter require loading an assembly via System.Reflection. Dynamic methods can be created without it, and AsmResolver itself does not rely on reflection apart from a very few select use cases.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Issues related to the documentation of AsmResolver enhancement
Projects
None yet
Development

No branches or pull requests

2 participants