XmlDocExtractionLib 1.0.0
There is a newer version of this package available.
See the version list below for details.
See the version list below for details.
dotnet add package XmlDocExtractionLib --version 1.0.0
NuGet\Install-Package XmlDocExtractionLib -Version 1.0.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="XmlDocExtractionLib" Version="1.0.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="XmlDocExtractionLib" Version="1.0.0" />
<PackageReference Include="XmlDocExtractionLib" />
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.
paket add XmlDocExtractionLib --version 1.0.0
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: XmlDocExtractionLib, 1.0.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.
#:package XmlDocExtractionLib@1.0.0
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.
#addin nuget:?package=XmlDocExtractionLib&version=1.0.0
#tool nuget:?package=XmlDocExtractionLib&version=1.0.0
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
About
XmlDocExtractionLib is an easy to use library designed to extract xml documentation from types and members from a documentation xml file that is generated by the compiler.
Key Features
- Support extracting documentation from members with the new modifier.
- Support extracting documentation from enum values.
- Support extracting documentation from explicit interface implementation members.
- Allow resolving inherit documentation from multiple assemblies.
- Expose some of the useful inner functionality like:
- Extensions methods for getting the identifiers of members.
- Extension methods for getting members base definitions.
- The resolver that resolve inherit documentation.
How to Use
// Add this using in order to be able to use the extension methods.
using XmlDocExtractionLib;
// Create an instance of the XmlExtractionContext class.
var xmlExtractionContext = new XmlExtractionContext();
// Add all the assemblies and their corresponding xml files to the context.
xmlExtractionContext.AddAssembly(assembly, assemblyXmlDocumentationFilePath);
// Get the member whose documentation you are after.
var member = typeof(ComplexClass);
// Get the documentation.
member.GetXmlDocumentation(xmlExtractionContext, resolveInheritdoc: true);
/*
* For getting the documentation of an enum value you need to have the type of the enum
* and the value of the enum.
*/
var enumType = typeof(Color);
enumType.GetEnumValueXmlDocumentation((int)Color.Red, xmlExtractionContext, resolveInheritdoc: true);
| Product | Versions 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. net9.0 was computed. net9.0-android was computed. net9.0-browser was computed. net9.0-ios was computed. net9.0-maccatalyst was computed. net9.0-macos was computed. net9.0-tvos was computed. net9.0-windows was computed. net10.0 was computed. net10.0-android was computed. net10.0-browser was computed. net10.0-ios was computed. net10.0-maccatalyst was computed. net10.0-macos was computed. net10.0-tvos was computed. net10.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. |
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.
-
.NETStandard 2.0
- No dependencies.
NuGet packages (1)
Showing the top 1 NuGet packages that depend on XmlDocExtractionLib:
| Package | Downloads |
|---|---|
|
ProtoGenerationLib
A package for generating proto files from C# DTOs. |
GitHub repositories
This package is not used by any popular GitHub repositories.
Core library functionality