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

MRefBuilderAddIn #951

Open
uecasm opened this issue Nov 2, 2022 · 2 comments
Open

MRefBuilderAddIn #951

uecasm opened this issue Nov 2, 2022 · 2 comments

Comments

@uecasm
Copy link

uecasm commented Nov 2, 2022

It would be nice if some documentation were added and/or the process of using them made simpler for custom MRefBuilderAddIns, especially since there now seems to be two different versions of it (for Framework vs Core).

FWIW, I use one to extract some info from custom attributes, which are later used by a syntax generator.

I did manage to get mine working under the new system, using a somewhat similar approach as for configuration UIs -- the addin itself is a plain non-nuget dual-build project and then I have a plugin nuget which embeds the files and configures them to execute. I could provide more details and snippets if that would be helpful, though not the complete source. (And I haven't tested it for Core builds, though it theoretically should work.)

@EWSoftware
Copy link
Owner

Up to now, I wasn't aware of anyone creating MRefBuilder add-ins so I haven't done anything with them as there didn't seem to be much point in expending a lot of effort to rework the code to create a NuGet package and use MEF to make them like the other components and plug-ins.

If you could provide the details and examples to show what you're after, I'll see what I can do towards simplifying usage or at least documenting how they are implemented and used.

@uecasm
Copy link
Author

uecasm commented Nov 5, 2022

Most of what I was doing probably could be sufficiently done by adding attributes to the MRefBuilder local config's filter list via plugin (I have to mess with that config to add the extra plugin anyway) -- it's mostly about detecting that certain attributes are present on the class or methods and interpreting their content accordingly. Although my builder plugin tacks on some additional XML elements with just the interesting bits of data from the attributes rather than the full spiel. (I'm not sure if that attribute filter wasn't there in the older version or if I just didn't notice it before doing my own extraction.)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants