EventSourceDocumentor.MSBuild 1.0.5

dotnet add package EventSourceDocumentor.MSBuild --version 1.0.5

NuGet\Install-Package EventSourceDocumentor.MSBuild -Version 1.0.5

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="EventSourceDocumentor.MSBuild" Version="1.0.5">
  <PrivateAssets>all</PrivateAssets>
  <IncludeAssets>runtime; build; native; contentfiles; analyzers</IncludeAssets>
</PackageReference>

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

<PackageVersion Include="EventSourceDocumentor.MSBuild" Version="1.0.5" />
                    

                            Directory.Packages.props

<PackageReference Include="EventSourceDocumentor.MSBuild">
  <PrivateAssets>all</PrivateAssets>
  <IncludeAssets>runtime; build; native; contentfiles; analyzers</IncludeAssets>
</PackageReference>
                    

                            Project file

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 EventSourceDocumentor.MSBuild --version 1.0.5

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

#r "nuget: EventSourceDocumentor.MSBuild, 1.0.5"

#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 EventSourceDocumentor.MSBuild@1.0.5

#: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=EventSourceDocumentor.MSBuild&version=1.0.5
                    

                            Install as a Cake Addin

#tool nuget:?package=EventSourceDocumentor.MSBuild&version=1.0.5
                    

                            Install as a Cake Tool

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

This MSBuild task generates documentation for Events in a ETW EventSource class. This can combine event method comments like summary and resolution to helps Operations take action on the events.
/// <summary>
       /// The request processing error during processing.
       /// </summary>
       /// <param name="RequestID">
       /// The request id.
       /// </param>
       /// <param name="Url">
       /// The url.
       /// </param>
       /// <resolution>Try fixing the configured url</resolution>
[Event(5, Keywords = Keywords.Requests,
      Task = Tasks.Request, Opcode = EventOpcode.Suspend, Level = EventLevel.Error)]
       public void RequestProcessingError(int RequestID, string Url)
       { WriteEvent(5, RequestID, Url); }

generates csv file named <EventSourceName>.csv
with record

EventName,EventId, EventLevel, Description, Resolution

RequestProcessingError,5, Error, The request processing error during processing., Try fixing the configured url

Note: only supports .Net4.5

There are no supported framework assets in this package.

Learn more about Target Frameworks and .NET Standard.

This package has no dependencies.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version	Downloads	Last Updated
1.0.5	635	11/13/2014
1.0.4	729	11/10/2014
1.0.3	722	11/10/2014
1.0.2	392	11/10/2014
1.0.1	403	11/10/2014
1.0.0	403	11/10/2014

1.0.0: First version of EventSource Event doc generator, handles cases where CustomEventSource is directly derived from EventSource class, rather than Interface deriving from EventSource.
         1.0.1: Fixing Output csv file to be placed at OutDir.
         1.0.2: CSV name would match style of .Man files ie AssemblyName.EventSourceName.csv
         1.0.3: Preserving line breaks from comments into the csv columns
         1.0.4: Re-ordering the columns in csv output
         1.0.5: Show code warnings if <summary> is not defined.
                Show code warning if <resolution> is not defined for Error or Critical level events.
         Note: only supports .Net4.5