rdeago / cecil.xmldocnames

A small utility library that generates XMLDoc-style names for Mono.Cecil objects.

Cecil.XmlDocNames

Cecil.XmlDocNames translates Mono.Cecil member references to XmlDoc-style ID strings.

It's a small, MIT-licensed, .NET Standard 2.0 library. Its only dependency is Mono.Cecil.

Why this library

With Cecil.XmlDocNames you can process assemblies and related XML documentation files at the same time.

Or you can automatically augment XML documentation, based on code analysis attributes extracted from compiled assemblies.

Or you can generate external annotation files for ReSharper, based on the contents of compiled assemblies... although you don't really have to bother, because that's exactly what our ReSharper.ExportAnnotations library does (using Cecil.XmlDocNames, of course.)

If you find this library useful, please ⭐ star it. Thank you!

Quick start

It's easy as 1 - 2 - 3:

1. Reference the NuGet package.
2. using Cecil.XmlDocNames;
3. string name = myMemberReference.GetXmlDocName(); where myMemberReference can be an instance of one of the following classes:
   • Mono.Cecil.TypeReference;
   • Mono.Cecil.MethodReference;
   • Mono.Cecil.PropertyReference;
   • Mono.Cecil.FieldReference;
   • Mono.Cecil.EventReference.

Credits

The logo for this library is a modified version of Documentation by IYIKON, from the Noun Project.

The font used in the logo is BloggerSans.otf by Sergiy S. Tkachenko, from Font Library.

---

Disclaimer: The author of this library is in no way affiliated to JetBrains s.r.o. (the makers of ReSharper) other than being a satisfied cutomer.