Cecil.XmlDocNames 1.3.0

.NET Standard 2.0

dotnet add package Cecil.XmlDocNames --version 1.3.0

NuGet\Install-Package Cecil.XmlDocNames -Version 1.3.0

This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.

<PackageReference Include="Cecil.XmlDocNames" Version="1.3.0" />

For projects that support PackageReference, copy this XML node into the project file to reference the package.

paket add Cecil.XmlDocNames --version 1.3.0

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

#r "nuget: Cecil.XmlDocNames, 1.3.0"

#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.

// Install Cecil.XmlDocNames as a Cake Addin
#addin nuget:?package=Cecil.XmlDocNames&version=1.3.0

// Install Cecil.XmlDocNames as a Cake Tool
#tool nuget:?package=Cecil.XmlDocNames&version=1.3.0

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

Cecil.XmlDocNames

GitHub downloads

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: star it. Thank you!

Quick start

It's easy as 1 - 2 - 3:

Reference the NuGet package.
using Cecil.XmlDocNames;
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.

Product	Compatible and additional computed target framework versions.
.NET	net5.0 was computed. net5.0-windows was computed. net6.0 was computed. net6.0-android was computed. net6.0-ios was computed. net6.0-maccatalyst was computed. net6.0-macos was computed. net6.0-tvos was computed. net6.0-windows was computed. net7.0 was computed. net7.0-android was computed. net7.0-ios was computed. net7.0-maccatalyst was computed. net7.0-macos was computed. net7.0-tvos was computed. net7.0-windows was computed. net8.0 was computed. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed.
.NET Core	netcoreapp2.0 was computed. netcoreapp2.1 was computed. netcoreapp2.2 was computed. netcoreapp3.0 was computed. netcoreapp3.1 was computed.
.NET Standard	netstandard2.0 is compatible. netstandard2.1 was computed.
.NET Framework	net461 was computed. net462 was computed. net463 was computed. net47 was computed. net471 was computed. net472 was computed. net48 was computed. net481 was computed.
MonoAndroid	monoandroid was computed.
MonoMac	monomac was computed.
MonoTouch	monotouch was computed.
Tizen	tizen40 was computed. tizen60 was computed.
Xamarin.iOS	xamarinios was computed.
Xamarin.Mac	xamarinmac was computed.
Xamarin.TVOS	xamarintvos was computed.
Xamarin.WatchOS	xamarinwatchos was computed.