Fixed malformed description warnings

Author: Arlodotexe

CommunityToolkit.Tooling.SampleGen/Diagnostics/DiagnosticDescriptors.cs

@@ -19,27 +19,27 @@ public static class DiagnosticDescriptors
     /// </summary>
     public static readonly DiagnosticDescriptor SamplePaneOptionAttributeOnNonSample = new(
         id: "TKSMPL0001",
-        title: $"Invalid sample option declaration",
-        messageFormat: $"Cannot generate sample pane options for type {{0}} as it does not use {nameof(Attributes.ToolkitSampleAttribute)}",
+        title: "Invalid sample option declaration",
+        messageFormat: "Cannot generate sample pane options for type {{0}} as it does not use ToolkitSampleAttribute",
         category: typeof(ToolkitSampleMetadataGenerator).FullName,
         defaultSeverity: DiagnosticSeverity.Error,
         isEnabledByDefault: true,
-        description: $"Cannot generate sample pane options for a type which does not use {nameof(Attributes.ToolkitSampleAttribute)}.");
+        description: "Cannot generate sample pane options for a type which does not use ToolkitSampleAttribute.");
 
     /// <summary>
     /// Gets a <see cref="DiagnosticDescriptor"/> indicating a derived <see cref="Attributes.ToolkitSampleOptionBaseAttribute"/> with an empty or invalid name.
     /// <para>
-    /// Format: <c>"Cannot generate sample pane options for type {0} as it contains an empty or invalid name."</c>.
+    /// Format: <c>"Cannot generate sample pane options for type {0} as it contains an empty or invalid name"</c>.
     /// </para>
     /// </summary>
     public static readonly DiagnosticDescriptor SamplePaneOptionWithBadName = new(
         id: "TKSMPL0002",
-        title: $"Invalid sample option declaration",
-        messageFormat: $"Cannot generate sample pane options for type {{0}} as the provided name is empty or invalid",
+        title: "Invalid sample option declaration",
+        messageFormat: "Cannot generate sample pane options for type {{0}} as the provided name is empty or invalid",
         category: typeof(ToolkitSampleMetadataGenerator).FullName,
         defaultSeverity: DiagnosticSeverity.Error,
         isEnabledByDefault: true,
-        description: $"Cannot generate sample pane options when the provided name is empty or invalid.");
+        description: "Cannot generate sample pane options when the provided name is empty or invalid.");
 
     /// <summary>
     /// Gets a <see cref="DiagnosticDescriptor"/> indicating a <see cref="Attributes.ToolkitSampleOptionsPaneAttribute"/> with a <see cref="Attributes.ToolkitSampleOptionsPaneAttribute.SampleId"/> that doesn't have a corresponding <see cref="Attributes.ToolkitSampleAttribute.Id"/>.
@@ -49,12 +49,12 @@ public static class DiagnosticDescriptors
     /// </summary>
     public static readonly DiagnosticDescriptor OptionsPaneAttributeWithMissingOrInvalidSampleId = new(
         id: "TKSMPL0003",
-        title: $"Missing or invalid sample Id",
-        messageFormat: $"Cannot link sample options pane to type {{0}} as the provided sample ID does not match any known {nameof(Attributes.ToolkitSampleAttribute)}",
+        title: "Missing or invalid sample Id",
+        messageFormat: "Cannot link sample options pane to type {{0}} as the provided sample ID does not match any known ToolkitSampleAttribute",
         category: typeof(ToolkitSampleMetadataGenerator).FullName,
         defaultSeverity: DiagnosticSeverity.Error,
         isEnabledByDefault: true,
-        description: $"Cannot link sample options pane to a provided sample ID that does not match any known {nameof(Attributes.ToolkitSampleAttribute)}.");
+        description: "Cannot link sample options pane to a provided sample ID that does not match any known ToolkitSampleAttribute.");
 
     /// <summary>
     /// Gets a <see cref="DiagnosticDescriptor"/> indicating a derived <see cref="Attributes.ToolkitSampleOptionBaseAttribute"/> that contains a name which is already in use by another sample option.
