Documentation updated.

FacilityApi · Jul 4, 2024 · 4784752 · 4784752
1 parent 3ef5774
commit 4784752
Show file tree

Hide file tree

Showing 24 changed files with 194 additions and 42 deletions.
diff --git a/docs/Facility.CodeGen.Console/CodeGeneratorApp.md b/docs/Facility.CodeGen.Console/CodeGeneratorApp.md
@@ -20,7 +20,7 @@ public abstract class CodeGeneratorApp
 | abstract [Description](CodeGeneratorApp/Description.md) { get; } | The app description lines for help. |
 | virtual [ExtraUsage](CodeGeneratorApp/ExtraUsage.md) { get; } | Any extra usage lines for help. |
 | abstract [CreateGenerator](CodeGeneratorApp/CreateGenerator.md)() | Creates the code generator. |
-| virtual [CreateParser](CodeGeneratorApp/CreateParser.md)() | Creates the service parser. |
+| abstract [CreateParser](CodeGeneratorApp/CreateParser.md)() | Creates the service parser. |
 | abstract [CreateSettings](CodeGeneratorApp/CreateSettings.md)(…) | Creates the file generator settings. |
 
 ## See Also

diff --git a/docs/Facility.CodeGen.Console/CodeGeneratorApp/CreateParser.md b/docs/Facility.CodeGen.Console/CodeGeneratorApp/CreateParser.md
@@ -3,7 +3,7 @@
 Creates the service parser.
 
 ```csharp
-protected virtual ServiceParser CreateParser()
+protected abstract ServiceParser CreateParser()
 ```
 
 ## See Also

diff --git a/docs/Facility.Definition.CodeGen/FileGenerator.md b/docs/Facility.Definition.CodeGen/FileGenerator.md
@@ -10,7 +10,7 @@ public static class FileGenerator
 
 | name | description |
 | --- | --- |
-| static [GenerateFiles](FileGenerator/GenerateFiles.md)(…) | Parses input files and generates output files. (2 methods) |
+| static [GenerateFiles](FileGenerator/GenerateFiles.md)(…) | Parses input files and generates output files. |
 
 ## See Also
 

diff --git a/docs/Facility.Definition.CodeGen/FileGenerator/GenerateFiles.md b/docs/Facility.Definition.CodeGen/FileGenerator/GenerateFiles.md
@@ -1,30 +1,4 @@
-# FileGenerator.GenerateFiles method (1 of 2)
-
-Parses input files and generates output files.
-
-```csharp
-public static int GenerateFiles(CodeGenerator generator, FileGeneratorSettings settings)
-```
-
-| parameter | description |
-| --- | --- |
-| generator | The code generator. |
-| settings | The settings. |
-
-## Return Value
-
-The number of updated files.
-
-## See Also
-
-* class [CodeGenerator](../CodeGenerator.md)
-* class [FileGeneratorSettings](../FileGeneratorSettings.md)
-* class [FileGenerator](../FileGenerator.md)
-* namespace [Facility.Definition.CodeGen](../../Facility.Definition.md)
-
----
-
-# FileGenerator.GenerateFiles method (2 of 2)
+# FileGenerator.GenerateFiles method
 
 Parses input files and generates output files.
 

diff --git a/docs/Facility.Definition.Fsd/FsdGenerator/GenerateFsd.md b/docs/Facility.Definition.Fsd/FsdGenerator/GenerateFsd.md
@@ -3,11 +3,12 @@
 Generates an FSD file for a service definition.
 
 ```csharp
-public static int GenerateFsd(FsdGeneratorSettings settings)
+public static int GenerateFsd(ServiceParser parser, FsdGeneratorSettings settings)
 ```
 
 | parameter | description |
 | --- | --- |
+| parser | The service parser. |
 | settings | The settings. |
 
 ## Return Value
@@ -16,6 +17,7 @@ The number of updated files.
 
 ## See Also
 
+* class [ServiceParser](../ServiceParser.md)
 * class [FsdGeneratorSettings](../FsdGeneratorSettings.md)
 * class [FsdGenerator](../FsdGenerator.md)
 * namespace [Facility.Definition.Fsd](../../Facility.Definition.md)

