Akov.NetDocsProcessor 1.0.7

dotnet add package Akov.NetDocsProcessor --version 1.0.7
NuGet\Install-Package Akov.NetDocsProcessor -Version 1.0.7
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="Akov.NetDocsProcessor" Version="1.0.7" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Akov.NetDocsProcessor --version 1.0.7
#r "nuget: Akov.NetDocsProcessor, 1.0.7"
#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 Akov.NetDocsProcessor as a Cake Addin
#addin nuget:?package=Akov.NetDocsProcessor&version=1.0.7

// Install Akov.NetDocsProcessor as a Cake Tool
#tool nuget:?package=Akov.NetDocsProcessor&version=1.0.7

NetDocsProcessor

alternate text is missing from this package README image alternate text is missing from this package README image

Change log

Unlike many libraries that produce output in predetermined HTML or Markdown formats, the NetDocsProcessor API provides a distinct approach for accessing data from an assembly and its associated XML file.

List<NamespaceDescription> data = new DocsProcessorApi().ObtainDocumentation(
        new AssemblyPaths("path_to_dll.dll", "path_to_xml.xml"),
        new GenerationSettings { AccessLevel = AccessLevel.Protected })
    .ToList();

The demo illustrates how to generate documentation files in Markdown format.

The list of supported xml tags

  • <example>
  • <exception>
  • <include>
  • <remarks>
  • <returns>
  • <param>
  • <summary>
  • <typeparam>

The tags <example>, <remarks> and <returns> support internal tags.

Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 is compatible.  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 is compatible.  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 is compatible.  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 netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.1 is compatible. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen 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.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
1.0.7 1,106 12/19/2023
1.0.6 1,105 4/12/2023
1.0.5 168 4/9/2023