@@ -64,12 +64,12 @@ public static class DiagnosticDescriptors
     /// </summary>
     public static readonly DiagnosticDescriptor SamplePaneOptionWithDuplicateName = new(
         id: "TKSMPL0004",
-        title: $"Duplicate sample option name",
-        messageFormat: $"Cannot generate sample pane option with name {{0}} as the provided name is already in use by another sample option",
+        title: "Duplicate sample option name",
+        messageFormat: "Cannot generate sample pane option with name {{0}} as the provided name is already in use by another sample option",
         category: typeof(ToolkitSampleMetadataGenerator).FullName,
         defaultSeverity: DiagnosticSeverity.Error,
         isEnabledByDefault: true,
-        description: $"Cannot generate sample pane option when the provided name is used by another sample option.");
+        description: "Cannot generate sample pane option when the provided name is used by another sample option.");
 
     /// <summary>
     /// Gets a <see cref="DiagnosticDescriptor"/> indicating a derived <see cref="Attributes.ToolkitSampleOptionBaseAttribute"/> that contains a name which is already defined as a member in the attached class.
@@ -79,12 +79,12 @@ public static class DiagnosticDescriptors
     /// </summary>
     public static readonly DiagnosticDescriptor SamplePaneOptionWithConflictingName = new(
         id: "TKSMPL0005",
-        title: $"Conflicting sample option name",
-        messageFormat: $"Cannot generate sample pane option with name {{0}} as the provided name is already defined as a member in the attached class",
+        title: "Conflicting sample option name",
+        messageFormat: "Cannot generate sample pane option with name {{0}} as the provided name is already defined as a member in the attached class",
         category: typeof(ToolkitSampleMetadataGenerator).FullName,
         defaultSeverity: DiagnosticSeverity.Error,
         isEnabledByDefault: true,
-        description: $"Cannot generate sample pane option when the provided name is already defined as a member in the attached class.");
+        description:"Cannot generate sample pane option when the provided name is already defined as a member in the attached class.");
 
     /// <summary>
     /// Gets a <see cref="DiagnosticDescriptor"/> indicating a <see cref="Attributes.ToolkitSampleMultiChoiceOptionAttribute"/> that has no defined options to present to the user.
@@ -94,117 +94,117 @@ public static class DiagnosticDescriptors
     /// </summary>
     public static readonly DiagnosticDescriptor SamplePaneMultiChoiceOptionWithNoChoices = new(
         id: "TKSMPL0006",
-        title: $"Missing choices in multi-choice sample option",
-        messageFormat: $"Cannot generate multiple choice sample pane option with title {{0}} as no choices were provided.",
+        title: "Missing choices in multi-choice sample option",
+        messageFormat: "Cannot generate multiple choice sample pane option with title {{0}} as no choices were provided",
         category: typeof(ToolkitSampleMetadataGenerator).FullName,
         defaultSeverity: DiagnosticSeverity.Error,
         isEnabledByDefault: true,
-        description: $"Cannot generate multiple choice sample pane option as there are no choices provided.");
+        description: "Cannot generate multiple choice sample pane option as there are no choices provided.");
 
     /// <summary>
     /// Gets a <see cref="DiagnosticDescriptor"/> indicating a <see cref="Attributes.ToolkitSampleAttribute"/> that was used on an unsupported type.
     /// <para>
-    /// Format: <c>"Cannot generate sample metadata as the attribute was used on an unsupported type."</c>.
+    /// Format: <c>"Cannot generate sample metadata as the attribute was used on an unsupported type"</c>.
     /// </para>
     /// </summary>
     public static readonly DiagnosticDescriptor SampleAttributeOnUnsupportedType = new(
         id: "TKSMPL0007",
-        title: $"ToolkitSampleAttribute declared on an invalid type",
-        messageFormat: $"Cannot generate sample metadata as the attribute was used on an unsupported type",
+        title: "ToolkitSampleAttribute declared on an invalid type",
+        messageFormat: "Cannot generate sample metadata as the attribute was used on an unsupported type",
         category: typeof(ToolkitSampleMetadataGenerator).FullName,
         defaultSeverity: DiagnosticSeverity.Error,
         isEnabledByDefault: true,
-        description: $"Cannot generate sample metadata as the attribute was used on an unsupported type.");
+        description: "Cannot generate sample metadata as the attribute was used on an unsupported type.");
 
     /// <summary>
     /// Gets a <see cref="DiagnosticDescriptor"/> indicating a <see cref="Attributes.ToolkitSampleOptionsPaneAttribute"/> that was used on an unsupported type.
     /// <para>
