EventSourceDocumentor.MSBuild by Manish Kumar

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

 EventSourceDocumentor.MSBuild 1.0.5

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

<package xmlns="http://schemas.microsoft.com/packaging/2011/08/nuspec.xsd">
  <metadata>
    <id>EventSourceDocumentor.MSBuild</id>
    <version>1.0.5</version>
    <title>ETW EventSource Events Document (csv) generator.</title>
    <authors>Manish Kumar</authors>
    <owners>Manish Kumar</owners>
    <licenseUrl>https://bitbucket.org/Manishkp/eventsourcedocumentor.msbuild/raw/34cdc69e567bae449e548a8a97b0653a2e8f6eb3/source/license.txt</licenseUrl>
    <projectUrl>https://bitbucket.org/Manishkp/eventsourcedocumentor.msbuild/</projectUrl>
    <requireLicenseAcceptance>true</requireLicenseAcceptance>
    <developmentDependency>true</developmentDependency>
    <description>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.
 /// &lt;summary&gt;
        /// The request processing error during processing.
        /// &lt;/summary&gt;
        /// &lt;param name="RequestID"&gt;
        /// The request id.
        /// &lt;/param&gt;
        /// &lt;param name="Url"&gt;
        /// The url.
        /// &lt;/param&gt;
        /// &lt;resolution&gt;Try fixing the configured url&lt;/resolution&gt;
 [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 &lt;EventSourceName&gt;.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</description>
    <summary>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>
    <releaseNotes>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 &lt;summary&gt; is not defined.
                 Show code warning if &lt;resolution&gt; is not defined for Error or Critical level events.  
          Note: only supports .Net4.5</releaseNotes>
    <tags>EventSource ETW</tags>
  </metadata>
</package>