docs: added generated output docs

Author: kieronlanning

README.md

@@ -2,14 +2,14 @@
 
 Generates [ActivitySource](https://learn.microsoft.com/en-us/dotnet/api/system.diagnostics.activitysource), [High-performance logging](https://learn.microsoft.com/en-us/dotnet/core/extensions/high-performance-logging) and [Metrics](https://learn.microsoft.com/en-us/dotnet/api/system.diagnostics.metrics) based on methods on an interface, enabling fast iteration cycles, dependency injection and substitutes for testing.
 
-The latest version is available on [NuGet](https://www.nuget.org/packages/Purview.Telemetry.SourceGenerator/), and supports generating for the following frameworks:
+The latest version is available on [NuGet](https://www.nuget.org/packages/Purview.Telemetry.SourceGenerator/), and supports generation for the following frameworks:
 
 * .NET Framework 4.7.2
 * .NET Framework 4.8
 * .NET 8
 * .NET 9
 
-Reference in your .props or csproj file:
+Reference in your `Directory.Build.props` or `.csproj` file:
 
 ```xml
 <PackageReference Include="Purview.Telemetry.SourceGenerator" Version="2.0.0">
@@ -18,6 +18,8 @@ Reference in your .props or csproj file:
 </PackageReference>
 ```
 
+Example of a multi-target telemetry interface:
+
 ```csharp
 using Purview.Telemetry.Activities;
 using Purview.Telemetry.Logging;
@@ -68,6 +70,8 @@ interface IEntityStoreTelemetry
 
 For more information see the [wiki](https://github.com/purview-dev/purview-telemetry-sourcegenerator/wiki).
 
+> To see the generated output for the above, sett the [`Generated Output`](https://github.com/purview-dev/purview-telemetry-sourcegenerator/wiki/Generated-Output) page in the wiki.
+
 Checkout the [.NET Aspire Sample](https://github.com/purview-dev/purview-telemetry-sourcegenerator/tree/main/samples/SampleApp) Project to see the Activities, Logging, and Metrics working with the Aspire Dashboard.
 
 > This sample project has `EmitCompilerGeneratedFiles` set to `true`, so you can easily see the generated output.

samples/SampleApp/SampleApp.Host/Services/IEntityStoreTelemetry.cs

@@ -0,0 +1,48 @@
+using System.Diagnostics;
+using Purview.Telemetry.Activities;
+using Purview.Telemetry.Logging;
+using Purview.Telemetry.Metrics;
+
+namespace SampleApp.Host.Services;
+
+[ActivitySource]
+[Logger]
+[Meter]
+interface IEntityStoreTelemetry
+{
+	/// <summary>
+	/// Creates and starts an Activity and adds the parameters as Tags and Baggage.
+	/// </summary>
+	[Activity]
+	Activity? GettingEntityFromStore(int entityId, [Baggage] string serviceUrl);
+
+	/// <summary>
+	/// Adds an ActivityEvent to the Activity with the parameters as Tags.
+	/// </summary>
+	[Event]
+	void GetDuration(Activity? activity, int durationInMS);
+
+	/// <summary>
+	/// Adds the parameters as Baggage to the Activity.
+	/// </summary>
+	[Context]
+	void RetrievedEntity(Activity? activity, float totalValue, int lastUpdatedByUserId);
+
+	/// <summary>
+	/// Generates a structured log message using an ILogger - defaults to Informational.
+	/// </summary>
+	[Log]
+	void ProcessingEntity(int entityId, string updateState);
+
+	/// <summary>
+	/// Generates a structured log message using an ILogger, specifically defined as Informational.
+	/// </summary>
+	[Info]
+	void ProcessingAnotherEntity(int entityId, string updateState);
+
+	/// <summary>
+	/// Adds 1 to a Counter{T} with the entityId as a Tag.
+	/// </summary>
+	[AutoCounter]
+	void RetrievingEntity(int entityId);
+}

src/Purview.Telemetry.SourceGenerator/Purview.Telemetry.SourceGenerator.csproj

@@ -14,6 +14,8 @@
 		<Title>Purview Telemetry Source Generator</Title>
 		<Description>.NET Source Generator for interface-based telemetry building activities, activity events, logs and metrics.</Description>
 		<PackageIcon>purview-logo.png</PackageIcon>
+		<DevelopmentDependency>true</DevelopmentDependency>
+		<SuppressDependenciesWhenPacking>true</SuppressDependenciesWhenPacking>
 
 		<CompilerGeneratedFilesOutputPath>Generated</CompilerGeneratedFilesOutputPath>
 		<IsRoslynComponent>true</IsRoslynComponent>