-    /// Format: <c>"Cannot generate options pane metadata as the attribute was used on an unsupported type."</c>.
+    /// Format: <c>"Cannot generate options pane metadata as the attribute was used on an unsupported type"</c>.
     /// </para>
     /// </summary>
     public static readonly DiagnosticDescriptor SampleOptionPaneAttributeOnUnsupportedType = new(
         id: "TKSMPL0008",
-        title: $"Toolkit sample options pane declared on an invalid type",
-        messageFormat: $"Cannot generate options pane metadata as the attribute was used on an unsupported type",
+        title: "Toolkit sample options pane declared on an invalid type",
+        messageFormat: "Cannot generate options pane metadata as the attribute was used on an unsupported type",
         category: typeof(ToolkitSampleMetadataGenerator).FullName,
         defaultSeverity: DiagnosticSeverity.Error,
         isEnabledByDefault: true,
-        description: $"Cannot generate options pane metadata as the attribute was used on an unsupported type.");
+        description: "Cannot generate options pane metadata as the attribute was used on an unsupported type.");
 
     /// <summary>
     /// Gets a <see cref="DiagnosticDescriptor"/> indicating a derived <see cref="Attributes.ToolkitSampleOptionBaseAttribute"/> that was used on an unsupported type.
     /// <para>
-    /// Format: <c>"Cannot generate sample option metadata as the attribute was used on an unsupported type."</c>.
+    /// Format: <c>"Cannot generate sample option metadata as the attribute was used on an unsupported type"</c>.
     /// </para>
     /// </summary>
     public static readonly DiagnosticDescriptor SampleGeneratedOptionAttributeOnUnsupportedType = new(
         id: "TKSMPL0009",
-        title: $"Toolkit sample option declared on an invalid type",
-        messageFormat: $"Cannot generate sample option metadata as the attribute was used on an unsupported type",
+        title: "Toolkit sample option declared on an invalid type",
+        messageFormat: "Cannot generate sample option metadata as the attribute was used on an unsupported type",
         category: typeof(ToolkitSampleMetadataGenerator).FullName,
         defaultSeverity: DiagnosticSeverity.Error,
         isEnabledByDefault: true,
-        description: $"Cannot generate sample option metadata as the attribute was used on an unsupported type.");
+        description: "Cannot generate sample option metadata as the attribute was used on an unsupported type.");
 
     /// <summary>
     /// Gets a <see cref="DiagnosticDescriptor"/> indicating an exception occured while parsing the front matter of a markdown sample file.
     /// </summary>
     public static readonly DiagnosticDescriptor MarkdownYAMLFrontMatterException = new(
         id: "TKSMPL0010",
-        title: $"Invalid YAML Front Matter",
-        messageFormat: $"Cannot generate sample page info for file {{0}} as an error was encountered parsing its YAML front matter: {{1}}",
+        title: "Invalid YAML Front Matter",
+        messageFormat: "Cannot generate sample page info for file {{0}} as an error was encountered parsing its YAML front matter: {{1}}",
         category: typeof(ToolkitSampleMetadataGenerator).FullName,
         defaultSeverity: DiagnosticSeverity.Error,
         isEnabledByDefault: true,
-        description: $"Cannot generate sample page info due to a YAML Front Matter parsing exception.");
+        description: "Cannot generate sample page info due to a YAML Front Matter parsing exception.");
 
     /// <summary>
     /// Gets a <see cref="DiagnosticDescriptor"/> indicating an expected piece of metadata was missing from the front matter of a markdown sample file.
     /// </summary>
     public static readonly DiagnosticDescriptor MarkdownYAMLFrontMatterMissingField = new(
         id: "TKSMPL0011",
-        title: $"Missing YAML Front Matter",
-        messageFormat: $"Cannot generate sample page info for file {{0}} as no '{{1}}' field was found in its YAML front matter.",
+        title: "Missing YAML Front Matter",
+        messageFormat: "Cannot generate sample page info for file {{0}} as no '{{1}}' field was found in its YAML front matter",
         category: typeof(ToolkitSampleMetadataGenerator).FullName,
         defaultSeverity: DiagnosticSeverity.Error,
         isEnabledByDefault: true,
-        description: $"Cannot generate sample page info due to missing YAML Front Matter.");
+        description: "Cannot generate sample page info due to missing YAML Front Matter.");
 
     /// <summary>
     /// Gets a <see cref="DiagnosticDescriptor"/> indicating the sample referenced in the Markdown file couldn't be found.
     /// </summary>
     public static readonly DiagnosticDescriptor MarkdownSampleIdNotFound = new(
         id: "TKSMPL0012",
-        title: $"Sample Id Not Found from Markdown Reference",
-        messageFormat: $"Cannot find the sample page referenced in file {{0}} with sample id '{{1}}'.",
+        title: "Sample Id Not Found from Markdown Reference",
+        messageFormat: "Cannot find the sample page referenced in file {{0}} with sample id '{{1}}'",
         category: typeof(ToolkitSampleMetadataGenerator).FullName,
         defaultSeverity: DiagnosticSeverity.Error,
         isEnabledByDefault: true,
-        description: $"Cannot link sample page info due to invalid/unknown id.");
+        description: "Cannot link sample page info due to invalid or unknown id.");
 
     /// <summary>
     /// Gets a <see cref="DiagnosticDescriptor"/> indicating the sample is not referenced in any Markdown documentation files.
     /// </summary>
     public static readonly DiagnosticDescriptor SampleNotReferencedInMarkdown = new(
         id: "TKSMPL0013",
-        title: $"Sample Not Referenced In Documentation",
-        messageFormat: $"The sample with id '{{0}}' is not referenced in any documentation files and will not appear in the full sample app.",
+        title: "Sample Not Referenced In Documentation",
+        messageFormat: "The sample with id '{{0}}' is not referenced in any documentation files and will not appear in the full sample app",
         category: typeof(ToolkitSampleMetadataGenerator).FullName,
         defaultSeverity: DiagnosticSeverity.Warning,
         isEnabledByDefault: true,
-        description: $"Cannot find reference to the sample within the documentation.");
+        description: "Cannot find reference to the sample within the documentation.");
 
     /// <summary>
     /// Gets a <see cref="DiagnosticDescriptor"/> indicating the documentation file contains no sample references.
     /// </summary>
     public static readonly DiagnosticDescriptor DocumentationHasNoSamples = new(
         id: "TKSMPL0014",
-        title: $"Documentation Has No Samples",
-        messageFormat: $"The documentation page '{{0}}' does not reference any sample examples, it is recommended to have at least one code sample per document page.",
+        title: "Documentation Has No Samples",
+        messageFormat: "The documentation page '{{0}}' does not reference any sample examples, it is recommended to have at least one code sample per document page",
         category: typeof(ToolkitSampleMetadataGenerator).FullName,
         defaultSeverity: DiagnosticSeverity.Warning,
         isEnabledByDefault: true,
-        description: $"Document contains no interactive sample code.");
+        description: "Document contains no interactive sample code.");
 
     /// <summary>
     /// Gets a <see cref="DiagnosticDescriptor"/> indicating a sample ID is already in use by another sample.
