Add clarifying doc comments.

mitchknife · mitchknife · commit c625c24c46f6 · 2023-12-18T15:52:49.000-08:00
diff --git a/README.md b/README.md
@@ -10,3 +10,18 @@ fsdgenjs | A tool that generates JavaScript or TypeScript for a Facility Service
 Facility.CodeGen.JavaScript | A library that generates JavaScript or TypeScript for a Facility Service Definition. | [![NuGet](https://img.shields.io/nuget/v/Facility.CodeGen.JavaScript.svg)](https://www.nuget.org/packages/Facility.CodeGen.JavaScript)
 
 [Documentation](https://facilityapi.github.io/) | [Release Notes](https://github.com/FacilityApi/FacilityJavaScript/blob/master/ReleaseNotes.md) | [Contributing](https://github.com/FacilityApi/FacilityJavaScript/blob/master/CONTRIBUTING.md)
+
+## Conformance
+
+To run conformance tests, first start one of the conformance servers from within the `/conformance` folder:
+
+```
+npm run fastify:ts
+npm run fastify:js
+```
+
+Then run the conformance tool against the running service.
+
+```
+npm run test
+```
diff --git a/src/Facility.CodeGen.JavaScript/JavaScriptGenerator.cs b/src/Facility.CodeGen.JavaScript/JavaScriptGenerator.cs
@@ -36,6 +36,9 @@ public static int GenerateJavaScript(JavaScriptGeneratorSettings settings) =>
 		/// <summary>
 		/// True to generate Fastify plugin.
 		/// </summary>
+		/// <remarks>
+		/// When specified, only the server plugin is generated, not the client.
+		/// </remarks>
 		public bool Fastify { get; set; }
 
 		/// <summary>
diff --git a/src/Facility.CodeGen.JavaScript/JavaScriptGeneratorSettings.cs b/src/Facility.CodeGen.JavaScript/JavaScriptGeneratorSettings.cs
@@ -25,6 +25,9 @@ public sealed class JavaScriptGeneratorSettings : FileGeneratorSettings
 		/// <summary>
 		/// True to generate Fastify plugin.
 		/// </summary>
+		/// <remarks>
+		/// When specified, only the server plugin is generated, not the client.
+		/// </remarks>
 		public bool Fastify { get; set; }
 
 		/// <summary>
diff --git a/src/fsdgenjs/FsdGenJavaScriptApp.cs b/src/fsdgenjs/FsdGenJavaScriptApp.cs
@@ -23,7 +23,7 @@ public sealed class FsdGenJavaScriptApp : CodeGeneratorApp
 			"   --express",
 			"      Generates Express service.",
 			"   --fastify",
-			"      Generates Fastify plugin.",
+			"      Generates a Fastify plugin. When specified, only the server plugin is generated, not the client.",
 			"   --disable-eslint",
 			"      Disables ESLint via code comment.",
 		};