diff --git a/docs/Facility.Definition.Fsd/FsdParser.md b/docs/Facility.Definition.Fsd/FsdParser.md
@@ -10,7 +10,7 @@ public sealed class FsdParser : ServiceParser
 
 | name | description |
 | --- | --- |
-| [FsdParser](FsdParser/FsdParser.md)() | The default constructor. |
+| [FsdParser](FsdParser/FsdParser.md)(…) | Creates an FSD parser. |
 
 ## Protected Members
 

diff --git a/docs/Facility.Definition.Fsd/FsdParser/FsdParser.md b/docs/Facility.Definition.Fsd/FsdParser/FsdParser.md
@@ -1,13 +1,14 @@
 # FsdParser constructor
 
-The default constructor.
+Creates an FSD parser.
 
 ```csharp
-public FsdParser()
+public FsdParser(FsdParserSettings settings)
 ```
 
 ## See Also
 
+* class [FsdParserSettings](../FsdParserSettings.md)
 * class [FsdParser](../FsdParser.md)
 * namespace [Facility.Definition.Fsd](../../Facility.Definition.md)
 

diff --git a/docs/Facility.Definition.Fsd/FsdParserSettings.md b/docs/Facility.Definition.Fsd/FsdParserSettings.md
@@ -0,0 +1,21 @@
+# FsdParserSettings class
+
+Settings for parsing an FSD file.
+
+```csharp
+public sealed class FsdParserSettings
+```
+
+## Public Members
+
+| name | description |
+| --- | --- |
+| [FsdParserSettings](FsdParserSettings/FsdParserSettings.md)() | The default constructor. |
+| [SupportsEvents](FsdParserSettings/SupportsEvents.md) { get; set; } | True to allow events. |
+
+## See Also
+
+* namespace [Facility.Definition.Fsd](../Facility.Definition.md)
+* [FsdParserSettings.cs](https://github.com/FacilityApi/Facility/tree/master/src/Facility.Definition/Fsd/FsdParserSettings.cs)
+
+<!-- DO NOT EDIT: generated by xmldocmd for Facility.Definition.dll -->
diff --git a/docs/Facility.Definition.Fsd/FsdParserSettings/FsdParserSettings.md b/docs/Facility.Definition.Fsd/FsdParserSettings/FsdParserSettings.md
@@ -0,0 +1,14 @@
+# FsdParserSettings constructor
+
+The default constructor.
+
+```csharp
+public FsdParserSettings()
+```
+
+## See Also
+
+* class [FsdParserSettings](../FsdParserSettings.md)
+* namespace [Facility.Definition.Fsd](../../Facility.Definition.md)
+
+<!-- DO NOT EDIT: generated by xmldocmd for Facility.Definition.dll -->
diff --git a/docs/Facility.Definition.Fsd/FsdParserSettings/SupportsEvents.md b/docs/Facility.Definition.Fsd/FsdParserSettings/SupportsEvents.md
@@ -0,0 +1,14 @@
+# FsdParserSettings.SupportsEvents property
+
+True to allow events.
+
+```csharp
+public bool SupportsEvents { get; set; }
+```
+
+## See Also
+
+* class [FsdParserSettings](../FsdParserSettings.md)
+* namespace [Facility.Definition.Fsd](../../Facility.Definition.md)
+
+<!-- DO NOT EDIT: generated by xmldocmd for Facility.Definition.dll -->
diff --git a/docs/Facility.Definition.Http/HttpServiceInfo.md b/docs/Facility.Definition.Http/HttpServiceInfo.md
@@ -11,8 +11,10 @@ public sealed class HttpServiceInfo : HttpElementInfo
 | name | description |
 | --- | --- |
 | static [Create](HttpServiceInfo/Create.md)(…) | Creates an HTTP mapping for a service. |
+| [AllMethods](HttpServiceInfo/AllMethods.md) { get; } | The HTTP mapping for all methods (normal methods and event methods). |
 | [ErrorSets](HttpServiceInfo/ErrorSets.md) { get; } | The HTTP mapping for the error sets. |
-| [Methods](HttpServiceInfo/Methods.md) { get; } | The HTTP mapping for the methods. |
+| [Events](HttpServiceInfo/Events.md) { get; } | The HTTP mapping for event methods. |
+| [Methods](HttpServiceInfo/Methods.md) { get; } | The HTTP mapping for normal methods. |
 | [Service](HttpServiceInfo/Service.md) { get; } | The service. |
 | [Url](HttpServiceInfo/Url.md) { get; } | The URL of the HTTP service. |
 | override [GetChildren](HttpServiceInfo/GetChildren.md)() | The children of the element, if any. |

diff --git a/docs/Facility.Definition.Http/HttpServiceInfo/AllMethods.md b/docs/Facility.Definition.Http/HttpServiceInfo/AllMethods.md
@@ -0,0 +1,15 @@
+# HttpServiceInfo.AllMethods property
+
+The HTTP mapping for all methods (normal methods and event methods).
+
+```csharp
+public IReadOnlyList<HttpMethodInfo> AllMethods { get; }
+```
+
+## See Also
+
+* class [HttpMethodInfo](../HttpMethodInfo.md)
+* class [HttpServiceInfo](../HttpServiceInfo.md)
+* namespace [Facility.Definition.Http](../../Facility.Definition.md)
+
+<!-- DO NOT EDIT: generated by xmldocmd for Facility.Definition.dll -->
diff --git a/docs/Facility.Definition.Http/HttpServiceInfo/Events.md b/docs/Facility.Definition.Http/HttpServiceInfo/Events.md
@@ -0,0 +1,15 @@
+# HttpServiceInfo.Events property
+
+The HTTP mapping for event methods.
+
+```csharp
+public IReadOnlyList<HttpMethodInfo> Events { get; }
+```
+
+## See Also
+
+* class [HttpMethodInfo](../HttpMethodInfo.md)
+* class [HttpServiceInfo](../HttpServiceInfo.md)
+* namespace [Facility.Definition.Http](../../Facility.Definition.md)
+
+<!-- DO NOT EDIT: generated by xmldocmd for Facility.Definition.dll -->
diff --git a/docs/Facility.Definition.Http/HttpServiceInfo/Methods.md b/docs/Facility.Definition.Http/HttpServiceInfo/Methods.md
@@ -1,6 +1,6 @@
 # HttpServiceInfo.Methods property
 
-The HTTP mapping for the methods.
+The HTTP mapping for normal methods.
 
 ```csharp
 public IReadOnlyList<HttpMethodInfo> Methods { get; }

diff --git a/docs/Facility.Definition.md b/docs/Facility.Definition.md
@@ -28,6 +28,7 @@
 | class [ServiceInfo](./Facility.Definition/ServiceInfo.md) | Information about a service from a definition. |
 | abstract class [ServiceMemberInfo](./Facility.Definition/ServiceMemberInfo.md) | Properties common to service members. |
 | class [ServiceMethodInfo](./Facility.Definition/ServiceMethodInfo.md) | A service method. |
+| enum [ServiceMethodKind](./Facility.Definition/ServiceMethodKind.md) | The kind of service method. |
 | class [ServicePart](./Facility.Definition/ServicePart.md) | A part of a service element. |
 | enum [ServicePartKind](./Facility.Definition/ServicePartKind.md) | The kind of service part. |
 | class [ServiceTypeInfo](./Facility.Definition/ServiceTypeInfo.md) | A service type. |
@@ -54,6 +55,7 @@
 | class [FsdGenerator](./Facility.Definition.Fsd/FsdGenerator.md) | Generates an FSD file for a service definition. |
 | class [FsdGeneratorSettings](./Facility.Definition.Fsd/FsdGeneratorSettings.md) | Settings for generating an FSD file for a service definition. |
 | class [FsdParser](./Facility.Definition.Fsd/FsdParser.md) | Parses FSD files. |
+| class [FsdParserSettings](./Facility.Definition.Fsd/FsdParserSettings.md) | Settings for parsing an FSD file. |
 | abstract class [ServiceParser](./Facility.Definition.Fsd/ServiceParser.md) | Base class for service parsers. |
 
 ## Facility.Definition.Http namespace

diff --git a/docs/Facility.Definition/ServiceInfo.md b/docs/Facility.Definition/ServiceInfo.md
@@ -11,13 +11,15 @@ public sealed class ServiceInfo : ServiceMemberInfo
 | name | description |
 | --- | --- |
 | [ServiceInfo](ServiceInfo/ServiceInfo.md)(…) | Creates a service. |
+| [AllMethods](ServiceInfo/AllMethods.md) { get; } | All methods (normal methods and event methods). |
 | [Dtos](ServiceInfo/Dtos.md) { get; } | The DTOs. |
 | [Enums](ServiceInfo/Enums.md) { get; } | The enumerated types. |
 | [ErrorSets](ServiceInfo/ErrorSets.md) { get; } | The error sets. |
+| [Events](ServiceInfo/Events.md) { get; } | The event methods. |
 | [ExternalDtos](ServiceInfo/ExternalDtos.md) { get; } | The external DTOs. |
 | [ExternalEnums](ServiceInfo/ExternalEnums.md) { get; } | The external enumerated types. |
-| [Members](ServiceInfo/Members.md) { get; } | All of the service members.. |
-| [Methods](ServiceInfo/Methods.md) { get; } | The methods. |
+| [Members](ServiceInfo/Members.md) { get; } | All service members. |
+| [Methods](ServiceInfo/Methods.md) { get; } | The normal methods. |
 | [ExcludeTag](ServiceInfo/ExcludeTag.md)(…) | Excludes a tag from the service. |
 | [FindMember](ServiceInfo/FindMember.md)(…) | Finds the member of the specified name. |
 | [GetFieldType](ServiceInfo/GetFieldType.md)(…) | Gets the field type for a field. |

diff --git a/docs/Facility.Definition/ServiceInfo/AllMethods.md b/docs/Facility.Definition/ServiceInfo/AllMethods.md
@@ -0,0 +1,15 @@
+# ServiceInfo.AllMethods property
+
+All methods (normal methods and event methods).
+
+```csharp
+public IReadOnlyList<ServiceMethodInfo> AllMethods { get; }
+```
+
+## See Also
+
+* class [ServiceMethodInfo](../ServiceMethodInfo.md)
+* class [ServiceInfo](../ServiceInfo.md)
+* namespace [Facility.Definition](../../Facility.Definition.md)
+
+<!-- DO NOT EDIT: generated by xmldocmd for Facility.Definition.dll -->
diff --git a/docs/Facility.Definition/ServiceInfo/Events.md b/docs/Facility.Definition/ServiceInfo/Events.md
@@ -0,0 +1,15 @@
+# ServiceInfo.Events property
+
+The event methods.
+
+```csharp
+public IReadOnlyList<ServiceMethodInfo> Events { get; }
+```
+
+## See Also
+
+* class [ServiceMethodInfo](../ServiceMethodInfo.md)
+* class [ServiceInfo](../ServiceInfo.md)
+* namespace [Facility.Definition](../../Facility.Definition.md)
+
+<!-- DO NOT EDIT: generated by xmldocmd for Facility.Definition.dll -->
diff --git a/docs/Facility.Definition/ServiceInfo/Members.md b/docs/Facility.Definition/ServiceInfo/Members.md
@@ -1,6 +1,6 @@
 # ServiceInfo.Members property
 
-All of the service members..
+All service members.
 
 ```csharp
 public IReadOnlyList<ServiceMemberInfo> Members { get; }

diff --git a/docs/Facility.Definition/ServiceInfo/Methods.md b/docs/Facility.Definition/ServiceInfo/Methods.md
@@ -1,6 +1,6 @@
 # ServiceInfo.Methods property
 
-The methods.
+The normal methods.
 
 ```csharp
 public IReadOnlyList<ServiceMethodInfo> Methods { get; }

diff --git a/docs/Facility.Definition/ServiceMethodInfo.md b/docs/Facility.Definition/ServiceMethodInfo.md
@@ -10,7 +10,8 @@ public sealed class ServiceMethodInfo : ServiceMemberInfo
 
 | name | description |
 | --- | --- |
-| [ServiceMethodInfo](ServiceMethodInfo/ServiceMethodInfo.md)(…) | Creates a method. |
+| [ServiceMethodInfo](ServiceMethodInfo/ServiceMethodInfo.md)(…) | Creates a method. (2 constructors) |
+| [Kind](ServiceMethodInfo/Kind.md) { get; } | The kind of the method. |
 | [RequestFields](ServiceMethodInfo/RequestFields.md) { get; } | The request fields of the method. |
 | [ResponseFields](ServiceMethodInfo/ResponseFields.md) { get; } | The response fields of the method. |
 

diff --git a/docs/Facility.Definition/ServiceMethodInfo/Kind.md b/docs/Facility.Definition/ServiceMethodInfo/Kind.md
@@ -0,0 +1,15 @@
+# ServiceMethodInfo.Kind property
+
+The kind of the method.
+
+```csharp
+public ServiceMethodKind Kind { get; }
+```
+
+## See Also
+
+* enum [ServiceMethodKind](../ServiceMethodKind.md)
+* class [ServiceMethodInfo](../ServiceMethodInfo.md)
+* namespace [Facility.Definition](../../Facility.Definition.md)
+
+<!-- DO NOT EDIT: generated by xmldocmd for Facility.Definition.dll -->
diff --git a/docs/Facility.Definition/ServiceMethodInfo/ServiceMethodInfo.md b/docs/Facility.Definition/ServiceMethodInfo/ServiceMethodInfo.md
@@ -1,4 +1,4 @@
-# ServiceMethodInfo constructor
+# ServiceMethodInfo constructor (1 of 2)
 
 Creates a method.
 
@@ -17,4 +17,27 @@ public ServiceMethodInfo(string name, IEnumerable<ServiceFieldInfo>? requestFiel
 * class [ServiceMethodInfo](../ServiceMethodInfo.md)
 * namespace [Facility.Definition](../../Facility.Definition.md)
 
+---
+
+# ServiceMethodInfo constructor (2 of 2)
+
+Creates a method.
+
+```csharp
+public ServiceMethodInfo(ServiceMethodKind kind, string name, 
+    IEnumerable<ServiceFieldInfo>? requestFields = null, 
+    IEnumerable<ServiceFieldInfo>? responseFields = null, 
+    IEnumerable<ServiceAttributeInfo>? attributes = null, string? summary = null, 
+    IEnumerable<string>? remarks = null, params ServicePart[] parts)
+```
+
+## See Also
+
+* enum [ServiceMethodKind](../ServiceMethodKind.md)
+* class [ServiceFieldInfo](../ServiceFieldInfo.md)
+* class [ServiceAttributeInfo](../ServiceAttributeInfo.md)
+* class [ServicePart](../ServicePart.md)
+* class [ServiceMethodInfo](../ServiceMethodInfo.md)
+* namespace [Facility.Definition](../../Facility.Definition.md)
+
 <!-- DO NOT EDIT: generated by xmldocmd for Facility.Definition.dll -->
diff --git a/docs/Facility.Definition/ServiceMethodKind.md b/docs/Facility.Definition/ServiceMethodKind.md
@@ -0,0 +1,21 @@
+# ServiceMethodKind enumeration
+
+The kind of service method.
+
+```csharp
+public enum ServiceMethodKind
+```
+
+## Values
+
+| name | value | description |
+| --- | --- | --- |
+| Normal | `0` | A normal method. |
+| Event | `1` | An event, i.e. a method that can indefinitely and repeatedly provide responses. |
+
+## See Also
+
+* namespace [Facility.Definition](../Facility.Definition.md)
+* [ServiceMethodKind.cs](https://github.com/FacilityApi/Facility/tree/master/src/Facility.Definition/ServiceMethodKind.cs)
+
+<!-- DO NOT EDIT: generated by xmldocmd for Facility.Definition.dll -->