@@ -214,10 +214,10 @@ public static class DiagnosticDescriptors
     /// </summary>
     public static readonly DiagnosticDescriptor SampleIdAlreadyInUse = new(
         id: "TKSMPL0015",
-        title: $"Sample ID already in use",
-        messageFormat: $"Cannot generate sample with id {{0}} as the provided id is already in use by another sample",
+        title: "Sample ID already in use",
+        messageFormat: "Cannot generate sample with id {{0}} as the provided id is already in use by another sample",
         category: typeof(ToolkitSampleMetadataGenerator).FullName,
         defaultSeverity: DiagnosticSeverity.Error,
         isEnabledByDefault: true,
-        description: $"Cannot generate sample as the id is already in use by another sample.");
+        description: "Cannot generate sample as the id is already in use by another sample.");
 }

CommunityToolkit.Tooling.TestGen/Diagnostics/DiagnosticDescriptors.cs

@@ -19,10 +19,10 @@ public static class DiagnosticDescriptors
     /// </summary>
     public static readonly DiagnosticDescriptor TestControlHasConstructorWithParameters = new(
         id: "LUITM0001",
-        title: $"Provided control must not have a constructor with parameters.",
-        messageFormat: $"Cannot generate test with control {{0}} as it has a constructor with parameters.",
+        title: "Provided control must not have a constructor with parameters.",
+        messageFormat: "Cannot generate test with control {{0}} as it has a constructor with parameters",
         category: typeof(UIThreadTestMethodGenerator).FullName,
         defaultSeverity: DiagnosticSeverity.Error,
         isEnabledByDefault: true,
-        description: $"Cannot generate test method with provided control.");
+        description: "Cannot generate test method with provided control.");
 }