From 4d869de9c28dbf3cefaf2f60d4b358497cd0d93c Mon Sep 17 00:00:00 2001 From: Joseph Doherty Date: Thu, 16 Jul 2026 23:31:34 -0400 Subject: [PATCH] docs: sister-repo index update + working notes CLAUDE.md: the historian SDK is now owned inside HistorianGateway at histsdk/ (the separate ~/Desktop/histsdk repo was folded in with history), so the sister-project list no longer points at a standalone repo. Also checks in working notes that were sitting untracked in the tree: deferred.md (remaining deferred work snapshot), ScadaBridge-docs-fixed.md and ScadaBridge-docs-issues.md (documentation-analysis report output). --- CLAUDE.md | 2 +- ScadaBridge-docs-fixed.md | 116 + ScadaBridge-docs-issues.md | 4296 ++++++++++++++++++++++++++++++++++++ deferred.md | 44 + 4 files changed, 4457 insertions(+), 1 deletion(-) create mode 100644 ScadaBridge-docs-fixed.md create mode 100644 ScadaBridge-docs-issues.md create mode 100644 deferred.md diff --git a/CLAUDE.md b/CLAUDE.md index 70b22a2c..7d993e6d 100644 --- a/CLAUDE.md +++ b/CLAUDE.md @@ -41,7 +41,7 @@ Repos cloned as sibling directories under `~/Desktop/` — referenced for contex - `~/Desktop/MxAccessGateway` — MxAccess Gateway (`https://gitea.dohertylan.com/dohertj2/mxaccessgw`). - `~/Desktop/OtOpcUa` — OtOpcUa (`https://gitea.dohertylan.com/dohertj2/lmxopcua`). -Other peers in the `scadaproj` family (see `scadaproj/CLAUDE.md` for details): `~/Desktop/HistorianGateway` (`historiangw`) — AVEVA Historian gRPC sidecar, OtOpcUa's sole historian backend; its SDK source `~/Desktop/histsdk` (`histsdk`); and `~/Desktop/scadaproj` (`scadaproj`) itself — shared `ZB.MOM.WW.*` libs + the dev/test GLAuth on `10.100.0.35:3893`. +Other peers in the `scadaproj` family (see `scadaproj/CLAUDE.md` for details): `~/Desktop/HistorianGateway` (`historiangw`) — AVEVA Historian gRPC sidecar, OtOpcUa's sole historian backend; its historian SDK (`AVEVA.Historian.Client`) is now owned inside that repo at `HistorianGateway/histsdk/` (the separate `~/Desktop/histsdk` repo was folded in with history); and `~/Desktop/scadaproj` (`scadaproj`) itself — shared `ZB.MOM.WW.*` libs + the dev/test GLAuth on `10.100.0.35:3893`. ## Document Conventions diff --git a/ScadaBridge-docs-fixed.md b/ScadaBridge-docs-fixed.md new file mode 100644 index 00000000..b2197e35 --- /dev/null +++ b/ScadaBridge-docs-fixed.md @@ -0,0 +1,116 @@ +# Documentation Analysis Report + +Files Scanned: 793 +Files With Issues: 10 +Total Issues: 11 + +## Issues + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.CentralUI/Components/BrowserTime.cs +LINE: 26 +CATEGORY: TaskReferenceInComment +SEVERITY: Warning +MEMBER: Comment +SIGNATURE: UTC-5 +MESSAGE: Comment contains 'UTC-5', which looks like a task/issue tracking identifier; tracking IDs should not appear in code documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.CentralUI/Components/Pages/Design/TransportImport.razor.cs +LINE: 225 +CATEGORY: TaskReferenceInComment +SEVERITY: Warning +MEMBER: Comment +SIGNATURE: Step-2 +MESSAGE: Comment contains 'Step-2', which looks like a task/issue tracking identifier; tracking IDs should not appear in code documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.CentralUI/Services/ConnectionHealthQueryService.cs +LINE: 18 +CATEGORY: TaskReferenceInComment +SEVERITY: Warning +MEMBER: Comment +SIGNATURE: PLC-1 +MESSAGE: Comment contains 'PLC-1', which looks like a task/issue tracking identifier; tracking IDs should not appear in code documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.CLI/Commands/AuditExportHelpers.cs +LINE: 156 +CATEGORY: TaskReferenceInComment +SEVERITY: Warning +MEMBER: Comment +SIGNATURE: non-403 +MESSAGE: Comment contains 'non-403', which looks like a task/issue tracking identifier; tracking IDs should not appear in code documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.CLI/Commands/BundleCommands.cs +LINE: 407 +CATEGORY: TaskReferenceInComment +SEVERITY: Warning +MEMBER: Comment +SIGNATURE: non-403 +MESSAGE: Comment contains 'non-403', which looks like a task/issue tracking identifier; tracking IDs should not appear in code documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.Communication/Grpc/SiteStreamGrpcServer.cs +LINE: 43 +CATEGORY: TaskReferenceInComment +SEVERITY: Warning +MEMBER: Comment +SIGNATURE: sub-100 +MESSAGE: Comment contains 'sub-100', which looks like a task/issue tracking identifier; tracking IDs should not appear in code documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.HealthMonitoring/SiteHealthState.cs +LINE: 29 +CATEGORY: TaskReferenceInComment +SEVERITY: Warning +MEMBER: Comment +SIGNATURE: year-0001 +MESSAGE: Comment contains 'year-0001', which looks like a task/issue tracking identifier; tracking IDs should not appear in code documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.ManagementService/ManagementActor.cs +LINE: 2034 +CATEGORY: TrackingReferenceInComment +SEVERITY: Warning +MEMBER: Comment +SIGNATURE: M365 +MESSAGE: Comment contains 'M365', which looks like a project tracking reference; bookkeeping references should not appear in code documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.NotificationOutbox/Delivery/EmailNotificationDeliveryAdapter.cs +LINE: 206 +CATEGORY: TrackingReferenceInComment +SEVERITY: Warning +MEMBER: Comment +SIGNATURE: M365 +MESSAGE: Comment contains 'M365', which looks like a project tracking reference; bookkeeping references should not appear in code documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.NotificationService/MailKitSmtpClientWrapper.cs +LINE: 9 +CATEGORY: TrackingReferenceInComment +SEVERITY: Warning +MEMBER: Comment +SIGNATURE: M365 +MESSAGE: Comment contains 'M365', which looks like a project tracking reference; bookkeeping references should not appear in code documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.NotificationService/MailKitSmtpClientWrapper.cs +LINE: 113 +CATEGORY: TrackingReferenceInComment +SEVERITY: Warning +MEMBER: Comment +SIGNATURE: M365 +MESSAGE: Comment contains 'M365', which looks like a project tracking reference; bookkeeping references should not appear in code documentation. + diff --git a/ScadaBridge-docs-issues.md b/ScadaBridge-docs-issues.md new file mode 100644 index 00000000..c5f3a23a --- /dev/null +++ b/ScadaBridge-docs-issues.md @@ -0,0 +1,4296 @@ +# Documentation Analysis Report + +Files Scanned: 793 +Files With Issues: 113 +Total Issues: 429 + +## Issues + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.AuditLog/Central/AuditLogIngestActor.cs +LINE: 263 +CATEGORY: TrackingReferenceInComment +SEVERITY: Warning +MEMBER: Comment +SIGNATURE: Task 12 +MESSAGE: Comment contains 'Task 12', which looks like a project tracking reference; bookkeeping references should not appear in code documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.AuditLog/Central/GrpcPullAuditEventsClient.cs +LINE: 101 +CATEGORY: TrackingReferenceInComment +SEVERITY: Warning +MEMBER: Comment +SIGNATURE: Task 18 +MESSAGE: Comment contains 'Task 18', which looks like a project tracking reference; bookkeeping references should not appear in code documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.AuditLog/Central/GrpcPullSiteCallsClient.cs +LINE: 104 +CATEGORY: TrackingReferenceInComment +SEVERITY: Warning +MEMBER: Comment +SIGNATURE: Task 16 +MESSAGE: Comment contains 'Task 16', which looks like a project tracking reference; bookkeeping references should not appear in code documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.AuditLog/Central/GrpcPullSiteCallsClient.cs +LINE: 113 +CATEGORY: TrackingReferenceInComment +SEVERITY: Warning +MEMBER: Comment +SIGNATURE: Task 18 +MESSAGE: Comment contains 'Task 18', which looks like a project tracking reference; bookkeeping references should not appear in code documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.AuditLog/Central/IPullSiteCallsClient.cs +LINE: 50 +CATEGORY: TrackingReferenceInComment +SEVERITY: Warning +MEMBER: Comment +SIGNATURE: Task 16 +MESSAGE: Comment contains 'Task 16', which looks like a project tracking reference; bookkeeping references should not appear in code documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.AuditLog/Central/ISiteEnumerator.cs +LINE: 15 +CATEGORY: TrackingReferenceInComment +SEVERITY: Warning +MEMBER: Comment +SIGNATURE: Task 18 +MESSAGE: Comment contains 'Task 18', which looks like a project tracking reference; bookkeeping references should not appear in code documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.AuditLog/Central/ISiteEnumerator.cs +LINE: 41 +CATEGORY: TrackingReferenceInComment +SEVERITY: Warning +MEMBER: Comment +SIGNATURE: Task 18 +MESSAGE: Comment contains 'Task 18', which looks like a project tracking reference; bookkeeping references should not appear in code documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.AuditLog/Central/SiteAuditReconciliationActor.cs +LINE: 296 +CATEGORY: TrackingReferenceInComment +SEVERITY: Warning +MEMBER: Comment +SIGNATURE: Task 17 +MESSAGE: Comment contains 'Task 17', which looks like a project tracking reference; bookkeeping references should not appear in code documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.AuditLog/Central/SiteAuditReconciliationActor.cs +LINE: 338 +CATEGORY: TrackingReferenceInComment +SEVERITY: Warning +MEMBER: Comment +SIGNATURE: Task 17 +MESSAGE: Comment contains 'Task 17', which looks like a project tracking reference; bookkeeping references should not appear in code documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.AuditLog/Central/SiteAuditReconciliationActor.cs +LINE: 359 +CATEGORY: TaskReferenceInComment +SEVERITY: Warning +MEMBER: Comment +SIGNATURE: Task-14 +MESSAGE: Comment contains 'Task-14', which looks like a task/issue tracking identifier; tracking IDs should not appear in code documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.AuditLog/Central/SiteEnumerator.cs +LINE: 31 +CATEGORY: TrackingReferenceInComment +SEVERITY: Warning +MEMBER: Comment +SIGNATURE: Task 18 +MESSAGE: Comment contains 'Task 18', which looks like a project tracking reference; bookkeeping references should not appear in code documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.AuditLog/Central/SiteEnumerator.cs +LINE: 64 +CATEGORY: TrackingReferenceInComment +SEVERITY: Warning +MEMBER: Comment +SIGNATURE: Task 18 +MESSAGE: Comment contains 'Task 18', which looks like a project tracking reference; bookkeeping references should not appear in code documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.AuditLog/Kpi/AuditLogKpiSampleSource.cs +LINE: 6 +CATEGORY: TrackingReferenceInComment +SEVERITY: Warning +MEMBER: Comment +SIGNATURE: Task 10 +MESSAGE: Comment contains 'Task 10', which looks like a project tracking reference; bookkeeping references should not appear in code documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.AuditLog/Kpi/AuditLogKpiSampleSource.cs +LINE: 67 +CATEGORY: TaskReferenceInComment +SEVERITY: Warning +MEMBER: Comment +SIGNATURE: Task-10 +MESSAGE: Comment contains 'Task-10', which looks like a task/issue tracking identifier; tracking IDs should not appear in code documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.AuditLog/Site/SiteAuditRetentionOptions.cs +LINE: 4 +CATEGORY: TrackingReferenceInComment +SEVERITY: Warning +MEMBER: Comment +SIGNATURE: Task 2 +MESSAGE: Comment contains 'Task 2', which looks like a project tracking reference; bookkeeping references should not appear in code documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.AuditLog/Site/SiteAuditRetentionOptions.cs +LINE: 4 +CATEGORY: TaskReferenceInComment +SEVERITY: Warning +MEMBER: Comment +SIGNATURE: PLAN-04 +MESSAGE: Comment contains 'PLAN-04', which looks like a task/issue tracking identifier; tracking IDs should not appear in code documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.AuditLog/Site/SiteAuditRetentionService.cs +LINE: 10 +CATEGORY: TrackingReferenceInComment +SEVERITY: Warning +MEMBER: Comment +SIGNATURE: Task 3 +MESSAGE: Comment contains 'Task 3', which looks like a project tracking reference; bookkeeping references should not appear in code documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.AuditLog/Site/SiteAuditRetentionService.cs +LINE: 10 +CATEGORY: TaskReferenceInComment +SEVERITY: Warning +MEMBER: Comment +SIGNATURE: PLAN-04 +MESSAGE: Comment contains 'PLAN-04', which looks like a task/issue tracking identifier; tracking IDs should not appear in code documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.CentralUI/Components/BrowserTime.cs +LINE: 26 +CATEGORY: TaskReferenceInComment +SEVERITY: Warning +MEMBER: Comment +SIGNATURE: UTC-5 +MESSAGE: Comment contains 'UTC-5', which looks like a task/issue tracking identifier; tracking IDs should not appear in code documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.CentralUI/Components/Pages/Deployment/DebugTreeBuilder.cs +LINE: 32 +CATEGORY: MissingReturns +SEVERITY: Warning +MEMBER: Method +SIGNATURE: BuildAttributeTree(IEnumerable attributes, string? filter) +MESSAGE: Method 'BuildAttributeTree(IEnumerable attributes, string? filter)' returns a value but is missing . + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.CentralUI/Components/Pages/Deployment/DebugTreeBuilder.cs +LINE: 92 +CATEGORY: MissingReturns +SEVERITY: Warning +MEMBER: Method +SIGNATURE: BuildAlarmTree(IEnumerable alarms, string? filter) +MESSAGE: Method 'BuildAlarmTree(IEnumerable alarms, string? filter)' returns a value but is missing . + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.CentralUI/Components/Pages/Deployment/DebugTreeNode.cs +LINE: 21 +CATEGORY: MissingDoc +SEVERITY: Error +MEMBER: Property +SIGNATURE: Children +MESSAGE: Property 'Children' is missing XML documentation + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.CentralUI/Components/Pages/Deployment/DebugTreeNode.cs +LINE: 24 +CATEGORY: MissingDoc +SEVERITY: Error +MEMBER: Property +SIGNATURE: Attribute +MESSAGE: Property 'Attribute' is missing XML documentation + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.CentralUI/Components/Pages/Deployment/DebugTreeNode.cs +LINE: 25 +CATEGORY: MissingDoc +SEVERITY: Error +MEMBER: Property +SIGNATURE: Alarm +MESSAGE: Property 'Alarm' is missing XML documentation + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.CentralUI/Components/Pages/Deployment/DebugTreeNode.cs +LINE: 27 +CATEGORY: MissingDoc +SEVERITY: Error +MEMBER: Property +SIGNATURE: IsNativeBinding +MESSAGE: Property 'IsNativeBinding' is missing XML documentation + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.CentralUI/Components/Pages/Deployment/DebugTreeNode.cs +LINE: 30 +CATEGORY: MissingDoc +SEVERITY: Error +MEMBER: Property +SIGNATURE: WorstState +MESSAGE: Property 'WorstState' is missing XML documentation + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.CentralUI/Components/Pages/Deployment/DebugTreeNode.cs +LINE: 31 +CATEGORY: MissingDoc +SEVERITY: Error +MEMBER: Property +SIGNATURE: ActiveCount +MESSAGE: Property 'ActiveCount' is missing XML documentation + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.CentralUI/Components/Pages/Deployment/DebugTreeNode.cs +LINE: 32 +CATEGORY: MissingDoc +SEVERITY: Error +MEMBER: Property +SIGNATURE: HasBadQuality +MESSAGE: Property 'HasBadQuality' is missing XML documentation + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.CentralUI/Components/Pages/Deployment/DebugTreeNode.cs +LINE: 34 +CATEGORY: MissingDoc +SEVERITY: Error +MEMBER: Property +SIGNATURE: HasChildren +MESSAGE: Property 'HasChildren' is missing XML documentation + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.CentralUI/Components/Pages/Deployment/InstanceConfigure.razor.cs +LINE: 56 +CATEGORY: MissingReturns +SEVERITY: Warning +MEMBER: Method +SIGNATURE: BuildCsvOverrideImport(OverrideCsvParseResult parsed, IReadOnlyList overridableAttributes) +MESSAGE: Method 'BuildCsvOverrideImport(OverrideCsvParseResult parsed, IReadOnlyList overridableAttributes)' returns a value but is missing . + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.CentralUI/Components/Pages/Design/TransportImport.razor.cs +LINE: 225 +CATEGORY: TaskReferenceInComment +SEVERITY: Warning +MEMBER: Comment +SIGNATURE: Step-2 +MESSAGE: Comment contains 'Step-2', which looks like a task/issue tracking identifier; tracking IDs should not appear in code documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.CentralUI/Components/Pages/Design/TransportImport.razor.cs +LINE: 616 +CATEGORY: MissingParam +SEVERITY: Warning +MEMBER: Method +SIGNATURE: TryExtractLineDiff(string? fieldDiffJson) +MESSAGE: Method 'TryExtractLineDiff(string? fieldDiffJson)' is missing documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.CentralUI/Components/Pages/Design/TransportImport.razor.cs +LINE: 616 +CATEGORY: MissingReturns +SEVERITY: Warning +MEMBER: Method +SIGNATURE: TryExtractLineDiff(string? fieldDiffJson) +MESSAGE: Method 'TryExtractLineDiff(string? fieldDiffJson)' returns a value but is missing . + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.CentralUI/Components/Pages/Operations/SecuredWriteDataTypeMapper.cs +LINE: 15 +CATEGORY: MissingDoc +SEVERITY: Error +MEMBER: Method +SIGNATURE: TryMap(string? galaxyTypeName, DataType dataType) +MESSAGE: Method 'TryMap(string? galaxyTypeName, DataType dataType)' is missing XML documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.CentralUI/Components/Shared/KpiTrendChart.razor.cs +LINE: 92 +CATEGORY: MissingDoc +SEVERITY: Error +MEMBER: Method +SIGNATURE: Slugify(string? title) +MESSAGE: Method 'Slugify(string? title)' is missing XML documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.CentralUI/ScriptAnalysis/SandboxScriptHost.cs +LINE: 332 +CATEGORY: MissingParam +SEVERITY: Warning +MEMBER: Method +SIGNATURE: WriteBatchAndWaitAsync(IReadOnlyDictionary values, string flagKey, object? flagValue, string responseKey, object? responseValue, TimeSpan timeout) +MESSAGE: Method 'WriteBatchAndWaitAsync(IReadOnlyDictionary values, string flagKey, object? flagValue, string responseKey, object? responseValue, TimeSpan timeout)' is missing documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.CentralUI/ScriptAnalysis/SandboxScriptHost.cs +LINE: 332 +CATEGORY: MissingParam +SEVERITY: Warning +MEMBER: Method +SIGNATURE: WriteBatchAndWaitAsync(IReadOnlyDictionary values, string flagKey, object? flagValue, string responseKey, object? responseValue, TimeSpan timeout) +MESSAGE: Method 'WriteBatchAndWaitAsync(IReadOnlyDictionary values, string flagKey, object? flagValue, string responseKey, object? responseValue, TimeSpan timeout)' is missing documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.CentralUI/ScriptAnalysis/SandboxScriptHost.cs +LINE: 332 +CATEGORY: MissingParam +SEVERITY: Warning +MEMBER: Method +SIGNATURE: WriteBatchAndWaitAsync(IReadOnlyDictionary values, string flagKey, object? flagValue, string responseKey, object? responseValue, TimeSpan timeout) +MESSAGE: Method 'WriteBatchAndWaitAsync(IReadOnlyDictionary values, string flagKey, object? flagValue, string responseKey, object? responseValue, TimeSpan timeout)' is missing documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.CentralUI/ScriptAnalysis/SandboxScriptHost.cs +LINE: 332 +CATEGORY: MissingParam +SEVERITY: Warning +MEMBER: Method +SIGNATURE: WriteBatchAndWaitAsync(IReadOnlyDictionary values, string flagKey, object? flagValue, string responseKey, object? responseValue, TimeSpan timeout) +MESSAGE: Method 'WriteBatchAndWaitAsync(IReadOnlyDictionary values, string flagKey, object? flagValue, string responseKey, object? responseValue, TimeSpan timeout)' is missing documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.CentralUI/ScriptAnalysis/SandboxScriptHost.cs +LINE: 332 +CATEGORY: MissingParam +SEVERITY: Warning +MEMBER: Method +SIGNATURE: WriteBatchAndWaitAsync(IReadOnlyDictionary values, string flagKey, object? flagValue, string responseKey, object? responseValue, TimeSpan timeout) +MESSAGE: Method 'WriteBatchAndWaitAsync(IReadOnlyDictionary values, string flagKey, object? flagValue, string responseKey, object? responseValue, TimeSpan timeout)' is missing documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.CentralUI/ScriptAnalysis/SandboxScriptHost.cs +LINE: 332 +CATEGORY: MissingParam +SEVERITY: Warning +MEMBER: Method +SIGNATURE: WriteBatchAndWaitAsync(IReadOnlyDictionary values, string flagKey, object? flagValue, string responseKey, object? responseValue, TimeSpan timeout) +MESSAGE: Method 'WriteBatchAndWaitAsync(IReadOnlyDictionary values, string flagKey, object? flagValue, string responseKey, object? responseValue, TimeSpan timeout)' is missing documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.CentralUI/ScriptAnalysis/SandboxScriptHost.cs +LINE: 332 +CATEGORY: MissingReturns +SEVERITY: Warning +MEMBER: Method +SIGNATURE: WriteBatchAndWaitAsync(IReadOnlyDictionary values, string flagKey, object? flagValue, string responseKey, object? responseValue, TimeSpan timeout) +MESSAGE: Method 'WriteBatchAndWaitAsync(IReadOnlyDictionary values, string flagKey, object? flagValue, string responseKey, object? responseValue, TimeSpan timeout)' returns a value but is missing . + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.CentralUI/ScriptAnalysis/SandboxScriptHost.cs +LINE: 341 +CATEGORY: MissingParam +SEVERITY: Warning +MEMBER: Method +SIGNATURE: WaitAsync(string key, object? targetValue, TimeSpan timeout, bool requireGoodQuality) +MESSAGE: Method 'WaitAsync(string key, object? targetValue, TimeSpan timeout, bool requireGoodQuality)' is missing documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.CentralUI/ScriptAnalysis/SandboxScriptHost.cs +LINE: 341 +CATEGORY: MissingParam +SEVERITY: Warning +MEMBER: Method +SIGNATURE: WaitAsync(string key, object? targetValue, TimeSpan timeout, bool requireGoodQuality) +MESSAGE: Method 'WaitAsync(string key, object? targetValue, TimeSpan timeout, bool requireGoodQuality)' is missing documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.CentralUI/ScriptAnalysis/SandboxScriptHost.cs +LINE: 341 +CATEGORY: MissingParam +SEVERITY: Warning +MEMBER: Method +SIGNATURE: WaitAsync(string key, object? targetValue, TimeSpan timeout, bool requireGoodQuality) +MESSAGE: Method 'WaitAsync(string key, object? targetValue, TimeSpan timeout, bool requireGoodQuality)' is missing documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.CentralUI/ScriptAnalysis/SandboxScriptHost.cs +LINE: 341 +CATEGORY: MissingParam +SEVERITY: Warning +MEMBER: Method +SIGNATURE: WaitAsync(string key, object? targetValue, TimeSpan timeout, bool requireGoodQuality) +MESSAGE: Method 'WaitAsync(string key, object? targetValue, TimeSpan timeout, bool requireGoodQuality)' is missing documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.CentralUI/ScriptAnalysis/SandboxScriptHost.cs +LINE: 341 +CATEGORY: MissingReturns +SEVERITY: Warning +MEMBER: Method +SIGNATURE: WaitAsync(string key, object? targetValue, TimeSpan timeout, bool requireGoodQuality) +MESSAGE: Method 'WaitAsync(string key, object? targetValue, TimeSpan timeout, bool requireGoodQuality)' returns a value but is missing . + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.CentralUI/ScriptAnalysis/SandboxScriptHost.cs +LINE: 348 +CATEGORY: MissingParam +SEVERITY: Warning +MEMBER: Method +SIGNATURE: WaitAsync(string key, Func predicate, TimeSpan timeout, bool requireGoodQuality) +MESSAGE: Method 'WaitAsync(string key, Func predicate, TimeSpan timeout, bool requireGoodQuality)' is missing documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.CentralUI/ScriptAnalysis/SandboxScriptHost.cs +LINE: 348 +CATEGORY: MissingParam +SEVERITY: Warning +MEMBER: Method +SIGNATURE: WaitAsync(string key, Func predicate, TimeSpan timeout, bool requireGoodQuality) +MESSAGE: Method 'WaitAsync(string key, Func predicate, TimeSpan timeout, bool requireGoodQuality)' is missing documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.CentralUI/ScriptAnalysis/SandboxScriptHost.cs +LINE: 348 +CATEGORY: MissingParam +SEVERITY: Warning +MEMBER: Method +SIGNATURE: WaitAsync(string key, Func predicate, TimeSpan timeout, bool requireGoodQuality) +MESSAGE: Method 'WaitAsync(string key, Func predicate, TimeSpan timeout, bool requireGoodQuality)' is missing documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.CentralUI/ScriptAnalysis/SandboxScriptHost.cs +LINE: 348 +CATEGORY: MissingParam +SEVERITY: Warning +MEMBER: Method +SIGNATURE: WaitAsync(string key, Func predicate, TimeSpan timeout, bool requireGoodQuality) +MESSAGE: Method 'WaitAsync(string key, Func predicate, TimeSpan timeout, bool requireGoodQuality)' is missing documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.CentralUI/ScriptAnalysis/SandboxScriptHost.cs +LINE: 348 +CATEGORY: MissingReturns +SEVERITY: Warning +MEMBER: Method +SIGNATURE: WaitAsync(string key, Func predicate, TimeSpan timeout, bool requireGoodQuality) +MESSAGE: Method 'WaitAsync(string key, Func predicate, TimeSpan timeout, bool requireGoodQuality)' returns a value but is missing . + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.CentralUI/ScriptAnalysis/SandboxScriptHost.cs +LINE: 355 +CATEGORY: MissingParam +SEVERITY: Warning +MEMBER: Method +SIGNATURE: WaitForAsync(string key, object? targetValue, TimeSpan timeout, bool requireGoodQuality) +MESSAGE: Method 'WaitForAsync(string key, object? targetValue, TimeSpan timeout, bool requireGoodQuality)' is missing documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.CentralUI/ScriptAnalysis/SandboxScriptHost.cs +LINE: 355 +CATEGORY: MissingParam +SEVERITY: Warning +MEMBER: Method +SIGNATURE: WaitForAsync(string key, object? targetValue, TimeSpan timeout, bool requireGoodQuality) +MESSAGE: Method 'WaitForAsync(string key, object? targetValue, TimeSpan timeout, bool requireGoodQuality)' is missing documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.CentralUI/ScriptAnalysis/SandboxScriptHost.cs +LINE: 355 +CATEGORY: MissingParam +SEVERITY: Warning +MEMBER: Method +SIGNATURE: WaitForAsync(string key, object? targetValue, TimeSpan timeout, bool requireGoodQuality) +MESSAGE: Method 'WaitForAsync(string key, object? targetValue, TimeSpan timeout, bool requireGoodQuality)' is missing documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.CentralUI/ScriptAnalysis/SandboxScriptHost.cs +LINE: 355 +CATEGORY: MissingParam +SEVERITY: Warning +MEMBER: Method +SIGNATURE: WaitForAsync(string key, object? targetValue, TimeSpan timeout, bool requireGoodQuality) +MESSAGE: Method 'WaitForAsync(string key, object? targetValue, TimeSpan timeout, bool requireGoodQuality)' is missing documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.CentralUI/ScriptAnalysis/SandboxScriptHost.cs +LINE: 355 +CATEGORY: MissingReturns +SEVERITY: Warning +MEMBER: Method +SIGNATURE: WaitForAsync(string key, object? targetValue, TimeSpan timeout, bool requireGoodQuality) +MESSAGE: Method 'WaitForAsync(string key, object? targetValue, TimeSpan timeout, bool requireGoodQuality)' returns a value but is missing . + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.CentralUI/ScriptAnalysis/SandboxScriptHost.cs +LINE: 362 +CATEGORY: MissingParam +SEVERITY: Warning +MEMBER: Method +SIGNATURE: WaitForAsync(string key, Func predicate, TimeSpan timeout, bool requireGoodQuality) +MESSAGE: Method 'WaitForAsync(string key, Func predicate, TimeSpan timeout, bool requireGoodQuality)' is missing documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.CentralUI/ScriptAnalysis/SandboxScriptHost.cs +LINE: 362 +CATEGORY: MissingParam +SEVERITY: Warning +MEMBER: Method +SIGNATURE: WaitForAsync(string key, Func predicate, TimeSpan timeout, bool requireGoodQuality) +MESSAGE: Method 'WaitForAsync(string key, Func predicate, TimeSpan timeout, bool requireGoodQuality)' is missing documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.CentralUI/ScriptAnalysis/SandboxScriptHost.cs +LINE: 362 +CATEGORY: MissingParam +SEVERITY: Warning +MEMBER: Method +SIGNATURE: WaitForAsync(string key, Func predicate, TimeSpan timeout, bool requireGoodQuality) +MESSAGE: Method 'WaitForAsync(string key, Func predicate, TimeSpan timeout, bool requireGoodQuality)' is missing documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.CentralUI/ScriptAnalysis/SandboxScriptHost.cs +LINE: 362 +CATEGORY: MissingParam +SEVERITY: Warning +MEMBER: Method +SIGNATURE: WaitForAsync(string key, Func predicate, TimeSpan timeout, bool requireGoodQuality) +MESSAGE: Method 'WaitForAsync(string key, Func predicate, TimeSpan timeout, bool requireGoodQuality)' is missing documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.CentralUI/ScriptAnalysis/SandboxScriptHost.cs +LINE: 362 +CATEGORY: MissingReturns +SEVERITY: Warning +MEMBER: Method +SIGNATURE: WaitForAsync(string key, Func predicate, TimeSpan timeout, bool requireGoodQuality) +MESSAGE: Method 'WaitForAsync(string key, Func predicate, TimeSpan timeout, bool requireGoodQuality)' returns a value but is missing . + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.CentralUI/Services/ConnectionHealthQueryService.cs +LINE: 18 +CATEGORY: TaskReferenceInComment +SEVERITY: Warning +MEMBER: Comment +SIGNATURE: PLC-1 +MESSAGE: Comment contains 'PLC-1', which looks like a task/issue tracking identifier; tracking IDs should not appear in code documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.CentralUI/Services/PollGate.cs +LINE: 9 +CATEGORY: MissingDoc +SEVERITY: Error +MEMBER: Method +SIGNATURE: TryEnter() +MESSAGE: Method 'TryEnter()' is missing XML documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.CentralUI/Services/PollGate.cs +LINE: 10 +CATEGORY: MissingDoc +SEVERITY: Error +MEMBER: Method +SIGNATURE: Exit() +MESSAGE: Method 'Exit()' is missing XML documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.CLI/AlarmTriggerConfigJson.cs +LINE: 39 +CATEGORY: MissingReturns +SEVERITY: Warning +MEMBER: Method +SIGNATURE: Build(string triggerType, string? attribute, string? matchValue, bool notEquals, double? min, double? max, double? thresholdPerSecond, double? windowSeconds, string? direction, double? loLo, double? lo, double? hi, double? hiHi, string? expression, string? analysisKind) +MESSAGE: Method 'Build(string triggerType, string? attribute, string? matchValue, bool notEquals, double? min, double? max, double? thresholdPerSecond, double? windowSeconds, string? direction, double? loLo, double? lo, double? hi, double? hiHi, string? expression, string? analysisKind)' returns a value but is missing . + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.CLI/Commands/AuditExportHelpers.cs +LINE: 156 +CATEGORY: TaskReferenceInComment +SEVERITY: Warning +MEMBER: Comment +SIGNATURE: non-403 +MESSAGE: Comment contains 'non-403', which looks like a task/issue tracking identifier; tracking IDs should not appear in code documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.CLI/Commands/AuditTreeHelpers.cs +LINE: 25 +CATEGORY: MissingDoc +SEVERITY: Error +MEMBER: Property +SIGNATURE: ExecutionId +MESSAGE: Property 'ExecutionId' is missing XML documentation + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.CLI/Commands/AuditTreeHelpers.cs +LINE: 26 +CATEGORY: MissingDoc +SEVERITY: Error +MEMBER: Property +SIGNATURE: ParentExecutionId +MESSAGE: Property 'ParentExecutionId' is missing XML documentation + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.CLI/Commands/AuditTreeHelpers.cs +LINE: 27 +CATEGORY: MissingDoc +SEVERITY: Error +MEMBER: Property +SIGNATURE: RowCount +MESSAGE: Property 'RowCount' is missing XML documentation + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.CLI/Commands/AuditTreeHelpers.cs +LINE: 28 +CATEGORY: MissingDoc +SEVERITY: Error +MEMBER: Property +SIGNATURE: Channels +MESSAGE: Property 'Channels' is missing XML documentation + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.CLI/Commands/AuditTreeHelpers.cs +LINE: 29 +CATEGORY: MissingDoc +SEVERITY: Error +MEMBER: Property +SIGNATURE: Statuses +MESSAGE: Property 'Statuses' is missing XML documentation + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.CLI/Commands/AuditTreeHelpers.cs +LINE: 30 +CATEGORY: MissingDoc +SEVERITY: Error +MEMBER: Property +SIGNATURE: SourceSiteId +MESSAGE: Property 'SourceSiteId' is missing XML documentation + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.CLI/Commands/AuditTreeHelpers.cs +LINE: 31 +CATEGORY: MissingDoc +SEVERITY: Error +MEMBER: Property +SIGNATURE: SourceInstanceId +MESSAGE: Property 'SourceInstanceId' is missing XML documentation + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.CLI/Commands/AuditTreeHelpers.cs +LINE: 32 +CATEGORY: MissingDoc +SEVERITY: Error +MEMBER: Property +SIGNATURE: FirstOccurredAtUtc +MESSAGE: Property 'FirstOccurredAtUtc' is missing XML documentation + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.CLI/Commands/AuditTreeHelpers.cs +LINE: 33 +CATEGORY: MissingDoc +SEVERITY: Error +MEMBER: Property +SIGNATURE: LastOccurredAtUtc +MESSAGE: Property 'LastOccurredAtUtc' is missing XML documentation + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.CLI/Commands/AuditTreeHelpers.cs +LINE: 127 +CATEGORY: MissingParam +SEVERITY: Warning +MEMBER: Method +SIGNATURE: WriteJson(AuditTreeNodeDto[] nodes, TextWriter output) +MESSAGE: Method 'WriteJson(AuditTreeNodeDto[] nodes, TextWriter output)' is missing documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.CLI/Commands/AuditTreeHelpers.cs +LINE: 127 +CATEGORY: MissingParam +SEVERITY: Warning +MEMBER: Method +SIGNATURE: WriteJson(AuditTreeNodeDto[] nodes, TextWriter output) +MESSAGE: Method 'WriteJson(AuditTreeNodeDto[] nodes, TextWriter output)' is missing documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.CLI/Commands/AuditTreeHelpers.cs +LINE: 138 +CATEGORY: MissingParam +SEVERITY: Warning +MEMBER: Method +SIGNATURE: WriteTable(AuditTreeNodeDto[] nodes, Guid queriedExecutionId, TextWriter output) +MESSAGE: Method 'WriteTable(AuditTreeNodeDto[] nodes, Guid queriedExecutionId, TextWriter output)' is missing documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.CLI/Commands/AuditTreeHelpers.cs +LINE: 138 +CATEGORY: MissingParam +SEVERITY: Warning +MEMBER: Method +SIGNATURE: WriteTable(AuditTreeNodeDto[] nodes, Guid queriedExecutionId, TextWriter output) +MESSAGE: Method 'WriteTable(AuditTreeNodeDto[] nodes, Guid queriedExecutionId, TextWriter output)' is missing documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.CLI/Commands/AuditTreeHelpers.cs +LINE: 138 +CATEGORY: MissingParam +SEVERITY: Warning +MEMBER: Method +SIGNATURE: WriteTable(AuditTreeNodeDto[] nodes, Guid queriedExecutionId, TextWriter output) +MESSAGE: Method 'WriteTable(AuditTreeNodeDto[] nodes, Guid queriedExecutionId, TextWriter output)' is missing documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.CLI/Commands/BundleCommands.cs +LINE: 407 +CATEGORY: TaskReferenceInComment +SEVERITY: Warning +MEMBER: Comment +SIGNATURE: non-403 +MESSAGE: Comment contains 'non-403', which looks like a task/issue tracking identifier; tracking IDs should not appear in code documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.CLI/Commands/CommandHelpers.cs +LINE: 97 +CATEGORY: TaskReferenceInComment +SEVERITY: Warning +MEMBER: Comment +SIGNATURE: exit-2 +MESSAGE: Comment contains 'exit-2', which looks like a task/issue tracking identifier; tracking IDs should not appear in code documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.CLI/Commands/TemplateCommands.cs +LINE: 368 +CATEGORY: MissingParam +SEVERITY: Warning +MEMBER: Method +SIGNATURE: BuildAddAttributeCommand(int templateId, string name, string dataType, string? value, string? description, string? dataSource, bool isLocked, string? elementType) +MESSAGE: Method 'BuildAddAttributeCommand(int templateId, string name, string dataType, string? value, string? description, string? dataSource, bool isLocked, string? elementType)' is missing documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.CLI/Commands/TemplateCommands.cs +LINE: 368 +CATEGORY: MissingParam +SEVERITY: Warning +MEMBER: Method +SIGNATURE: BuildAddAttributeCommand(int templateId, string name, string dataType, string? value, string? description, string? dataSource, bool isLocked, string? elementType) +MESSAGE: Method 'BuildAddAttributeCommand(int templateId, string name, string dataType, string? value, string? description, string? dataSource, bool isLocked, string? elementType)' is missing documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.CLI/Commands/TemplateCommands.cs +LINE: 368 +CATEGORY: MissingParam +SEVERITY: Warning +MEMBER: Method +SIGNATURE: BuildAddAttributeCommand(int templateId, string name, string dataType, string? value, string? description, string? dataSource, bool isLocked, string? elementType) +MESSAGE: Method 'BuildAddAttributeCommand(int templateId, string name, string dataType, string? value, string? description, string? dataSource, bool isLocked, string? elementType)' is missing documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.CLI/Commands/TemplateCommands.cs +LINE: 368 +CATEGORY: MissingParam +SEVERITY: Warning +MEMBER: Method +SIGNATURE: BuildAddAttributeCommand(int templateId, string name, string dataType, string? value, string? description, string? dataSource, bool isLocked, string? elementType) +MESSAGE: Method 'BuildAddAttributeCommand(int templateId, string name, string dataType, string? value, string? description, string? dataSource, bool isLocked, string? elementType)' is missing documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.CLI/Commands/TemplateCommands.cs +LINE: 368 +CATEGORY: MissingParam +SEVERITY: Warning +MEMBER: Method +SIGNATURE: BuildAddAttributeCommand(int templateId, string name, string dataType, string? value, string? description, string? dataSource, bool isLocked, string? elementType) +MESSAGE: Method 'BuildAddAttributeCommand(int templateId, string name, string dataType, string? value, string? description, string? dataSource, bool isLocked, string? elementType)' is missing documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.CLI/Commands/TemplateCommands.cs +LINE: 368 +CATEGORY: MissingParam +SEVERITY: Warning +MEMBER: Method +SIGNATURE: BuildAddAttributeCommand(int templateId, string name, string dataType, string? value, string? description, string? dataSource, bool isLocked, string? elementType) +MESSAGE: Method 'BuildAddAttributeCommand(int templateId, string name, string dataType, string? value, string? description, string? dataSource, bool isLocked, string? elementType)' is missing documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.CLI/Commands/TemplateCommands.cs +LINE: 368 +CATEGORY: MissingParam +SEVERITY: Warning +MEMBER: Method +SIGNATURE: BuildAddAttributeCommand(int templateId, string name, string dataType, string? value, string? description, string? dataSource, bool isLocked, string? elementType) +MESSAGE: Method 'BuildAddAttributeCommand(int templateId, string name, string dataType, string? value, string? description, string? dataSource, bool isLocked, string? elementType)' is missing documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.CLI/Commands/TemplateCommands.cs +LINE: 368 +CATEGORY: MissingParam +SEVERITY: Warning +MEMBER: Method +SIGNATURE: BuildAddAttributeCommand(int templateId, string name, string dataType, string? value, string? description, string? dataSource, bool isLocked, string? elementType) +MESSAGE: Method 'BuildAddAttributeCommand(int templateId, string name, string dataType, string? value, string? description, string? dataSource, bool isLocked, string? elementType)' is missing documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.CLI/Commands/TemplateCommands.cs +LINE: 368 +CATEGORY: MissingReturns +SEVERITY: Warning +MEMBER: Method +SIGNATURE: BuildAddAttributeCommand(int templateId, string name, string dataType, string? value, string? description, string? dataSource, bool isLocked, string? elementType) +MESSAGE: Method 'BuildAddAttributeCommand(int templateId, string name, string dataType, string? value, string? description, string? dataSource, bool isLocked, string? elementType)' returns a value but is missing . + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.CLI/Commands/TemplateCommands.cs +LINE: 378 +CATEGORY: MissingParam +SEVERITY: Warning +MEMBER: Method +SIGNATURE: BuildUpdateAttributeCommand(int attributeId, string name, string dataType, string? value, string? description, string? dataSource, bool isLocked, string? elementType) +MESSAGE: Method 'BuildUpdateAttributeCommand(int attributeId, string name, string dataType, string? value, string? description, string? dataSource, bool isLocked, string? elementType)' is missing documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.CLI/Commands/TemplateCommands.cs +LINE: 378 +CATEGORY: MissingParam +SEVERITY: Warning +MEMBER: Method +SIGNATURE: BuildUpdateAttributeCommand(int attributeId, string name, string dataType, string? value, string? description, string? dataSource, bool isLocked, string? elementType) +MESSAGE: Method 'BuildUpdateAttributeCommand(int attributeId, string name, string dataType, string? value, string? description, string? dataSource, bool isLocked, string? elementType)' is missing documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.CLI/Commands/TemplateCommands.cs +LINE: 378 +CATEGORY: MissingParam +SEVERITY: Warning +MEMBER: Method +SIGNATURE: BuildUpdateAttributeCommand(int attributeId, string name, string dataType, string? value, string? description, string? dataSource, bool isLocked, string? elementType) +MESSAGE: Method 'BuildUpdateAttributeCommand(int attributeId, string name, string dataType, string? value, string? description, string? dataSource, bool isLocked, string? elementType)' is missing documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.CLI/Commands/TemplateCommands.cs +LINE: 378 +CATEGORY: MissingParam +SEVERITY: Warning +MEMBER: Method +SIGNATURE: BuildUpdateAttributeCommand(int attributeId, string name, string dataType, string? value, string? description, string? dataSource, bool isLocked, string? elementType) +MESSAGE: Method 'BuildUpdateAttributeCommand(int attributeId, string name, string dataType, string? value, string? description, string? dataSource, bool isLocked, string? elementType)' is missing documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.CLI/Commands/TemplateCommands.cs +LINE: 378 +CATEGORY: MissingParam +SEVERITY: Warning +MEMBER: Method +SIGNATURE: BuildUpdateAttributeCommand(int attributeId, string name, string dataType, string? value, string? description, string? dataSource, bool isLocked, string? elementType) +MESSAGE: Method 'BuildUpdateAttributeCommand(int attributeId, string name, string dataType, string? value, string? description, string? dataSource, bool isLocked, string? elementType)' is missing documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.CLI/Commands/TemplateCommands.cs +LINE: 378 +CATEGORY: MissingParam +SEVERITY: Warning +MEMBER: Method +SIGNATURE: BuildUpdateAttributeCommand(int attributeId, string name, string dataType, string? value, string? description, string? dataSource, bool isLocked, string? elementType) +MESSAGE: Method 'BuildUpdateAttributeCommand(int attributeId, string name, string dataType, string? value, string? description, string? dataSource, bool isLocked, string? elementType)' is missing documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.CLI/Commands/TemplateCommands.cs +LINE: 378 +CATEGORY: MissingParam +SEVERITY: Warning +MEMBER: Method +SIGNATURE: BuildUpdateAttributeCommand(int attributeId, string name, string dataType, string? value, string? description, string? dataSource, bool isLocked, string? elementType) +MESSAGE: Method 'BuildUpdateAttributeCommand(int attributeId, string name, string dataType, string? value, string? description, string? dataSource, bool isLocked, string? elementType)' is missing documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.CLI/Commands/TemplateCommands.cs +LINE: 378 +CATEGORY: MissingParam +SEVERITY: Warning +MEMBER: Method +SIGNATURE: BuildUpdateAttributeCommand(int attributeId, string name, string dataType, string? value, string? description, string? dataSource, bool isLocked, string? elementType) +MESSAGE: Method 'BuildUpdateAttributeCommand(int attributeId, string name, string dataType, string? value, string? description, string? dataSource, bool isLocked, string? elementType)' is missing documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.CLI/Commands/TemplateCommands.cs +LINE: 378 +CATEGORY: MissingReturns +SEVERITY: Warning +MEMBER: Method +SIGNATURE: BuildUpdateAttributeCommand(int attributeId, string name, string dataType, string? value, string? description, string? dataSource, bool isLocked, string? elementType) +MESSAGE: Method 'BuildUpdateAttributeCommand(int attributeId, string name, string dataType, string? value, string? description, string? dataSource, bool isLocked, string? elementType)' returns a value but is missing . + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.Commons/Interfaces/Kpi/IAuditBacklogProvider.cs +LINE: 32 +CATEGORY: MissingReturns +SEVERITY: Warning +MEMBER: Method +SIGNATURE: GetPendingBacklogTotal() +MESSAGE: Method 'GetPendingBacklogTotal()' returns a value but is missing . + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.Commons/Interfaces/Services/IOperationTrackingStore.cs +LINE: 140 +CATEGORY: TrackingReferenceInComment +SEVERITY: Warning +MEMBER: Comment +SIGNATURE: Task 15 +MESSAGE: Comment contains 'Task 15', which looks like a project tracking reference; bookkeeping references should not appear in code documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.Commons/Messages/Audit/SiteCallRelayMessages.cs +LINE: 64 +CATEGORY: TrackingReferenceInComment +SEVERITY: Warning +MEMBER: Comment +SIGNATURE: Task 14 +MESSAGE: Comment contains 'Task 14', which looks like a project tracking reference; bookkeeping references should not appear in code documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.Commons/Messages/Notification/NotificationOutboxQueries.cs +LINE: 58 +CATEGORY: TrackingReferenceInComment +SEVERITY: Warning +MEMBER: Comment +SIGNATURE: Task 13 +MESSAGE: Comment contains 'Task 13', which looks like a project tracking reference; bookkeeping references should not appear in code documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.Commons/Messages/Notification/NotificationOutboxQueries.cs +LINE: 81 +CATEGORY: TrackingReferenceInComment +SEVERITY: Warning +MEMBER: Comment +SIGNATURE: Task 13 +MESSAGE: Comment contains 'Task 13', which looks like a project tracking reference; bookkeeping references should not appear in code documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.Commons/Types/AttributeValueCodec.cs +LINE: 20 +CATEGORY: MissingParam +SEVERITY: Warning +MEMBER: Method +SIGNATURE: Encode(object? value) +MESSAGE: Method 'Encode(object? value)' is missing documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.Commons/Types/AttributeValueCodec.cs +LINE: 20 +CATEGORY: MissingReturns +SEVERITY: Warning +MEMBER: Method +SIGNATURE: Encode(object? value) +MESSAGE: Method 'Encode(object? value)' returns a value but is missing . + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.Commons/Types/AttributeValueCodec.cs +LINE: 41 +CATEGORY: MissingParam +SEVERITY: Warning +MEMBER: Method +SIGNATURE: Decode(string? value, DataType dataType, DataType? elementType) +MESSAGE: Method 'Decode(string? value, DataType dataType, DataType? elementType)' is missing documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.Commons/Types/AttributeValueCodec.cs +LINE: 41 +CATEGORY: MissingParam +SEVERITY: Warning +MEMBER: Method +SIGNATURE: Decode(string? value, DataType dataType, DataType? elementType) +MESSAGE: Method 'Decode(string? value, DataType dataType, DataType? elementType)' is missing documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.Commons/Types/AttributeValueCodec.cs +LINE: 41 +CATEGORY: MissingParam +SEVERITY: Warning +MEMBER: Method +SIGNATURE: Decode(string? value, DataType dataType, DataType? elementType) +MESSAGE: Method 'Decode(string? value, DataType dataType, DataType? elementType)' is missing documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.Commons/Types/AttributeValueCodec.cs +LINE: 41 +CATEGORY: MissingReturns +SEVERITY: Warning +MEMBER: Method +SIGNATURE: Decode(string? value, DataType dataType, DataType? elementType) +MESSAGE: Method 'Decode(string? value, DataType dataType, DataType? elementType)' returns a value but is missing . + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.Commons/Types/AttributeValueCodec.cs +LINE: 73 +CATEGORY: MissingParam +SEVERITY: Warning +MEMBER: Method +SIGNATURE: ElementClrType(DataType t) +MESSAGE: Method 'ElementClrType(DataType t)' is missing documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.Commons/Types/AttributeValueCodec.cs +LINE: 73 +CATEGORY: MissingReturns +SEVERITY: Warning +MEMBER: Method +SIGNATURE: ElementClrType(DataType t) +MESSAGE: Method 'ElementClrType(DataType t)' returns a value but is missing . + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.Commons/Types/AttributeValueCodec.cs +LINE: 96 +CATEGORY: MissingParam +SEVERITY: Warning +MEMBER: Method +SIGNATURE: CoerceEnumerable(IEnumerable source, DataType elementType) +MESSAGE: Method 'CoerceEnumerable(IEnumerable source, DataType elementType)' is missing documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.Commons/Types/AttributeValueCodec.cs +LINE: 96 +CATEGORY: MissingParam +SEVERITY: Warning +MEMBER: Method +SIGNATURE: CoerceEnumerable(IEnumerable source, DataType elementType) +MESSAGE: Method 'CoerceEnumerable(IEnumerable source, DataType elementType)' is missing documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.Commons/Types/AttributeValueCodec.cs +LINE: 96 +CATEGORY: MissingReturns +SEVERITY: Warning +MEMBER: Method +SIGNATURE: CoerceEnumerable(IEnumerable source, DataType elementType) +MESSAGE: Method 'CoerceEnumerable(IEnumerable source, DataType elementType)' returns a value but is missing . + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.Commons/Types/AttributeValueCodec.cs +LINE: 153 +CATEGORY: MissingParam +SEVERITY: Warning +MEMBER: Method +SIGNATURE: IsValidElementType(DataType t) +MESSAGE: Method 'IsValidElementType(DataType t)' is missing documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.Commons/Types/AttributeValueCodec.cs +LINE: 153 +CATEGORY: MissingReturns +SEVERITY: Warning +MEMBER: Method +SIGNATURE: IsValidElementType(DataType t) +MESSAGE: Method 'IsValidElementType(DataType t)' returns a value but is missing . + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.Commons/Types/Deployment/DeploymentFetchToken.cs +LINE: 14 +CATEGORY: MissingReturns +SEVERITY: Warning +MEMBER: Method +SIGNATURE: Generate() +MESSAGE: Method 'Generate()' returns a value but is missing . + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.Commons/Types/Deployment/DeploymentFetchToken.cs +LINE: 19 +CATEGORY: MissingParam +SEVERITY: Warning +MEMBER: Method +SIGNATURE: ConstantTimeEquals(string a, string b) +MESSAGE: Method 'ConstantTimeEquals(string a, string b)' is missing documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.Commons/Types/Deployment/DeploymentFetchToken.cs +LINE: 19 +CATEGORY: MissingParam +SEVERITY: Warning +MEMBER: Method +SIGNATURE: ConstantTimeEquals(string a, string b) +MESSAGE: Method 'ConstantTimeEquals(string a, string b)' is missing documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.Commons/Types/Deployment/DeploymentFetchToken.cs +LINE: 19 +CATEGORY: MissingReturns +SEVERITY: Warning +MEMBER: Method +SIGNATURE: ConstantTimeEquals(string a, string b) +MESSAGE: Method 'ConstantTimeEquals(string a, string b)' returns a value but is missing . + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.Commons/Types/Enums/AuditKind.cs +LINE: 41 +CATEGORY: TrackingReferenceInComment +SEVERITY: Warning +MEMBER: Comment +SIGNATURE: Task 17 +MESSAGE: Comment contains 'Task 17', which looks like a project tracking reference; bookkeeping references should not appear in code documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.Commons/Types/OverrideCsvParser.cs +LINE: 41 +CATEGORY: MissingParam +SEVERITY: Warning +MEMBER: Method +SIGNATURE: Parse(string csvText) +MESSAGE: Method 'Parse(string csvText)' is missing documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.Commons/Types/OverrideCsvParser.cs +LINE: 41 +CATEGORY: MissingReturns +SEVERITY: Warning +MEMBER: Method +SIGNATURE: Parse(string csvText) +MESSAGE: Method 'Parse(string csvText)' returns a value but is missing . + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.Commons/Types/PurgeTimerSchedule.cs +LINE: 31 +CATEGORY: MissingParam +SEVERITY: Warning +MEMBER: Method +SIGNATURE: InitialDelay(TimeSpan interval) +MESSAGE: Method 'InitialDelay(TimeSpan interval)' is missing documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.Commons/Types/PurgeTimerSchedule.cs +LINE: 31 +CATEGORY: MissingReturns +SEVERITY: Warning +MEMBER: Method +SIGNATURE: InitialDelay(TimeSpan interval) +MESSAGE: Method 'InitialDelay(TimeSpan interval)' returns a value but is missing . + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.Communication/Actors/CentralCommunicationActor.cs +LINE: 57 +CATEGORY: MissingParam +SEVERITY: Warning +MEMBER: Method +SIGNATURE: SanitizeForActorName(string siteId) +MESSAGE: Method 'SanitizeForActorName(string siteId)' is missing documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.Communication/Actors/CentralCommunicationActor.cs +LINE: 57 +CATEGORY: MissingReturns +SEVERITY: Warning +MEMBER: Method +SIGNATURE: SanitizeForActorName(string siteId) +MESSAGE: Method 'SanitizeForActorName(string siteId)' returns a value but is missing . + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.Communication/Actors/CentralCommunicationActor.cs +LINE: 151 +CATEGORY: TrackingReferenceInComment +SEVERITY: Warning +MEMBER: Comment +SIGNATURE: #1 +MESSAGE: Comment contains '#1', which looks like a project tracking reference; bookkeeping references should not appear in code documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.Communication/Grpc/SiteStreamGrpcServer.cs +LINE: 43 +CATEGORY: TaskReferenceInComment +SEVERITY: Warning +MEMBER: Comment +SIGNATURE: sub-100 +MESSAGE: Comment contains 'sub-100', which looks like a task/issue tracking identifier; tracking IDs should not appear in code documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.Communication/Grpc/SiteStreamGrpcServer.cs +LINE: 564 +CATEGORY: TrackingReferenceInComment +SEVERITY: Warning +MEMBER: Comment +SIGNATURE: Task 15 +MESSAGE: Comment contains 'Task 15', which looks like a project tracking reference; bookkeeping references should not appear in code documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.ConfigurationDatabase/Configurations/NotificationConfiguration.cs +LINE: 61 +CATEGORY: InheritDocMisused +SEVERITY: Error +MEMBER: Method +SIGNATURE: Configure(EntityTypeBuilder builder) +MESSAGE: Method 'Configure(EntityTypeBuilder builder)' uses but has nothing to inherit (not an override or interface implementation). + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.ConfigurationDatabase/Configurations/NotificationConfiguration.cs +LINE: 130 +CATEGORY: TrackingReferenceInComment +SEVERITY: Warning +MEMBER: Comment +SIGNATURE: M365 +MESSAGE: Comment contains 'M365', which looks like a project tracking reference; bookkeeping references should not appear in code documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.ConfigurationDatabase/Repositories/AuditLogRepository.cs +LINE: 232 +CATEGORY: TrackingReferenceInComment +SEVERITY: Warning +MEMBER: Comment +SIGNATURE: Task 12 +MESSAGE: Comment contains 'Task 12', which looks like a project tracking reference; bookkeeping references should not appear in code documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.ConfigurationDatabase/Repositories/SiteCallAuditRepository.cs +LINE: 32 +CATEGORY: TrackingReferenceInComment +SEVERITY: Warning +MEMBER: Comment +SIGNATURE: Task 11 +MESSAGE: Comment contains 'Task 11', which looks like a project tracking reference; bookkeeping references should not appear in code documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.ConfigurationDatabase/Repositories/SiteCallAuditRepository.cs +LINE: 113 +CATEGORY: TrackingReferenceInComment +SEVERITY: Warning +MEMBER: Comment +SIGNATURE: Task 11 +MESSAGE: Comment contains 'Task 11', which looks like a project tracking reference; bookkeeping references should not appear in code documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.ConfigurationDatabase/ServiceCollectionExtensions.cs +LINE: 33 +CATEGORY: TrackingReferenceInComment +SEVERITY: Warning +MEMBER: Comment +SIGNATURE: Task 12 +MESSAGE: Comment contains 'Task 12', which looks like a project tracking reference; bookkeeping references should not appear in code documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.DataConnectionLayer/Adapters/IOpcUaClient.cs +LINE: 195 +CATEGORY: MissingParam +SEVERITY: Warning +MEMBER: Method +SIGNATURE: SearchAsync(Func> browse, string query, int maxDepth, int maxResults, CancellationToken cancellationToken) +MESSAGE: Method 'SearchAsync(Func> browse, string query, int maxDepth, int maxResults, CancellationToken cancellationToken)' is missing documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.DataConnectionLayer/Adapters/IOpcUaClient.cs +LINE: 195 +CATEGORY: MissingParam +SEVERITY: Warning +MEMBER: Method +SIGNATURE: SearchAsync(Func> browse, string query, int maxDepth, int maxResults, CancellationToken cancellationToken) +MESSAGE: Method 'SearchAsync(Func> browse, string query, int maxDepth, int maxResults, CancellationToken cancellationToken)' is missing documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.DataConnectionLayer/Adapters/IOpcUaClient.cs +LINE: 195 +CATEGORY: MissingParam +SEVERITY: Warning +MEMBER: Method +SIGNATURE: SearchAsync(Func> browse, string query, int maxDepth, int maxResults, CancellationToken cancellationToken) +MESSAGE: Method 'SearchAsync(Func> browse, string query, int maxDepth, int maxResults, CancellationToken cancellationToken)' is missing documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.DataConnectionLayer/Adapters/IOpcUaClient.cs +LINE: 195 +CATEGORY: MissingParam +SEVERITY: Warning +MEMBER: Method +SIGNATURE: SearchAsync(Func> browse, string query, int maxDepth, int maxResults, CancellationToken cancellationToken) +MESSAGE: Method 'SearchAsync(Func> browse, string query, int maxDepth, int maxResults, CancellationToken cancellationToken)' is missing documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.DataConnectionLayer/Adapters/IOpcUaClient.cs +LINE: 195 +CATEGORY: MissingParam +SEVERITY: Warning +MEMBER: Method +SIGNATURE: SearchAsync(Func> browse, string query, int maxDepth, int maxResults, CancellationToken cancellationToken) +MESSAGE: Method 'SearchAsync(Func> browse, string query, int maxDepth, int maxResults, CancellationToken cancellationToken)' is missing documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.DataConnectionLayer/Adapters/IOpcUaClient.cs +LINE: 195 +CATEGORY: MissingReturns +SEVERITY: Warning +MEMBER: Method +SIGNATURE: SearchAsync(Func> browse, string query, int maxDepth, int maxResults, CancellationToken cancellationToken) +MESSAGE: Method 'SearchAsync(Func> browse, string query, int maxDepth, int maxResults, CancellationToken cancellationToken)' returns a value but is missing . + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.DataConnectionLayer/Adapters/MxGatewayAlarmMapper.cs +LINE: 78 +CATEGORY: MissingParam +SEVERITY: Warning +MEMBER: Method +SIGNATURE: MxValueToString(MxValue? mxVal) +MESSAGE: Method 'MxValueToString(MxValue? mxVal)' is missing documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.DataConnectionLayer/Adapters/MxGatewayAlarmMapper.cs +LINE: 78 +CATEGORY: MissingReturns +SEVERITY: Warning +MEMBER: Method +SIGNATURE: MxValueToString(MxValue? mxVal) +MESSAGE: Method 'MxValueToString(MxValue? mxVal)' returns a value but is missing . + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.DataConnectionLayer/Adapters/RealOpcUaClient.cs +LINE: 1011 +CATEGORY: TaskReferenceInComment +SEVERITY: Warning +MEMBER: Comment +SIGNATURE: cap-0 +MESSAGE: Comment contains 'cap-0', which looks like a task/issue tracking identifier; tracking IDs should not appear in code documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.DelmiaNotifier/ArgParser.cs +LINE: 6 +CATEGORY: MissingDoc +SEVERITY: Error +MEMBER: Method +SIGNATURE: Success(RecipeDownload payload) +MESSAGE: Method 'Success(RecipeDownload payload)' is missing XML documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.DelmiaNotifier/ArgParser.cs +LINE: 7 +CATEGORY: MissingDoc +SEVERITY: Error +MEMBER: Method +SIGNATURE: Fail(string error) +MESSAGE: Method 'Fail(string error)' is missing XML documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.DelmiaNotifier/ArgParser.cs +LINE: 16 +CATEGORY: MissingDoc +SEVERITY: Error +MEMBER: Method +SIGNATURE: Parse(string[] args) +MESSAGE: Method 'Parse(string[] args)' is missing XML documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.DelmiaNotifier/ConfigLoader.cs +LINE: 11 +CATEGORY: MissingParam +SEVERITY: Warning +MEMBER: Method +SIGNATURE: Load(string jsonText) +MESSAGE: Method 'Load(string jsonText)' is missing documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.DelmiaNotifier/ConfigLoader.cs +LINE: 11 +CATEGORY: MissingReturns +SEVERITY: Warning +MEMBER: Method +SIGNATURE: Load(string jsonText) +MESSAGE: Method 'Load(string jsonText)' returns a value but is missing . + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.DelmiaNotifier/ConfigLoader.cs +LINE: 15 +CATEGORY: MissingReturns +SEVERITY: Warning +MEMBER: Method +SIGNATURE: LoadFromDefaultFile() +MESSAGE: Method 'LoadFromDefaultFile()' returns a value but is missing . + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.DelmiaNotifier/ConfigLoader.cs +LINE: 22 +CATEGORY: MissingParam +SEVERITY: Warning +MEMBER: Method +SIGNATURE: SplitBaseUrls(string? baseUrls) +MESSAGE: Method 'SplitBaseUrls(string? baseUrls)' is missing documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.DelmiaNotifier/ConfigLoader.cs +LINE: 22 +CATEGORY: MissingReturns +SEVERITY: Warning +MEMBER: Method +SIGNATURE: SplitBaseUrls(string? baseUrls) +MESSAGE: Method 'SplitBaseUrls(string? baseUrls)' returns a value but is missing . + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.DelmiaNotifier/ConfigLoader.cs +LINE: 33 +CATEGORY: MissingParam +SEVERITY: Warning +MEMBER: Method +SIGNATURE: ResolveApiKey(Func envGet) +MESSAGE: Method 'ResolveApiKey(Func envGet)' is missing documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.DelmiaNotifier/ConfigLoader.cs +LINE: 33 +CATEGORY: MissingReturns +SEVERITY: Warning +MEMBER: Method +SIGNATURE: ResolveApiKey(Func envGet) +MESSAGE: Method 'ResolveApiKey(Func envGet)' returns a value but is missing . + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.DelmiaNotifier/DiagLog.cs +LINE: 13 +CATEGORY: MissingDoc +SEVERITY: Error +MEMBER: Method +SIGNATURE: Write(string message) +MESSAGE: Method 'Write(string message)' is missing XML documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.DelmiaNotifier/HttpRecipeSender.cs +LINE: 15 +CATEGORY: MissingDoc +SEVERITY: Error +MEMBER: Method +SIGNATURE: SendAsync(string baseUrl, RecipeDownload payload, CancellationToken ct) +MESSAGE: Method 'SendAsync(string baseUrl, RecipeDownload payload, CancellationToken ct)' is missing XML documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.DelmiaNotifier/IRecipeSender.cs +LINE: 20 +CATEGORY: MissingDoc +SEVERITY: Error +MEMBER: Method +SIGNATURE: SendAsync(string baseUrl, RecipeDownload payload, CancellationToken ct) +MESSAGE: Method 'SendAsync(string baseUrl, RecipeDownload payload, CancellationToken ct)' is missing XML documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.DelmiaNotifier/Notifier.cs +LINE: 13 +CATEGORY: MissingDoc +SEVERITY: Error +MEMBER: Method +SIGNATURE: RunAsync(string[] baseUrls, RecipeDownload payload, IRecipeSender sender, CancellationToken ct) +MESSAGE: Method 'RunAsync(string[] baseUrls, RecipeDownload payload, IRecipeSender sender, CancellationToken ct)' is missing XML documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.DelmiaNotifier/NotifierConfig.cs +LINE: 6 +CATEGORY: MissingDoc +SEVERITY: Error +MEMBER: Property +SIGNATURE: ScadaBridge +MESSAGE: Property 'ScadaBridge' is missing XML documentation + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.DelmiaNotifier/Program.cs +LINE: 5 +CATEGORY: MissingDoc +SEVERITY: Error +MEMBER: Method +SIGNATURE: Main(string[] args) +MESSAGE: Method 'Main(string[] args)' is missing XML documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.DelmiaNotifier/Program.cs +LINE: 64 +CATEGORY: MissingDoc +SEVERITY: Error +MEMBER: Method +SIGNATURE: SendAsync(string baseUrl, RecipeDownload payload, CancellationToken ct) +MESSAGE: Method 'SendAsync(string baseUrl, RecipeDownload payload, CancellationToken ct)' is missing XML documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.DelmiaNotifier/RecipeDownload.cs +LINE: 5 +CATEGORY: MissingDoc +SEVERITY: Error +MEMBER: Property +SIGNATURE: MachineCode +MESSAGE: Property 'MachineCode' is missing XML documentation + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.DelmiaNotifier/RecipeDownload.cs +LINE: 6 +CATEGORY: MissingDoc +SEVERITY: Error +MEMBER: Property +SIGNATURE: DownloadPath +MESSAGE: Property 'DownloadPath' is missing XML documentation + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.DelmiaNotifier/RecipeDownload.cs +LINE: 7 +CATEGORY: MissingDoc +SEVERITY: Error +MEMBER: Property +SIGNATURE: WorkOrderNumber +MESSAGE: Property 'WorkOrderNumber' is missing XML documentation + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.DelmiaNotifier/RecipeDownload.cs +LINE: 8 +CATEGORY: MissingDoc +SEVERITY: Error +MEMBER: Property +SIGNATURE: PartNumber +MESSAGE: Property 'PartNumber' is missing XML documentation + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.DelmiaNotifier/RecipeDownload.cs +LINE: 9 +CATEGORY: MissingDoc +SEVERITY: Error +MEMBER: Property +SIGNATURE: JobStepNumber +MESSAGE: Property 'JobStepNumber' is missing XML documentation + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.DelmiaNotifier/RecipeDownload.cs +LINE: 10 +CATEGORY: MissingDoc +SEVERITY: Error +MEMBER: Property +SIGNATURE: Username +MESSAGE: Property 'Username' is missing XML documentation + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.DelmiaNotifier/RecipeDownloadResult.cs +LINE: 5 +CATEGORY: MissingDoc +SEVERITY: Error +MEMBER: Property +SIGNATURE: Result +MESSAGE: Property 'Result' is missing XML documentation + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.DelmiaNotifier/RecipeDownloadResult.cs +LINE: 6 +CATEGORY: MissingDoc +SEVERITY: Error +MEMBER: Property +SIGNATURE: ResultText +MESSAGE: Property 'ResultText' is missing XML documentation + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.DelmiaNotifier/Reporter.cs +LINE: 10 +CATEGORY: MissingDoc +SEVERITY: Error +MEMBER: Method +SIGNATURE: Report(bool ok, string reason, TextWriter stdout) +MESSAGE: Method 'Report(bool ok, string reason, TextWriter stdout)' is missing XML documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.ExternalSystemGateway/ErrorClassifier.cs +LINE: 49 +CATEGORY: MissingParam +SEVERITY: Warning +MEMBER: Method +SIGNATURE: IsTransient(Exception exception, CancellationToken cancellationToken) +MESSAGE: Method 'IsTransient(Exception exception, CancellationToken cancellationToken)' is missing documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.ExternalSystemGateway/ErrorClassifier.cs +LINE: 49 +CATEGORY: MissingParam +SEVERITY: Warning +MEMBER: Method +SIGNATURE: IsTransient(Exception exception, CancellationToken cancellationToken) +MESSAGE: Method 'IsTransient(Exception exception, CancellationToken cancellationToken)' is missing documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.ExternalSystemGateway/ErrorClassifier.cs +LINE: 49 +CATEGORY: MissingReturns +SEVERITY: Warning +MEMBER: Method +SIGNATURE: IsTransient(Exception exception, CancellationToken cancellationToken) +MESSAGE: Method 'IsTransient(Exception exception, CancellationToken cancellationToken)' returns a value but is missing . + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.HealthMonitoring/CentralHealthAggregator.cs +LINE: 113 +CATEGORY: TaskReferenceInComment +SEVERITY: Warning +MEMBER: Comment +SIGNATURE: year-0001 +MESSAGE: Comment contains 'year-0001', which looks like a task/issue tracking identifier; tracking IDs should not appear in code documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.HealthMonitoring/IHealthReportTransport.cs +LINE: 22 +CATEGORY: MissingReturns +SEVERITY: Warning +MEMBER: Method +SIGNATURE: SendAsync(SiteHealthReport report, CancellationToken cancellationToken) +MESSAGE: Method 'SendAsync(SiteHealthReport report, CancellationToken cancellationToken)' returns a value but is missing . + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.HealthMonitoring/ServiceCollectionExtensions.cs +LINE: 66 +CATEGORY: TrackingReferenceInComment +SEVERITY: Warning +MEMBER: Comment +SIGNATURE: Task 10 +MESSAGE: Comment contains 'Task 10', which looks like a project tracking reference; bookkeeping references should not appear in code documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.HealthMonitoring/SiteHealthState.cs +LINE: 29 +CATEGORY: TaskReferenceInComment +SEVERITY: Warning +MEMBER: Comment +SIGNATURE: year-0001 +MESSAGE: Comment contains 'year-0001', which looks like a task/issue tracking identifier; tracking IDs should not appear in code documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.Host/Actors/AkkaHostedService.cs +LINE: 86 +CATEGORY: MissingParam +SEVERITY: Warning +MEMBER: Constructor +SIGNATURE: AkkaHostedService(IServiceProvider serviceProvider, IOptions nodeOptions, IOptions clusterOptions, IOptions communicationOptions, ILogger logger, IHostApplicationLifetime? appLifetime) +MESSAGE: Constructor 'AkkaHostedService(IServiceProvider serviceProvider, IOptions nodeOptions, IOptions clusterOptions, IOptions communicationOptions, ILogger logger, IHostApplicationLifetime? appLifetime)' is missing documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.Host/Actors/AkkaHostedService.cs +LINE: 208 +CATEGORY: TrackingReferenceInComment +SEVERITY: Warning +MEMBER: Comment +SIGNATURE: #2 +MESSAGE: Comment contains '#2', which looks like a project tracking reference; bookkeeping references should not appear in code documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.Host/Actors/AkkaHostedService.cs +LINE: 865 +CATEGORY: TrackingReferenceInComment +SEVERITY: Warning +MEMBER: Comment +SIGNATURE: #2 +MESSAGE: Comment contains '#2', which looks like a project tracking reference; bookkeeping references should not appear in code documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.Host/Actors/CentralSingletonRegistrar.cs +LINE: 20 +CATEGORY: MissingDoc +SEVERITY: Error +MEMBER: Method +SIGNATURE: Start(ActorSystem system, string name, Props singletonProps, ILogger logger, TimeSpan? drainTimeout) +MESSAGE: Method 'Start(ActorSystem system, string name, Props singletonProps, ILogger logger, TimeSpan? drainTimeout)' is missing XML documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.Host/Health/ClusterActivityEvaluator.cs +LINE: 17 +CATEGORY: MissingParam +SEVERITY: Warning +MEMBER: Method +SIGNATURE: SelfIsOldest(Cluster cluster, string? role) +MESSAGE: Method 'SelfIsOldest(Cluster cluster, string? role)' is missing documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.Host/Health/ClusterActivityEvaluator.cs +LINE: 17 +CATEGORY: MissingParam +SEVERITY: Warning +MEMBER: Method +SIGNATURE: SelfIsOldest(Cluster cluster, string? role) +MESSAGE: Method 'SelfIsOldest(Cluster cluster, string? role)' is missing documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.Host/Health/ClusterActivityEvaluator.cs +LINE: 17 +CATEGORY: MissingReturns +SEVERITY: Warning +MEMBER: Method +SIGNATURE: SelfIsOldest(Cluster cluster, string? role) +MESSAGE: Method 'SelfIsOldest(Cluster cluster, string? role)' returns a value but is missing . + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.Host/Health/ClusterActivityEvaluator.cs +LINE: 32 +CATEGORY: MissingParam +SEVERITY: Warning +MEMBER: Method +SIGNATURE: OldestUpMember(Cluster cluster, string? role) +MESSAGE: Method 'OldestUpMember(Cluster cluster, string? role)' is missing documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.Host/Health/ClusterActivityEvaluator.cs +LINE: 32 +CATEGORY: MissingParam +SEVERITY: Warning +MEMBER: Method +SIGNATURE: OldestUpMember(Cluster cluster, string? role) +MESSAGE: Method 'OldestUpMember(Cluster cluster, string? role)' is missing documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.Host/Health/ClusterActivityEvaluator.cs +LINE: 32 +CATEGORY: MissingReturns +SEVERITY: Warning +MEMBER: Method +SIGNATURE: OldestUpMember(Cluster cluster, string? role) +MESSAGE: Method 'OldestUpMember(Cluster cluster, string? role)' returns a value but is missing . + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.Host/Health/OldestNodeActiveHealthCheck.cs +LINE: 24 +CATEGORY: InheritDocMisused +SEVERITY: Error +MEMBER: Method +SIGNATURE: CheckHealthAsync(HealthCheckContext context, CancellationToken ct) +MESSAGE: Method 'CheckHealthAsync(HealthCheckContext context, CancellationToken ct)' uses but has nothing to inherit (not an override or interface implementation). + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.Host/Health/RequiredSingletonsHealthCheck.cs +LINE: 98 +CATEGORY: InheritDocMisused +SEVERITY: Error +MEMBER: Method +SIGNATURE: CheckHealthAsync(HealthCheckContext context, CancellationToken cancellationToken) +MESSAGE: Method 'CheckHealthAsync(HealthCheckContext context, CancellationToken cancellationToken)' uses but has nothing to inherit (not an override or interface implementation). + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.Host/Program.cs +LINE: 58 +CATEGORY: TaskReferenceInComment +SEVERITY: Warning +MEMBER: Comment +SIGNATURE: HOST-8 +MESSAGE: Comment contains 'HOST-8', which looks like a task/issue tracking identifier; tracking IDs should not appear in code documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.Host/Program.cs +LINE: 95 +CATEGORY: TrackingReferenceInComment +SEVERITY: Warning +MEMBER: Comment +SIGNATURE: #05 +MESSAGE: Comment contains '#05', which looks like a project tracking reference; bookkeeping references should not appear in code documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.Host/Program.cs +LINE: 414 +CATEGORY: TrackingReferenceInComment +SEVERITY: Warning +MEMBER: Comment +SIGNATURE: Task 7 +MESSAGE: Comment contains 'Task 7', which looks like a project tracking reference; bookkeeping references should not appear in code documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.Host/Program.cs +LINE: 414 +CATEGORY: TaskReferenceInComment +SEVERITY: Warning +MEMBER: Comment +SIGNATURE: PLAN-06 +MESSAGE: Comment contains 'PLAN-06', which looks like a task/issue tracking identifier; tracking IDs should not appear in code documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.Host/Program.cs +LINE: 480 +CATEGORY: TaskReferenceInComment +SEVERITY: Warning +MEMBER: Comment +SIGNATURE: HOST-7 +MESSAGE: Comment contains 'HOST-7', which looks like a task/issue tracking identifier; tracking IDs should not appear in code documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.Host/Services/InProcessScriptArtifactChangeBus.cs +LINE: 96 +CATEGORY: MissingDoc +SEVERITY: Error +MEMBER: Constructor +SIGNATURE: Subscription(InProcessScriptArtifactChangeBus bus, Action handler) +MESSAGE: Constructor 'Subscription(InProcessScriptArtifactChangeBus bus, Action handler)' is missing XML documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.Host/Services/InProcessScriptArtifactChangeBus.cs +LINE: 102 +CATEGORY: MissingDoc +SEVERITY: Error +MEMBER: Method +SIGNATURE: Dispose() +MESSAGE: Method 'Dispose()' is missing XML documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.InboundAPI/ParameterValidator.cs +LINE: 53 +CATEGORY: TaskReferenceInComment +SEVERITY: Warning +MEMBER: Comment +SIGNATURE: runtime-400 +MESSAGE: Comment contains 'runtime-400', which looks like a task/issue tracking identifier; tracking IDs should not appear in code documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.ManagementService/ConfigSecretScrubber.cs +LINE: 38 +CATEGORY: MissingParam +SEVERITY: Warning +MEMBER: Method +SIGNATURE: Scrub(string? json) +MESSAGE: Method 'Scrub(string? json)' is missing documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.ManagementService/ConfigSecretScrubber.cs +LINE: 38 +CATEGORY: MissingReturns +SEVERITY: Warning +MEMBER: Method +SIGNATURE: Scrub(string? json) +MESSAGE: Method 'Scrub(string? json)' returns a value but is missing . + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.ManagementService/ConfigSecretScrubber.cs +LINE: 125 +CATEGORY: MissingParam +SEVERITY: Warning +MEMBER: Method +SIGNATURE: MergeSentinels(string? incoming, string? stored) +MESSAGE: Method 'MergeSentinels(string? incoming, string? stored)' is missing documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.ManagementService/ConfigSecretScrubber.cs +LINE: 125 +CATEGORY: MissingParam +SEVERITY: Warning +MEMBER: Method +SIGNATURE: MergeSentinels(string? incoming, string? stored) +MESSAGE: Method 'MergeSentinels(string? incoming, string? stored)' is missing documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.ManagementService/ConfigSecretScrubber.cs +LINE: 125 +CATEGORY: MissingReturns +SEVERITY: Warning +MEMBER: Method +SIGNATURE: MergeSentinels(string? incoming, string? stored) +MESSAGE: Method 'MergeSentinels(string? incoming, string? stored)' returns a value but is missing . + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.ManagementService/ManagementActor.cs +LINE: 193 +CATEGORY: MissingParam +SEVERITY: Warning +MEMBER: Method +SIGNATURE: GetRequiredRoles(object command) +MESSAGE: Method 'GetRequiredRoles(object command)' is missing documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.ManagementService/ManagementActor.cs +LINE: 193 +CATEGORY: MissingReturns +SEVERITY: Warning +MEMBER: Method +SIGNATURE: GetRequiredRoles(object command) +MESSAGE: Method 'GetRequiredRoles(object command)' returns a value but is missing . + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.ManagementService/ManagementActor.cs +LINE: 2032 +CATEGORY: TrackingReferenceInComment +SEVERITY: Warning +MEMBER: Comment +SIGNATURE: M365 +MESSAGE: Comment contains 'M365', which looks like a project tracking reference; bookkeeping references should not appear in code documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.NotificationOutbox/Delivery/EmailNotificationDeliveryAdapter.cs +LINE: 206 +CATEGORY: TrackingReferenceInComment +SEVERITY: Warning +MEMBER: Comment +SIGNATURE: M365 +MESSAGE: Comment contains 'M365', which looks like a project tracking reference; bookkeeping references should not appear in code documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.NotificationOutbox/NotificationOutboxActor.cs +LINE: 821 +CATEGORY: TrackingReferenceInComment +SEVERITY: Warning +MEMBER: Comment +SIGNATURE: Task 13 +MESSAGE: Comment contains 'Task 13', which looks like a project tracking reference; bookkeeping references should not appear in code documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.NotificationOutbox/NotificationOutboxActor.cs +LINE: 1106 +CATEGORY: TrackingReferenceInComment +SEVERITY: Warning +MEMBER: Comment +SIGNATURE: Task 13 +MESSAGE: Comment contains 'Task 13', which looks like a project tracking reference; bookkeeping references should not appear in code documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.NotificationOutbox/NotificationOutboxActor.cs +LINE: 1181 +CATEGORY: TrackingReferenceInComment +SEVERITY: Warning +MEMBER: Comment +SIGNATURE: Task 13 +MESSAGE: Comment contains 'Task 13', which looks like a project tracking reference; bookkeeping references should not appear in code documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.NotificationOutbox/SmsOptions.cs +LINE: 44 +CATEGORY: InheritDocMisused +SEVERITY: Error +MEMBER: Method +SIGNATURE: Validate(string? name, SmsOptions options) +MESSAGE: Method 'Validate(string? name, SmsOptions options)' uses but has nothing to inherit (not an override or interface implementation). + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.NotificationService/MailKitSmtpClientWrapper.cs +LINE: 9 +CATEGORY: TrackingReferenceInComment +SEVERITY: Warning +MEMBER: Comment +SIGNATURE: M365 +MESSAGE: Comment contains 'M365', which looks like a project tracking reference; bookkeeping references should not appear in code documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.NotificationService/MailKitSmtpClientWrapper.cs +LINE: 113 +CATEGORY: TrackingReferenceInComment +SEVERITY: Warning +MEMBER: Comment +SIGNATURE: M365 +MESSAGE: Comment contains 'M365', which looks like a project tracking reference; bookkeeping references should not appear in code documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.NotificationService/OAuth2TokenService.cs +LINE: 89 +CATEGORY: TrackingReferenceInComment +SEVERITY: Warning +MEMBER: Comment +SIGNATURE: M365 +MESSAGE: Comment contains 'M365', which looks like a project tracking reference; bookkeeping references should not appear in code documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.NotificationService/OAuth2TokenService.cs +LINE: 95 +CATEGORY: TrackingReferenceInComment +SEVERITY: Warning +MEMBER: Comment +SIGNATURE: M365 +MESSAGE: Comment contains 'M365', which looks like a project tracking reference; bookkeeping references should not appear in code documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.ScriptAnalysis/ScriptCompileSurface.cs +LINE: 71 +CATEGORY: MissingParam +SEVERITY: Warning +MEMBER: Method +SIGNATURE: GetAttribute(string attributeName) +MESSAGE: Method 'GetAttribute(string attributeName)' is missing documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.ScriptAnalysis/ScriptCompileSurface.cs +LINE: 71 +CATEGORY: MissingReturns +SEVERITY: Warning +MEMBER: Method +SIGNATURE: GetAttribute(string attributeName) +MESSAGE: Method 'GetAttribute(string attributeName)' returns a value but is missing . + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.ScriptAnalysis/ScriptCompileSurface.cs +LINE: 74 +CATEGORY: MissingParam +SEVERITY: Warning +MEMBER: Method +SIGNATURE: SetAttribute(string attributeName, string value) +MESSAGE: Method 'SetAttribute(string attributeName, string value)' is missing documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.ScriptAnalysis/ScriptCompileSurface.cs +LINE: 74 +CATEGORY: MissingParam +SEVERITY: Warning +MEMBER: Method +SIGNATURE: SetAttribute(string attributeName, string value) +MESSAGE: Method 'SetAttribute(string attributeName, string value)' is missing documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.ScriptAnalysis/ScriptCompileSurface.cs +LINE: 74 +CATEGORY: MissingReturns +SEVERITY: Warning +MEMBER: Method +SIGNATURE: SetAttribute(string attributeName, string value) +MESSAGE: Method 'SetAttribute(string attributeName, string value)' returns a value but is missing . + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.ScriptAnalysis/ScriptCompileSurface.cs +LINE: 77 +CATEGORY: MissingParam +SEVERITY: Warning +MEMBER: Method +SIGNATURE: CallScript(string scriptName, object? parameters) +MESSAGE: Method 'CallScript(string scriptName, object? parameters)' is missing documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.ScriptAnalysis/ScriptCompileSurface.cs +LINE: 77 +CATEGORY: MissingParam +SEVERITY: Warning +MEMBER: Method +SIGNATURE: CallScript(string scriptName, object? parameters) +MESSAGE: Method 'CallScript(string scriptName, object? parameters)' is missing documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.ScriptAnalysis/ScriptCompileSurface.cs +LINE: 77 +CATEGORY: MissingReturns +SEVERITY: Warning +MEMBER: Method +SIGNATURE: CallScript(string scriptName, object? parameters) +MESSAGE: Method 'CallScript(string scriptName, object? parameters)' returns a value but is missing . + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.ScriptAnalysis/ScriptCompileSurface.cs +LINE: 99 +CATEGORY: MissingParam +SEVERITY: Warning +MEMBER: Method +SIGNATURE: Call(string systemName, string methodName, IReadOnlyDictionary? parameters, CancellationToken cancellationToken) +MESSAGE: Method 'Call(string systemName, string methodName, IReadOnlyDictionary? parameters, CancellationToken cancellationToken)' is missing documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.ScriptAnalysis/ScriptCompileSurface.cs +LINE: 99 +CATEGORY: MissingParam +SEVERITY: Warning +MEMBER: Method +SIGNATURE: Call(string systemName, string methodName, IReadOnlyDictionary? parameters, CancellationToken cancellationToken) +MESSAGE: Method 'Call(string systemName, string methodName, IReadOnlyDictionary? parameters, CancellationToken cancellationToken)' is missing documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.ScriptAnalysis/ScriptCompileSurface.cs +LINE: 99 +CATEGORY: MissingParam +SEVERITY: Warning +MEMBER: Method +SIGNATURE: Call(string systemName, string methodName, IReadOnlyDictionary? parameters, CancellationToken cancellationToken) +MESSAGE: Method 'Call(string systemName, string methodName, IReadOnlyDictionary? parameters, CancellationToken cancellationToken)' is missing documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.ScriptAnalysis/ScriptCompileSurface.cs +LINE: 99 +CATEGORY: MissingParam +SEVERITY: Warning +MEMBER: Method +SIGNATURE: Call(string systemName, string methodName, IReadOnlyDictionary? parameters, CancellationToken cancellationToken) +MESSAGE: Method 'Call(string systemName, string methodName, IReadOnlyDictionary? parameters, CancellationToken cancellationToken)' is missing documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.ScriptAnalysis/ScriptCompileSurface.cs +LINE: 99 +CATEGORY: MissingReturns +SEVERITY: Warning +MEMBER: Method +SIGNATURE: Call(string systemName, string methodName, IReadOnlyDictionary? parameters, CancellationToken cancellationToken) +MESSAGE: Method 'Call(string systemName, string methodName, IReadOnlyDictionary? parameters, CancellationToken cancellationToken)' returns a value but is missing . + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.ScriptAnalysis/ScriptCompileSurface.cs +LINE: 107 +CATEGORY: MissingParam +SEVERITY: Warning +MEMBER: Method +SIGNATURE: CachedCall(string systemName, string methodName, IReadOnlyDictionary? parameters, CancellationToken cancellationToken) +MESSAGE: Method 'CachedCall(string systemName, string methodName, IReadOnlyDictionary? parameters, CancellationToken cancellationToken)' is missing documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.ScriptAnalysis/ScriptCompileSurface.cs +LINE: 107 +CATEGORY: MissingParam +SEVERITY: Warning +MEMBER: Method +SIGNATURE: CachedCall(string systemName, string methodName, IReadOnlyDictionary? parameters, CancellationToken cancellationToken) +MESSAGE: Method 'CachedCall(string systemName, string methodName, IReadOnlyDictionary? parameters, CancellationToken cancellationToken)' is missing documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.ScriptAnalysis/ScriptCompileSurface.cs +LINE: 107 +CATEGORY: MissingParam +SEVERITY: Warning +MEMBER: Method +SIGNATURE: CachedCall(string systemName, string methodName, IReadOnlyDictionary? parameters, CancellationToken cancellationToken) +MESSAGE: Method 'CachedCall(string systemName, string methodName, IReadOnlyDictionary? parameters, CancellationToken cancellationToken)' is missing documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.ScriptAnalysis/ScriptCompileSurface.cs +LINE: 107 +CATEGORY: MissingParam +SEVERITY: Warning +MEMBER: Method +SIGNATURE: CachedCall(string systemName, string methodName, IReadOnlyDictionary? parameters, CancellationToken cancellationToken) +MESSAGE: Method 'CachedCall(string systemName, string methodName, IReadOnlyDictionary? parameters, CancellationToken cancellationToken)' is missing documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.ScriptAnalysis/ScriptCompileSurface.cs +LINE: 107 +CATEGORY: MissingReturns +SEVERITY: Warning +MEMBER: Method +SIGNATURE: CachedCall(string systemName, string methodName, IReadOnlyDictionary? parameters, CancellationToken cancellationToken) +MESSAGE: Method 'CachedCall(string systemName, string methodName, IReadOnlyDictionary? parameters, CancellationToken cancellationToken)' returns a value but is missing . + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.ScriptAnalysis/ScriptCompileSurface.cs +LINE: 119 +CATEGORY: MissingParam +SEVERITY: Warning +MEMBER: Method +SIGNATURE: Connection(string name, CancellationToken cancellationToken) +MESSAGE: Method 'Connection(string name, CancellationToken cancellationToken)' is missing documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.ScriptAnalysis/ScriptCompileSurface.cs +LINE: 119 +CATEGORY: MissingParam +SEVERITY: Warning +MEMBER: Method +SIGNATURE: Connection(string name, CancellationToken cancellationToken) +MESSAGE: Method 'Connection(string name, CancellationToken cancellationToken)' is missing documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.ScriptAnalysis/ScriptCompileSurface.cs +LINE: 119 +CATEGORY: MissingReturns +SEVERITY: Warning +MEMBER: Method +SIGNATURE: Connection(string name, CancellationToken cancellationToken) +MESSAGE: Method 'Connection(string name, CancellationToken cancellationToken)' returns a value but is missing . + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.ScriptAnalysis/ScriptCompileSurface.cs +LINE: 123 +CATEGORY: MissingParam +SEVERITY: Warning +MEMBER: Method +SIGNATURE: CachedWrite(string name, string sql, IReadOnlyDictionary? parameters, CancellationToken cancellationToken) +MESSAGE: Method 'CachedWrite(string name, string sql, IReadOnlyDictionary? parameters, CancellationToken cancellationToken)' is missing documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.ScriptAnalysis/ScriptCompileSurface.cs +LINE: 123 +CATEGORY: MissingParam +SEVERITY: Warning +MEMBER: Method +SIGNATURE: CachedWrite(string name, string sql, IReadOnlyDictionary? parameters, CancellationToken cancellationToken) +MESSAGE: Method 'CachedWrite(string name, string sql, IReadOnlyDictionary? parameters, CancellationToken cancellationToken)' is missing documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.ScriptAnalysis/ScriptCompileSurface.cs +LINE: 123 +CATEGORY: MissingParam +SEVERITY: Warning +MEMBER: Method +SIGNATURE: CachedWrite(string name, string sql, IReadOnlyDictionary? parameters, CancellationToken cancellationToken) +MESSAGE: Method 'CachedWrite(string name, string sql, IReadOnlyDictionary? parameters, CancellationToken cancellationToken)' is missing documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.ScriptAnalysis/ScriptCompileSurface.cs +LINE: 123 +CATEGORY: MissingParam +SEVERITY: Warning +MEMBER: Method +SIGNATURE: CachedWrite(string name, string sql, IReadOnlyDictionary? parameters, CancellationToken cancellationToken) +MESSAGE: Method 'CachedWrite(string name, string sql, IReadOnlyDictionary? parameters, CancellationToken cancellationToken)' is missing documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.ScriptAnalysis/ScriptCompileSurface.cs +LINE: 123 +CATEGORY: MissingReturns +SEVERITY: Warning +MEMBER: Method +SIGNATURE: CachedWrite(string name, string sql, IReadOnlyDictionary? parameters, CancellationToken cancellationToken) +MESSAGE: Method 'CachedWrite(string name, string sql, IReadOnlyDictionary? parameters, CancellationToken cancellationToken)' returns a value but is missing . + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.ScriptAnalysis/ScriptCompileSurface.cs +LINE: 135 +CATEGORY: MissingParam +SEVERITY: Warning +MEMBER: Method +SIGNATURE: To(string listName) +MESSAGE: Method 'To(string listName)' is missing documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.ScriptAnalysis/ScriptCompileSurface.cs +LINE: 135 +CATEGORY: MissingReturns +SEVERITY: Warning +MEMBER: Method +SIGNATURE: To(string listName) +MESSAGE: Method 'To(string listName)' returns a value but is missing . + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.ScriptAnalysis/ScriptCompileSurface.cs +LINE: 138 +CATEGORY: MissingParam +SEVERITY: Warning +MEMBER: Method +SIGNATURE: Status(string notificationId) +MESSAGE: Method 'Status(string notificationId)' is missing documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.ScriptAnalysis/ScriptCompileSurface.cs +LINE: 138 +CATEGORY: MissingReturns +SEVERITY: Warning +MEMBER: Method +SIGNATURE: Status(string notificationId) +MESSAGE: Method 'Status(string notificationId)' returns a value but is missing . + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.ScriptAnalysis/ScriptCompileSurface.cs +LINE: 145 +CATEGORY: MissingParam +SEVERITY: Warning +MEMBER: Method +SIGNATURE: Send(string subject, string message, CancellationToken cancellationToken) +MESSAGE: Method 'Send(string subject, string message, CancellationToken cancellationToken)' is missing documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.ScriptAnalysis/ScriptCompileSurface.cs +LINE: 145 +CATEGORY: MissingParam +SEVERITY: Warning +MEMBER: Method +SIGNATURE: Send(string subject, string message, CancellationToken cancellationToken) +MESSAGE: Method 'Send(string subject, string message, CancellationToken cancellationToken)' is missing documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.ScriptAnalysis/ScriptCompileSurface.cs +LINE: 145 +CATEGORY: MissingParam +SEVERITY: Warning +MEMBER: Method +SIGNATURE: Send(string subject, string message, CancellationToken cancellationToken) +MESSAGE: Method 'Send(string subject, string message, CancellationToken cancellationToken)' is missing documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.ScriptAnalysis/ScriptCompileSurface.cs +LINE: 145 +CATEGORY: MissingReturns +SEVERITY: Warning +MEMBER: Method +SIGNATURE: Send(string subject, string message, CancellationToken cancellationToken) +MESSAGE: Method 'Send(string subject, string message, CancellationToken cancellationToken)' returns a value but is missing . + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.ScriptAnalysis/ScriptCompileSurface.cs +LINE: 153 +CATEGORY: MissingParam +SEVERITY: Warning +MEMBER: Method +SIGNATURE: CallShared(string scriptName, object? parameters, CancellationToken cancellationToken) +MESSAGE: Method 'CallShared(string scriptName, object? parameters, CancellationToken cancellationToken)' is missing documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.ScriptAnalysis/ScriptCompileSurface.cs +LINE: 153 +CATEGORY: MissingParam +SEVERITY: Warning +MEMBER: Method +SIGNATURE: CallShared(string scriptName, object? parameters, CancellationToken cancellationToken) +MESSAGE: Method 'CallShared(string scriptName, object? parameters, CancellationToken cancellationToken)' is missing documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.ScriptAnalysis/ScriptCompileSurface.cs +LINE: 153 +CATEGORY: MissingParam +SEVERITY: Warning +MEMBER: Method +SIGNATURE: CallShared(string scriptName, object? parameters, CancellationToken cancellationToken) +MESSAGE: Method 'CallShared(string scriptName, object? parameters, CancellationToken cancellationToken)' is missing documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.ScriptAnalysis/ScriptCompileSurface.cs +LINE: 153 +CATEGORY: MissingReturns +SEVERITY: Warning +MEMBER: Method +SIGNATURE: CallShared(string scriptName, object? parameters, CancellationToken cancellationToken) +MESSAGE: Method 'CallShared(string scriptName, object? parameters, CancellationToken cancellationToken)' returns a value but is missing . + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.ScriptAnalysis/ScriptCompileSurface.cs +LINE: 164 +CATEGORY: MissingParam +SEVERITY: Warning +MEMBER: Method +SIGNATURE: Status(TrackedOperationId trackedOperationId, CancellationToken cancellationToken) +MESSAGE: Method 'Status(TrackedOperationId trackedOperationId, CancellationToken cancellationToken)' is missing documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.ScriptAnalysis/ScriptCompileSurface.cs +LINE: 164 +CATEGORY: MissingParam +SEVERITY: Warning +MEMBER: Method +SIGNATURE: Status(TrackedOperationId trackedOperationId, CancellationToken cancellationToken) +MESSAGE: Method 'Status(TrackedOperationId trackedOperationId, CancellationToken cancellationToken)' is missing documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.ScriptAnalysis/ScriptCompileSurface.cs +LINE: 164 +CATEGORY: MissingReturns +SEVERITY: Warning +MEMBER: Method +SIGNATURE: Status(TrackedOperationId trackedOperationId, CancellationToken cancellationToken) +MESSAGE: Method 'Status(TrackedOperationId trackedOperationId, CancellationToken cancellationToken)' returns a value but is missing . + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.ScriptAnalysis/ScriptCompileSurface.cs +LINE: 174 +CATEGORY: MissingParam +SEVERITY: Warning +MEMBER: Indexer +SIGNATURE: this[string key] +MESSAGE: Parameter 'key' is missing from XML documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.ScriptAnalysis/ScriptCompileSurface.cs +LINE: 181 +CATEGORY: MissingParam +SEVERITY: Warning +MEMBER: Method +SIGNATURE: GetAsync(string key) +MESSAGE: Method 'GetAsync(string key)' is missing documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.ScriptAnalysis/ScriptCompileSurface.cs +LINE: 181 +CATEGORY: MissingReturns +SEVERITY: Warning +MEMBER: Method +SIGNATURE: GetAsync(string key) +MESSAGE: Method 'GetAsync(string key)' returns a value but is missing . + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.ScriptAnalysis/ScriptCompileSurface.cs +LINE: 184 +CATEGORY: MissingParam +SEVERITY: Warning +MEMBER: Method +SIGNATURE: SetAsync(string key, object? value) +MESSAGE: Method 'SetAsync(string key, object? value)' is missing documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.ScriptAnalysis/ScriptCompileSurface.cs +LINE: 184 +CATEGORY: MissingParam +SEVERITY: Warning +MEMBER: Method +SIGNATURE: SetAsync(string key, object? value) +MESSAGE: Method 'SetAsync(string key, object? value)' is missing documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.ScriptAnalysis/ScriptCompileSurface.cs +LINE: 184 +CATEGORY: MissingReturns +SEVERITY: Warning +MEMBER: Method +SIGNATURE: SetAsync(string key, object? value) +MESSAGE: Method 'SetAsync(string key, object? value)' returns a value but is missing . + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.ScriptAnalysis/ScriptCompileSurface.cs +LINE: 187 +CATEGORY: MissingParam +SEVERITY: Warning +MEMBER: Method +SIGNATURE: Resolve(string key) +MESSAGE: Method 'Resolve(string key)' is missing documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.ScriptAnalysis/ScriptCompileSurface.cs +LINE: 187 +CATEGORY: MissingReturns +SEVERITY: Warning +MEMBER: Method +SIGNATURE: Resolve(string key) +MESSAGE: Method 'Resolve(string key)' returns a value but is missing . + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.ScriptAnalysis/ScriptCompileSurface.cs +LINE: 190 +CATEGORY: MissingParam +SEVERITY: Warning +MEMBER: Method +SIGNATURE: WaitAsync(string key, object? targetValue, TimeSpan timeout, bool requireGoodQuality) +MESSAGE: Method 'WaitAsync(string key, object? targetValue, TimeSpan timeout, bool requireGoodQuality)' is missing documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.ScriptAnalysis/ScriptCompileSurface.cs +LINE: 190 +CATEGORY: MissingParam +SEVERITY: Warning +MEMBER: Method +SIGNATURE: WaitAsync(string key, object? targetValue, TimeSpan timeout, bool requireGoodQuality) +MESSAGE: Method 'WaitAsync(string key, object? targetValue, TimeSpan timeout, bool requireGoodQuality)' is missing documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.ScriptAnalysis/ScriptCompileSurface.cs +LINE: 190 +CATEGORY: MissingParam +SEVERITY: Warning +MEMBER: Method +SIGNATURE: WaitAsync(string key, object? targetValue, TimeSpan timeout, bool requireGoodQuality) +MESSAGE: Method 'WaitAsync(string key, object? targetValue, TimeSpan timeout, bool requireGoodQuality)' is missing documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.ScriptAnalysis/ScriptCompileSurface.cs +LINE: 190 +CATEGORY: MissingParam +SEVERITY: Warning +MEMBER: Method +SIGNATURE: WaitAsync(string key, object? targetValue, TimeSpan timeout, bool requireGoodQuality) +MESSAGE: Method 'WaitAsync(string key, object? targetValue, TimeSpan timeout, bool requireGoodQuality)' is missing documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.ScriptAnalysis/ScriptCompileSurface.cs +LINE: 190 +CATEGORY: MissingReturns +SEVERITY: Warning +MEMBER: Method +SIGNATURE: WaitAsync(string key, object? targetValue, TimeSpan timeout, bool requireGoodQuality) +MESSAGE: Method 'WaitAsync(string key, object? targetValue, TimeSpan timeout, bool requireGoodQuality)' returns a value but is missing . + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.ScriptAnalysis/ScriptCompileSurface.cs +LINE: 191 +CATEGORY: MissingDoc +SEVERITY: Error +MEMBER: Method +SIGNATURE: WaitAsync(string key, Func predicate, TimeSpan timeout, bool requireGoodQuality) +MESSAGE: Method 'WaitAsync(string key, Func predicate, TimeSpan timeout, bool requireGoodQuality)' is missing XML documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.ScriptAnalysis/ScriptCompileSurface.cs +LINE: 194 +CATEGORY: MissingParam +SEVERITY: Warning +MEMBER: Method +SIGNATURE: WaitForAsync(string key, object? targetValue, TimeSpan timeout, bool requireGoodQuality) +MESSAGE: Method 'WaitForAsync(string key, object? targetValue, TimeSpan timeout, bool requireGoodQuality)' is missing documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.ScriptAnalysis/ScriptCompileSurface.cs +LINE: 194 +CATEGORY: MissingParam +SEVERITY: Warning +MEMBER: Method +SIGNATURE: WaitForAsync(string key, object? targetValue, TimeSpan timeout, bool requireGoodQuality) +MESSAGE: Method 'WaitForAsync(string key, object? targetValue, TimeSpan timeout, bool requireGoodQuality)' is missing documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.ScriptAnalysis/ScriptCompileSurface.cs +LINE: 194 +CATEGORY: MissingParam +SEVERITY: Warning +MEMBER: Method +SIGNATURE: WaitForAsync(string key, object? targetValue, TimeSpan timeout, bool requireGoodQuality) +MESSAGE: Method 'WaitForAsync(string key, object? targetValue, TimeSpan timeout, bool requireGoodQuality)' is missing documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.ScriptAnalysis/ScriptCompileSurface.cs +LINE: 194 +CATEGORY: MissingParam +SEVERITY: Warning +MEMBER: Method +SIGNATURE: WaitForAsync(string key, object? targetValue, TimeSpan timeout, bool requireGoodQuality) +MESSAGE: Method 'WaitForAsync(string key, object? targetValue, TimeSpan timeout, bool requireGoodQuality)' is missing documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.ScriptAnalysis/ScriptCompileSurface.cs +LINE: 194 +CATEGORY: MissingReturns +SEVERITY: Warning +MEMBER: Method +SIGNATURE: WaitForAsync(string key, object? targetValue, TimeSpan timeout, bool requireGoodQuality) +MESSAGE: Method 'WaitForAsync(string key, object? targetValue, TimeSpan timeout, bool requireGoodQuality)' returns a value but is missing . + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.ScriptAnalysis/ScriptCompileSurface.cs +LINE: 195 +CATEGORY: MissingDoc +SEVERITY: Error +MEMBER: Method +SIGNATURE: WaitForAsync(string key, Func predicate, TimeSpan timeout, bool requireGoodQuality) +MESSAGE: Method 'WaitForAsync(string key, Func predicate, TimeSpan timeout, bool requireGoodQuality)' is missing XML documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.ScriptAnalysis/ScriptCompileSurface.cs +LINE: 198 +CATEGORY: MissingParam +SEVERITY: Warning +MEMBER: Method +SIGNATURE: WriteBatchAndWaitAsync(IReadOnlyDictionary values, string flagKey, object? flagValue, string responseKey, object? responseValue, TimeSpan timeout) +MESSAGE: Method 'WriteBatchAndWaitAsync(IReadOnlyDictionary values, string flagKey, object? flagValue, string responseKey, object? responseValue, TimeSpan timeout)' is missing documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.ScriptAnalysis/ScriptCompileSurface.cs +LINE: 198 +CATEGORY: MissingParam +SEVERITY: Warning +MEMBER: Method +SIGNATURE: WriteBatchAndWaitAsync(IReadOnlyDictionary values, string flagKey, object? flagValue, string responseKey, object? responseValue, TimeSpan timeout) +MESSAGE: Method 'WriteBatchAndWaitAsync(IReadOnlyDictionary values, string flagKey, object? flagValue, string responseKey, object? responseValue, TimeSpan timeout)' is missing documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.ScriptAnalysis/ScriptCompileSurface.cs +LINE: 198 +CATEGORY: MissingParam +SEVERITY: Warning +MEMBER: Method +SIGNATURE: WriteBatchAndWaitAsync(IReadOnlyDictionary values, string flagKey, object? flagValue, string responseKey, object? responseValue, TimeSpan timeout) +MESSAGE: Method 'WriteBatchAndWaitAsync(IReadOnlyDictionary values, string flagKey, object? flagValue, string responseKey, object? responseValue, TimeSpan timeout)' is missing documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.ScriptAnalysis/ScriptCompileSurface.cs +LINE: 198 +CATEGORY: MissingParam +SEVERITY: Warning +MEMBER: Method +SIGNATURE: WriteBatchAndWaitAsync(IReadOnlyDictionary values, string flagKey, object? flagValue, string responseKey, object? responseValue, TimeSpan timeout) +MESSAGE: Method 'WriteBatchAndWaitAsync(IReadOnlyDictionary values, string flagKey, object? flagValue, string responseKey, object? responseValue, TimeSpan timeout)' is missing documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.ScriptAnalysis/ScriptCompileSurface.cs +LINE: 198 +CATEGORY: MissingParam +SEVERITY: Warning +MEMBER: Method +SIGNATURE: WriteBatchAndWaitAsync(IReadOnlyDictionary values, string flagKey, object? flagValue, string responseKey, object? responseValue, TimeSpan timeout) +MESSAGE: Method 'WriteBatchAndWaitAsync(IReadOnlyDictionary values, string flagKey, object? flagValue, string responseKey, object? responseValue, TimeSpan timeout)' is missing documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.ScriptAnalysis/ScriptCompileSurface.cs +LINE: 198 +CATEGORY: MissingParam +SEVERITY: Warning +MEMBER: Method +SIGNATURE: WriteBatchAndWaitAsync(IReadOnlyDictionary values, string flagKey, object? flagValue, string responseKey, object? responseValue, TimeSpan timeout) +MESSAGE: Method 'WriteBatchAndWaitAsync(IReadOnlyDictionary values, string flagKey, object? flagValue, string responseKey, object? responseValue, TimeSpan timeout)' is missing documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.ScriptAnalysis/ScriptCompileSurface.cs +LINE: 198 +CATEGORY: MissingReturns +SEVERITY: Warning +MEMBER: Method +SIGNATURE: WriteBatchAndWaitAsync(IReadOnlyDictionary values, string flagKey, object? flagValue, string responseKey, object? responseValue, TimeSpan timeout) +MESSAGE: Method 'WriteBatchAndWaitAsync(IReadOnlyDictionary values, string flagKey, object? flagValue, string responseKey, object? responseValue, TimeSpan timeout)' returns a value but is missing . + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.ScriptAnalysis/ScriptCompileSurface.cs +LINE: 205 +CATEGORY: MissingParam +SEVERITY: Warning +MEMBER: Indexer +SIGNATURE: this[string compositionName] +MESSAGE: Parameter 'compositionName' is missing from XML documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.ScriptAnalysis/ScriptCompileSurface.cs +LINE: 215 +CATEGORY: MissingParam +SEVERITY: Warning +MEMBER: Method +SIGNATURE: CallScript(string scriptName, object? parameters) +MESSAGE: Method 'CallScript(string scriptName, object? parameters)' is missing documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.ScriptAnalysis/ScriptCompileSurface.cs +LINE: 215 +CATEGORY: MissingParam +SEVERITY: Warning +MEMBER: Method +SIGNATURE: CallScript(string scriptName, object? parameters) +MESSAGE: Method 'CallScript(string scriptName, object? parameters)' is missing documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.ScriptAnalysis/ScriptCompileSurface.cs +LINE: 215 +CATEGORY: MissingReturns +SEVERITY: Warning +MEMBER: Method +SIGNATURE: CallScript(string scriptName, object? parameters) +MESSAGE: Method 'CallScript(string scriptName, object? parameters)' returns a value but is missing . + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.ScriptAnalysis/ScriptCompileSurface.cs +LINE: 218 +CATEGORY: MissingParam +SEVERITY: Warning +MEMBER: Method +SIGNATURE: ResolveScript(string scriptName) +MESSAGE: Method 'ResolveScript(string scriptName)' is missing documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.ScriptAnalysis/ScriptCompileSurface.cs +LINE: 218 +CATEGORY: MissingReturns +SEVERITY: Warning +MEMBER: Method +SIGNATURE: ResolveScript(string scriptName) +MESSAGE: Method 'ResolveScript(string scriptName)' returns a value but is missing . + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.ScriptAnalysis/ScriptTrustPolicy.cs +LINE: 322 +CATEGORY: MissingReturns +SEVERITY: Warning +MEMBER: Method +SIGNATURE: BuildMinimalFallbackReferences() +MESSAGE: Method 'BuildMinimalFallbackReferences()' returns a value but is missing . + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.ScriptAnalysis/ScriptTrustValidator.cs +LINE: 316 +CATEGORY: MissingDoc +SEVERITY: Error +MEMBER: Constructor +SIGNATURE: HardeningWalker(SortedSet violations) +MESSAGE: Constructor 'HardeningWalker(SortedSet violations)' is missing XML documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.ScriptAnalysis/TriggerCompileSurface.cs +LINE: 35 +CATEGORY: MissingParam +SEVERITY: Warning +MEMBER: Indexer +SIGNATURE: this[string key] +MESSAGE: Parameter 'key' is missing from XML documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.ScriptAnalysis/TriggerCompileSurface.cs +LINE: 49 +CATEGORY: MissingParam +SEVERITY: Warning +MEMBER: Indexer +SIGNATURE: this[string compositionName] +MESSAGE: Parameter 'compositionName' is missing from XML documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.Security/Auth/AutoLoginAuthenticationHandler.cs +LINE: 27 +CATEGORY: MissingParam +SEVERITY: Warning +MEMBER: Constructor +SIGNATURE: AutoLoginAuthenticationHandler(IOptionsMonitor options, ILoggerFactory logger, UrlEncoder encoder, IOptions disableLoginOptions, TimeProvider clock) +MESSAGE: Constructor 'AutoLoginAuthenticationHandler(IOptionsMonitor options, ILoggerFactory logger, UrlEncoder encoder, IOptions disableLoginOptions, TimeProvider clock)' is missing documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.Security/Auth/AutoLoginAuthenticationHandler.cs +LINE: 27 +CATEGORY: MissingParam +SEVERITY: Warning +MEMBER: Constructor +SIGNATURE: AutoLoginAuthenticationHandler(IOptionsMonitor options, ILoggerFactory logger, UrlEncoder encoder, IOptions disableLoginOptions, TimeProvider clock) +MESSAGE: Constructor 'AutoLoginAuthenticationHandler(IOptionsMonitor options, ILoggerFactory logger, UrlEncoder encoder, IOptions disableLoginOptions, TimeProvider clock)' is missing documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.Security/Auth/AutoLoginAuthenticationHandler.cs +LINE: 27 +CATEGORY: MissingParam +SEVERITY: Warning +MEMBER: Constructor +SIGNATURE: AutoLoginAuthenticationHandler(IOptionsMonitor options, ILoggerFactory logger, UrlEncoder encoder, IOptions disableLoginOptions, TimeProvider clock) +MESSAGE: Constructor 'AutoLoginAuthenticationHandler(IOptionsMonitor options, ILoggerFactory logger, UrlEncoder encoder, IOptions disableLoginOptions, TimeProvider clock)' is missing documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.Security/Auth/AutoLoginAuthenticationHandler.cs +LINE: 27 +CATEGORY: MissingParam +SEVERITY: Warning +MEMBER: Constructor +SIGNATURE: AutoLoginAuthenticationHandler(IOptionsMonitor options, ILoggerFactory logger, UrlEncoder encoder, IOptions disableLoginOptions, TimeProvider clock) +MESSAGE: Constructor 'AutoLoginAuthenticationHandler(IOptionsMonitor options, ILoggerFactory logger, UrlEncoder encoder, IOptions disableLoginOptions, TimeProvider clock)' is missing documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.Security/Auth/AutoLoginAuthenticationHandler.cs +LINE: 27 +CATEGORY: MissingParam +SEVERITY: Warning +MEMBER: Constructor +SIGNATURE: AutoLoginAuthenticationHandler(IOptionsMonitor options, ILoggerFactory logger, UrlEncoder encoder, IOptions disableLoginOptions, TimeProvider clock) +MESSAGE: Constructor 'AutoLoginAuthenticationHandler(IOptionsMonitor options, ILoggerFactory logger, UrlEncoder encoder, IOptions disableLoginOptions, TimeProvider clock)' is missing documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.Security/Auth/AutoLoginAuthenticationHandler.cs +LINE: 40 +CATEGORY: MissingParam +SEVERITY: Warning +MEMBER: Method +SIGNATURE: SignInAsync(ClaimsPrincipal user, AuthenticationProperties? properties) +MESSAGE: Method 'SignInAsync(ClaimsPrincipal user, AuthenticationProperties? properties)' is missing documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.Security/Auth/AutoLoginAuthenticationHandler.cs +LINE: 40 +CATEGORY: MissingParam +SEVERITY: Warning +MEMBER: Method +SIGNATURE: SignInAsync(ClaimsPrincipal user, AuthenticationProperties? properties) +MESSAGE: Method 'SignInAsync(ClaimsPrincipal user, AuthenticationProperties? properties)' is missing documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.Security/Auth/AutoLoginAuthenticationHandler.cs +LINE: 40 +CATEGORY: MissingReturns +SEVERITY: Warning +MEMBER: Method +SIGNATURE: SignInAsync(ClaimsPrincipal user, AuthenticationProperties? properties) +MESSAGE: Method 'SignInAsync(ClaimsPrincipal user, AuthenticationProperties? properties)' returns a value but is missing . + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.Security/Auth/AutoLoginAuthenticationHandler.cs +LINE: 43 +CATEGORY: MissingParam +SEVERITY: Warning +MEMBER: Method +SIGNATURE: SignOutAsync(AuthenticationProperties? properties) +MESSAGE: Method 'SignOutAsync(AuthenticationProperties? properties)' is missing documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.Security/Auth/AutoLoginAuthenticationHandler.cs +LINE: 43 +CATEGORY: MissingReturns +SEVERITY: Warning +MEMBER: Method +SIGNATURE: SignOutAsync(AuthenticationProperties? properties) +MESSAGE: Method 'SignOutAsync(AuthenticationProperties? properties)' returns a value but is missing . + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.Security/Auth/DisableLoginGuard.cs +LINE: 13 +CATEGORY: MissingDoc +SEVERITY: Error +MEMBER: Method +SIGNATURE: Validate(bool disableLogin, string environmentName, bool allowOutsideDevelopment) +MESSAGE: Method 'Validate(bool disableLogin, string environmentName, bool allowOutsideDevelopment)' is missing XML documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.Security/LoginThrottle.cs +LINE: 70 +CATEGORY: MissingParam +SEVERITY: Warning +MEMBER: Method +SIGNATURE: IsLockedOut(string username, string ip) +MESSAGE: Method 'IsLockedOut(string username, string ip)' is missing documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.Security/LoginThrottle.cs +LINE: 70 +CATEGORY: MissingParam +SEVERITY: Warning +MEMBER: Method +SIGNATURE: IsLockedOut(string username, string ip) +MESSAGE: Method 'IsLockedOut(string username, string ip)' is missing documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.Security/LoginThrottle.cs +LINE: 70 +CATEGORY: MissingReturns +SEVERITY: Warning +MEMBER: Method +SIGNATURE: IsLockedOut(string username, string ip) +MESSAGE: Method 'IsLockedOut(string username, string ip)' returns a value but is missing . + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.Security/LoginThrottle.cs +LINE: 85 +CATEGORY: MissingParam +SEVERITY: Warning +MEMBER: Method +SIGNATURE: RecordFailure(string username, string ip) +MESSAGE: Method 'RecordFailure(string username, string ip)' is missing documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.Security/LoginThrottle.cs +LINE: 85 +CATEGORY: MissingParam +SEVERITY: Warning +MEMBER: Method +SIGNATURE: RecordFailure(string username, string ip) +MESSAGE: Method 'RecordFailure(string username, string ip)' is missing documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.Security/LoginThrottle.cs +LINE: 123 +CATEGORY: MissingParam +SEVERITY: Warning +MEMBER: Method +SIGNATURE: RecordSuccess(string username, string ip) +MESSAGE: Method 'RecordSuccess(string username, string ip)' is missing documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.Security/LoginThrottle.cs +LINE: 123 +CATEGORY: MissingParam +SEVERITY: Warning +MEMBER: Method +SIGNATURE: RecordSuccess(string username, string ip) +MESSAGE: Method 'RecordSuccess(string username, string ip)' is missing documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.Security/SecurityOptions.cs +LINE: 141 +CATEGORY: InheritDocMisused +SEVERITY: Error +MEMBER: Method +SIGNATURE: Validate(string? name, SecurityOptions options) +MESSAGE: Method 'Validate(string? name, SecurityOptions options)' uses but has nothing to inherit (not an override or interface implementation). + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.SiteCallAudit/SiteCallAuditActor.cs +LINE: 97 +CATEGORY: TrackingReferenceInComment +SEVERITY: Warning +MEMBER: Comment +SIGNATURE: Task 14 +MESSAGE: Comment contains 'Task 14', which looks like a project tracking reference; bookkeeping references should not appear in code documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.SiteCallAudit/SiteCallAuditActor.cs +LINE: 136 +CATEGORY: TrackingReferenceInComment +SEVERITY: Warning +MEMBER: Comment +SIGNATURE: Task 16 +MESSAGE: Comment contains 'Task 16', which looks like a project tracking reference; bookkeeping references should not appear in code documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.SiteCallAudit/SiteCallAuditActor.cs +LINE: 150 +CATEGORY: TrackingReferenceInComment +SEVERITY: Warning +MEMBER: Comment +SIGNATURE: Task 16 +MESSAGE: Comment contains 'Task 16', which looks like a project tracking reference; bookkeeping references should not appear in code documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.SiteCallAudit/SiteCallAuditActor.cs +LINE: 194 +CATEGORY: MissingParam +SEVERITY: Warning +MEMBER: Constructor +SIGNATURE: SiteCallAuditActor(ISiteCallAuditRepository repository, ILogger logger, SiteCallAuditOptions? options, ICentralAuditWriter? auditWriter) +MESSAGE: Constructor 'SiteCallAuditActor(ISiteCallAuditRepository repository, ILogger logger, SiteCallAuditOptions? options, ICentralAuditWriter? auditWriter)' is missing documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.SiteCallAudit/SiteCallAuditActor.cs +LINE: 286 +CATEGORY: TrackingReferenceInComment +SEVERITY: Warning +MEMBER: Comment +SIGNATURE: Task 14 +MESSAGE: Comment contains 'Task 14', which looks like a project tracking reference; bookkeeping references should not appear in code documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.SiteCallAudit/SiteCallAuditActor.cs +LINE: 602 +CATEGORY: TrackingReferenceInComment +SEVERITY: Warning +MEMBER: Comment +SIGNATURE: Task 16 +MESSAGE: Comment contains 'Task 16', which looks like a project tracking reference; bookkeeping references should not appear in code documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.SiteCallAudit/SiteCallAuditActor.cs +LINE: 610 +CATEGORY: TrackingReferenceInComment +SEVERITY: Warning +MEMBER: Comment +SIGNATURE: Task 15 +MESSAGE: Comment contains 'Task 15', which looks like a project tracking reference; bookkeeping references should not appear in code documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.SiteCallAudit/SiteCallAuditActor.cs +LINE: 619 +CATEGORY: TaskReferenceInComment +SEVERITY: Warning +MEMBER: Comment +SIGNATURE: Task-15 +MESSAGE: Comment contains 'Task-15', which looks like a task/issue tracking identifier; tracking IDs should not appear in code documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.SiteCallAudit/SiteCallAuditActor.cs +LINE: 1114 +CATEGORY: TrackingReferenceInComment +SEVERITY: Warning +MEMBER: Comment +SIGNATURE: Task 14 +MESSAGE: Comment contains 'Task 14', which looks like a project tracking reference; bookkeeping references should not appear in code documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.SiteCallAudit/SiteCallAuditActor.cs +LINE: 1170 +CATEGORY: TrackingReferenceInComment +SEVERITY: Warning +MEMBER: Comment +SIGNATURE: Task 14 +MESSAGE: Comment contains 'Task 14', which looks like a project tracking reference; bookkeeping references should not appear in code documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.SiteRuntime/Actors/DeploymentManagerActor.cs +LINE: 157 +CATEGORY: MissingParam +SEVERITY: Warning +MEMBER: Constructor +SIGNATURE: DeploymentManagerActor(SiteStorageService storage, ScriptCompilationService compilationService, SharedScriptLibrary sharedScriptLibrary, SiteStreamManager? streamManager, SiteRuntimeOptions options, ILogger logger, IActorRef? dclManager, IActorRef? replicationActor, ISiteHealthCollector? healthCollector, IServiceProvider? serviceProvider, ILoggerFactory? loggerFactory, IDeploymentConfigFetcher? configFetcher, TimeSpan? startupLoadRetryInterval, Func>>? configLoader) +MESSAGE: Constructor 'DeploymentManagerActor(SiteStorageService storage, ScriptCompilationService compilationService, SharedScriptLibrary sharedScriptLibrary, SiteStreamManager? streamManager, SiteRuntimeOptions options, ILogger logger, IActorRef? dclManager, IActorRef? replicationActor, ISiteHealthCollector? healthCollector, IServiceProvider? serviceProvider, ILoggerFactory? loggerFactory, IDeploymentConfigFetcher? configFetcher, TimeSpan? startupLoadRetryInterval, Func>>? configLoader)' is missing documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.SiteRuntime/Actors/DeploymentManagerActor.cs +LINE: 157 +CATEGORY: MissingParam +SEVERITY: Warning +MEMBER: Constructor +SIGNATURE: DeploymentManagerActor(SiteStorageService storage, ScriptCompilationService compilationService, SharedScriptLibrary sharedScriptLibrary, SiteStreamManager? streamManager, SiteRuntimeOptions options, ILogger logger, IActorRef? dclManager, IActorRef? replicationActor, ISiteHealthCollector? healthCollector, IServiceProvider? serviceProvider, ILoggerFactory? loggerFactory, IDeploymentConfigFetcher? configFetcher, TimeSpan? startupLoadRetryInterval, Func>>? configLoader) +MESSAGE: Constructor 'DeploymentManagerActor(SiteStorageService storage, ScriptCompilationService compilationService, SharedScriptLibrary sharedScriptLibrary, SiteStreamManager? streamManager, SiteRuntimeOptions options, ILogger logger, IActorRef? dclManager, IActorRef? replicationActor, ISiteHealthCollector? healthCollector, IServiceProvider? serviceProvider, ILoggerFactory? loggerFactory, IDeploymentConfigFetcher? configFetcher, TimeSpan? startupLoadRetryInterval, Func>>? configLoader)' is missing documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.SiteRuntime/Actors/ScriptActor.cs +LINE: 481 +CATEGORY: MissingDoc +SEVERITY: Error +MEMBER: Method +SIGNATURE: EvaluateCondition(ConditionalTriggerConfig config, object? value) +MESSAGE: Method 'EvaluateCondition(ConditionalTriggerConfig config, object? value)' is missing XML documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.SiteRuntime/Actors/SiteReconciliationActor.cs +LINE: 233 +CATEGORY: MissingDoc +SEVERITY: Error +MEMBER: Method +SIGNATURE: Completed(int fetched, int failed, int orphans) +MESSAGE: Method 'Completed(int fetched, int failed, int orphans)' is missing XML documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.SiteRuntime/Actors/SiteReconciliationActor.cs +LINE: 236 +CATEGORY: MissingDoc +SEVERITY: Error +MEMBER: Method +SIGNATURE: Faulted(Exception error) +MESSAGE: Method 'Faulted(Exception error)' is missing XML documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.SiteRuntime/Actors/SiteReplicationActor.cs +LINE: 62 +CATEGORY: MissingParam +SEVERITY: Warning +MEMBER: Constructor +SIGNATURE: SiteReplicationActor(SiteStorageService storage, StoreAndForwardStorage sfStorage, ReplicationService replicationService, string siteRole, ILogger logger, IDeploymentConfigFetcher? configFetcher, Func? isActiveOverride, SiteRuntimeOptions? options, TimeSpan? configFetchRetryDelay) +MESSAGE: Constructor 'SiteReplicationActor(SiteStorageService storage, StoreAndForwardStorage sfStorage, ReplicationService replicationService, string siteRole, ILogger logger, IDeploymentConfigFetcher? configFetcher, Func? isActiveOverride, SiteRuntimeOptions? options, TimeSpan? configFetchRetryDelay)' is missing documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.SiteRuntime/Actors/SiteReplicationActor.cs +LINE: 62 +CATEGORY: MissingParam +SEVERITY: Warning +MEMBER: Constructor +SIGNATURE: SiteReplicationActor(SiteStorageService storage, StoreAndForwardStorage sfStorage, ReplicationService replicationService, string siteRole, ILogger logger, IDeploymentConfigFetcher? configFetcher, Func? isActiveOverride, SiteRuntimeOptions? options, TimeSpan? configFetchRetryDelay) +MESSAGE: Constructor 'SiteReplicationActor(SiteStorageService storage, StoreAndForwardStorage sfStorage, ReplicationService replicationService, string siteRole, ILogger logger, IDeploymentConfigFetcher? configFetcher, Func? isActiveOverride, SiteRuntimeOptions? options, TimeSpan? configFetchRetryDelay)' is missing documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.SiteRuntime/Actors/SiteReplicationActor.cs +LINE: 220 +CATEGORY: MissingParam +SEVERITY: Warning +MEMBER: Method +SIGNATURE: SendToPeer(object message) +MESSAGE: Method 'SendToPeer(object message)' is missing documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.SiteRuntime/Actors/SiteReplicationActor.cs +LINE: 413 +CATEGORY: TrackingReferenceInComment +SEVERITY: Warning +MEMBER: Comment +SIGNATURE: Task 11 +MESSAGE: Comment contains 'Task 11', which looks like a project tracking reference; bookkeeping references should not appear in code documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.SiteRuntime/Deployment/HttpDeploymentConfigFetcher.cs +LINE: 11 +CATEGORY: MissingDoc +SEVERITY: Error +MEMBER: Constructor +SIGNATURE: HttpDeploymentConfigFetcher(HttpClient http, ILogger log) +MESSAGE: Constructor 'HttpDeploymentConfigFetcher(HttpClient http, ILogger log)' is missing XML documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.SiteRuntime/Deployment/HttpDeploymentConfigFetcher.cs +LINE: 17 +CATEGORY: MissingDoc +SEVERITY: Error +MEMBER: Method +SIGNATURE: FetchAsync(string centralFetchBaseUrl, string deploymentId, string token, CancellationToken ct) +MESSAGE: Method 'FetchAsync(string centralFetchBaseUrl, string deploymentId, string token, CancellationToken ct)' is missing XML documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.SiteRuntime/Deployment/IDeploymentConfigFetcher.cs +LINE: 15 +CATEGORY: MissingParam +SEVERITY: Warning +MEMBER: Method +SIGNATURE: FetchAsync(string centralFetchBaseUrl, string deploymentId, string token, CancellationToken ct) +MESSAGE: Method 'FetchAsync(string centralFetchBaseUrl, string deploymentId, string token, CancellationToken ct)' is missing documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.SiteRuntime/Deployment/IDeploymentConfigFetcher.cs +LINE: 15 +CATEGORY: MissingParam +SEVERITY: Warning +MEMBER: Method +SIGNATURE: FetchAsync(string centralFetchBaseUrl, string deploymentId, string token, CancellationToken ct) +MESSAGE: Method 'FetchAsync(string centralFetchBaseUrl, string deploymentId, string token, CancellationToken ct)' is missing documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.SiteRuntime/Deployment/IDeploymentConfigFetcher.cs +LINE: 15 +CATEGORY: MissingParam +SEVERITY: Warning +MEMBER: Method +SIGNATURE: FetchAsync(string centralFetchBaseUrl, string deploymentId, string token, CancellationToken ct) +MESSAGE: Method 'FetchAsync(string centralFetchBaseUrl, string deploymentId, string token, CancellationToken ct)' is missing documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.SiteRuntime/Deployment/IDeploymentConfigFetcher.cs +LINE: 15 +CATEGORY: MissingParam +SEVERITY: Warning +MEMBER: Method +SIGNATURE: FetchAsync(string centralFetchBaseUrl, string deploymentId, string token, CancellationToken ct) +MESSAGE: Method 'FetchAsync(string centralFetchBaseUrl, string deploymentId, string token, CancellationToken ct)' is missing documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.SiteRuntime/Deployment/IDeploymentConfigFetcher.cs +LINE: 15 +CATEGORY: MissingReturns +SEVERITY: Warning +MEMBER: Method +SIGNATURE: FetchAsync(string centralFetchBaseUrl, string deploymentId, string token, CancellationToken ct) +MESSAGE: Method 'FetchAsync(string centralFetchBaseUrl, string deploymentId, string token, CancellationToken ct)' returns a value but is missing . + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.SiteRuntime/Deployment/IDeploymentConfigFetcher.cs +LINE: 21 +CATEGORY: MissingDoc +SEVERITY: Error +MEMBER: Property +SIGNATURE: IsSuperseded +MESSAGE: Property 'IsSuperseded' is missing XML documentation + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.SiteRuntime/Deployment/IDeploymentConfigFetcher.cs +LINE: 22 +CATEGORY: MissingDoc +SEVERITY: Error +MEMBER: Constructor +SIGNATURE: DeploymentConfigFetchException(string message, bool isSuperseded, Exception? inner) +MESSAGE: Constructor 'DeploymentConfigFetchException(string message, bool isSuperseded, Exception? inner)' is missing XML documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.SiteRuntime/Persistence/SiteStorageService.cs +LINE: 493 +CATEGORY: MissingParam +SEVERITY: Warning +MEMBER: Method +SIGNATURE: UpsertNativeAlarmAsync(string instanceName, string sourceCanonicalName, string sourceReference, string conditionJson, DateTimeOffset lastTransitionAt, string? metadataJson) +MESSAGE: Method 'UpsertNativeAlarmAsync(string instanceName, string sourceCanonicalName, string sourceReference, string conditionJson, DateTimeOffset lastTransitionAt, string? metadataJson)' is missing documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.SiteRuntime/Persistence/SiteStorageService.cs +LINE: 804 +CATEGORY: TrackingReferenceInComment +SEVERITY: Warning +MEMBER: Comment +SIGNATURE: #23 +MESSAGE: Comment contains '#23', which looks like a project tracking reference; bookkeeping references should not appear in code documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.SiteRuntime/Scripts/ScriptRuntimeContext.cs +LINE: 295 +CATEGORY: MissingReturns +SEVERITY: Warning +MEMBER: Method +SIGNATURE: CreateChildContextForSharedScript(int childCallDepth) +MESSAGE: Method 'CreateChildContextForSharedScript(int childCallDepth)' returns a value but is missing . + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.SiteRuntime/Scripts/ScriptRuntimeContext.cs +LINE: 2202 +CATEGORY: TaskReferenceInComment +SEVERITY: Warning +MEMBER: Comment +SIGNATURE: StoreAndForward-015 +MESSAGE: Comment contains 'StoreAndForward-015', which looks like a task/issue tracking identifier; tracking IDs should not appear in code documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.SiteRuntime/Scripts/ScriptRuntimeContext.cs +LINE: 2206 +CATEGORY: TrackingReferenceInComment +SEVERITY: Warning +MEMBER: Comment +SIGNATURE: Task 14 +MESSAGE: Comment contains 'Task 14', which looks like a project tracking reference; bookkeeping references should not appear in code documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.SiteRuntime/Scripts/TriggerRouting.cs +LINE: 27 +CATEGORY: MissingDoc +SEVERITY: Error +MEMBER: Method +SIGNATURE: Monitored(string attribute) +MESSAGE: Method 'Monitored(string attribute)' is missing XML documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.SiteRuntime/Scripts/TriggerRouting.cs +LINE: 47 +CATEGORY: MissingParam +SEVERITY: Warning +MEMBER: Method +SIGNATURE: TryReadAttributeName(string? triggerConfigJson, string attribute) +MESSAGE: Method 'TryReadAttributeName(string? triggerConfigJson, string attribute)' is missing documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.SiteRuntime/Scripts/TriggerRouting.cs +LINE: 47 +CATEGORY: MissingParam +SEVERITY: Warning +MEMBER: Method +SIGNATURE: TryReadAttributeName(string? triggerConfigJson, string attribute) +MESSAGE: Method 'TryReadAttributeName(string? triggerConfigJson, string attribute)' is missing documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.SiteRuntime/Scripts/TriggerRouting.cs +LINE: 47 +CATEGORY: MissingReturns +SEVERITY: Warning +MEMBER: Method +SIGNATURE: TryReadAttributeName(string? triggerConfigJson, string attribute) +MESSAGE: Method 'TryReadAttributeName(string? triggerConfigJson, string attribute)' returns a value but is missing . + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.SiteRuntime/Scripts/TriggerRouting.cs +LINE: 79 +CATEGORY: MissingParam +SEVERITY: Warning +MEMBER: Method +SIGNATURE: ForScript(string? triggerType, string? triggerConfigJson) +MESSAGE: Method 'ForScript(string? triggerType, string? triggerConfigJson)' is missing documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.SiteRuntime/Scripts/TriggerRouting.cs +LINE: 79 +CATEGORY: MissingParam +SEVERITY: Warning +MEMBER: Method +SIGNATURE: ForScript(string? triggerType, string? triggerConfigJson) +MESSAGE: Method 'ForScript(string? triggerType, string? triggerConfigJson)' is missing documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.SiteRuntime/Scripts/TriggerRouting.cs +LINE: 79 +CATEGORY: MissingReturns +SEVERITY: Warning +MEMBER: Method +SIGNATURE: ForScript(string? triggerType, string? triggerConfigJson) +MESSAGE: Method 'ForScript(string? triggerType, string? triggerConfigJson)' returns a value but is missing . + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.SiteRuntime/Scripts/TriggerRouting.cs +LINE: 103 +CATEGORY: MissingParam +SEVERITY: Warning +MEMBER: Method +SIGNATURE: ForAlarm(string? triggerType, string? triggerConfigJson) +MESSAGE: Method 'ForAlarm(string? triggerType, string? triggerConfigJson)' is missing documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.SiteRuntime/Scripts/TriggerRouting.cs +LINE: 103 +CATEGORY: MissingParam +SEVERITY: Warning +MEMBER: Method +SIGNATURE: ForAlarm(string? triggerType, string? triggerConfigJson) +MESSAGE: Method 'ForAlarm(string? triggerType, string? triggerConfigJson)' is missing documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.SiteRuntime/Scripts/TriggerRouting.cs +LINE: 103 +CATEGORY: MissingReturns +SEVERITY: Warning +MEMBER: Method +SIGNATURE: ForAlarm(string? triggerType, string? triggerConfigJson) +MESSAGE: Method 'ForAlarm(string? triggerType, string? triggerConfigJson)' returns a value but is missing . + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.SiteRuntime/Tracking/OperationTrackingStore.cs +LINE: 384 +CATEGORY: TrackingReferenceInComment +SEVERITY: Warning +MEMBER: Comment +SIGNATURE: Task 15 +MESSAGE: Comment contains 'Task 15', which looks like a project tracking reference; bookkeeping references should not appear in code documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.StoreAndForward/NotificationForwarder.cs +LINE: 26 +CATEGORY: TaskReferenceInComment +SEVERITY: Warning +MEMBER: Comment +SIGNATURE: StoreAndForward-018 +MESSAGE: Comment contains 'StoreAndForward-018', which looks like a task/issue tracking identifier; tracking IDs should not appear in code documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.StoreAndForward/NotificationForwarder.cs +LINE: 93 +CATEGORY: TaskReferenceInComment +SEVERITY: Warning +MEMBER: Comment +SIGNATURE: StoreAndForward-018 +MESSAGE: Comment contains 'StoreAndForward-018', which looks like a task/issue tracking identifier; tracking IDs should not appear in code documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.StoreAndForward/StoreAndForwardService.cs +LINE: 102 +CATEGORY: MissingParam +SEVERITY: Warning +MEMBER: Method +SIGNATURE: SetDeliveryGate(Func gate) +MESSAGE: Method 'SetDeliveryGate(Func gate)' is missing documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.StoreAndForward/StoreAndForwardService.cs +LINE: 707 +CATEGORY: TrackingReferenceInComment +SEVERITY: Warning +MEMBER: Comment +SIGNATURE: #2 +MESSAGE: Comment contains '#2', which looks like a project tracking reference; bookkeeping references should not appear in code documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.StoreAndForward/StoreAndForwardService.cs +LINE: 722 +CATEGORY: TrackingReferenceInComment +SEVERITY: Warning +MEMBER: Comment +SIGNATURE: Task 8 +MESSAGE: Comment contains 'Task 8', which looks like a project tracking reference; bookkeeping references should not appear in code documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.StoreAndForward/StoreAndForwardService.cs +LINE: 915 +CATEGORY: TaskReferenceInComment +SEVERITY: Warning +MEMBER: Comment +SIGNATURE: Task-19 +MESSAGE: Comment contains 'Task-19', which looks like a task/issue tracking identifier; tracking IDs should not appear in code documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.StoreAndForward/StoreAndForwardStorage.cs +LINE: 88 +CATEGORY: TrackingReferenceInComment +SEVERITY: Warning +MEMBER: Comment +SIGNATURE: Task 18 +MESSAGE: Comment contains 'Task 18', which looks like a project tracking reference; bookkeeping references should not appear in code documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.StoreAndForward/StoreAndForwardStorage.cs +LINE: 375 +CATEGORY: MissingParam +SEVERITY: Warning +MEMBER: Method +SIGNATURE: GetMessagesForRetryAsync(int limit) +MESSAGE: Method 'GetMessagesForRetryAsync(int limit)' is missing documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.TemplateEngine/Flattening/FlatteningService.cs +LINE: 912 +CATEGORY: TaskReferenceInComment +SEVERITY: Warning +MEMBER: Comment +SIGNATURE: depth-1 +MESSAGE: Comment contains 'depth-1', which looks like a task/issue tracking identifier; tracking IDs should not appear in code documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.TemplateEngine/Flattening/RevisionHashService.cs +LINE: 22 +CATEGORY: TaskReferenceInComment +SEVERITY: Warning +MEMBER: Comment +SIGNATURE: TemplateEngine-011 +MESSAGE: Comment contains 'TemplateEngine-011', which looks like a task/issue tracking identifier; tracking IDs should not appear in code documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.TemplateEngine/TemplateService.cs +LINE: 1235 +CATEGORY: MissingReturns +SEVERITY: Warning +MEMBER: Method +SIGNATURE: ReconcileDescendantsAsync(int templateId, string user, CancellationToken cancellationToken) +MESSAGE: Method 'ReconcileDescendantsAsync(int templateId, string user, CancellationToken cancellationToken)' returns a value but is missing . + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.TemplateEngine/TemplateService.cs +LINE: 1565 +CATEGORY: MissingDoc +SEVERITY: Error +MEMBER: Property +SIGNATURE: Any +MESSAGE: Property 'Any' is missing XML documentation + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.TemplateEngine/TemplateService.cs +LINE: 1567 +CATEGORY: MissingDoc +SEVERITY: Error +MEMBER: Method +SIGNATURE: Add(ReconcileCounts other) +MESSAGE: Method 'Add(ReconcileCounts other)' is missing XML documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.TemplateEngine/Validation/ScriptCompiler.cs +LINE: 46 +CATEGORY: TrackingReferenceInComment +SEVERITY: Warning +MEMBER: Comment +SIGNATURE: #05 +MESSAGE: Comment contains '#05', which looks like a project tracking reference; bookkeeping references should not appear in code documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.TemplateEngine/Validation/ScriptCompileVerdictCache.cs +LINE: 48 +CATEGORY: MissingParam +SEVERITY: Warning +MEMBER: Method +SIGNATURE: GetOrAdd(string code, Func<(bool Ok, string? Error)> factory) +MESSAGE: Method 'GetOrAdd(string code, Func<(bool Ok, string? Error)> factory)' is missing documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.TemplateEngine/Validation/ScriptCompileVerdictCache.cs +LINE: 48 +CATEGORY: MissingParam +SEVERITY: Warning +MEMBER: Method +SIGNATURE: GetOrAdd(string code, Func<(bool Ok, string? Error)> factory) +MESSAGE: Method 'GetOrAdd(string code, Func<(bool Ok, string? Error)> factory)' is missing documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.TemplateEngine/Validation/ScriptCompileVerdictCache.cs +LINE: 48 +CATEGORY: MissingReturns +SEVERITY: Warning +MEMBER: Method +SIGNATURE: GetOrAdd(string code, Func<(bool Ok, string? Error)> factory) +MESSAGE: Method 'GetOrAdd(string code, Func<(bool Ok, string? Error)> factory)' returns a value but is missing . + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.TemplateEngine/Validation/SemanticValidator.cs +LINE: 122 +CATEGORY: TrackingReferenceInComment +SEVERITY: Warning +MEMBER: Comment +SIGNATURE: #05 +MESSAGE: Comment contains '#05', which looks like a project tracking reference; bookkeeping references should not appear in code documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.Transport/Encryption/BundleManifestAad.cs +LINE: 18 +CATEGORY: TaskReferenceInComment +SEVERITY: Warning +MEMBER: Comment +SIGNATURE: Step-4 +MESSAGE: Comment contains 'Step-4', which looks like a task/issue tracking identifier; tracking IDs should not appear in code documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.Transport/Import/ArtifactDiff.cs +LINE: 56 +CATEGORY: TrackingReferenceInComment +SEVERITY: Warning +MEMBER: Comment +SIGNATURE: #05 +MESSAGE: Comment contains '#05', which looks like a project tracking reference; bookkeeping references should not appear in code documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.Transport/Import/ArtifactDiff.cs +LINE: 88 +CATEGORY: TrackingReferenceInComment +SEVERITY: Warning +MEMBER: Comment +SIGNATURE: #05 +MESSAGE: Comment contains '#05', which looks like a project tracking reference; bookkeeping references should not appear in code documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.Transport/Import/ArtifactDiff.cs +LINE: 682 +CATEGORY: TrackingReferenceInComment +SEVERITY: Warning +MEMBER: Comment +SIGNATURE: #05 +MESSAGE: Comment contains '#05', which looks like a project tracking reference; bookkeeping references should not appear in code documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.Transport/Import/BundleImporter.cs +LINE: 262 +CATEGORY: TaskReferenceInComment +SEVERITY: Warning +MEMBER: Comment +SIGNATURE: Step-4 +MESSAGE: Comment contains 'Step-4', which looks like a task/issue tracking identifier; tracking IDs should not appear in code documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.Transport/Import/BundleImporter.cs +LINE: 395 +CATEGORY: TrackingReferenceInComment +SEVERITY: Warning +MEMBER: Comment +SIGNATURE: #05 +MESSAGE: Comment contains '#05', which looks like a project tracking reference; bookkeeping references should not appear in code documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.Transport/Import/BundleImporter.cs +LINE: 793 +CATEGORY: TrackingReferenceInComment +SEVERITY: Warning +MEMBER: Comment +SIGNATURE: #05 +MESSAGE: Comment contains '#05', which looks like a project tracking reference; bookkeeping references should not appear in code documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.Transport/Import/BundleImporter.cs +LINE: 866 +CATEGORY: TrackingReferenceInComment +SEVERITY: Warning +MEMBER: Comment +SIGNATURE: #05 +MESSAGE: Comment contains '#05', which looks like a project tracking reference; bookkeeping references should not appear in code documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.Transport/Import/BundleImporter.cs +LINE: 969 +CATEGORY: TrackingReferenceInComment +SEVERITY: Warning +MEMBER: Comment +SIGNATURE: #05 +MESSAGE: Comment contains '#05', which looks like a project tracking reference; bookkeeping references should not appear in code documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.Transport/Import/BundleImporter.cs +LINE: 1091 +CATEGORY: TrackingReferenceInComment +SEVERITY: Warning +MEMBER: Comment +SIGNATURE: #05 +MESSAGE: Comment contains '#05', which looks like a project tracking reference; bookkeeping references should not appear in code documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.Transport/Import/BundleImporter.cs +LINE: 1365 +CATEGORY: TrackingReferenceInComment +SEVERITY: Warning +MEMBER: Comment +SIGNATURE: #05 +MESSAGE: Comment contains '#05', which looks like a project tracking reference; bookkeeping references should not appear in code documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.Transport/Import/BundleImporter.cs +LINE: 1800 +CATEGORY: TrackingReferenceInComment +SEVERITY: Warning +MEMBER: Comment +SIGNATURE: #05 +MESSAGE: Comment contains '#05', which looks like a project tracking reference; bookkeeping references should not appear in code documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.Transport/Import/BundleImporter.cs +LINE: 1959 +CATEGORY: TrackingReferenceInComment +SEVERITY: Warning +MEMBER: Comment +SIGNATURE: #05 +MESSAGE: Comment contains '#05', which looks like a project tracking reference; bookkeeping references should not appear in code documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.Transport/Import/BundleImporter.cs +LINE: 2050 +CATEGORY: TrackingReferenceInComment +SEVERITY: Warning +MEMBER: Comment +SIGNATURE: #05 +MESSAGE: Comment contains '#05', which looks like a project tracking reference; bookkeeping references should not appear in code documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.Transport/Import/BundleImporter.cs +LINE: 2074 +CATEGORY: TrackingReferenceInComment +SEVERITY: Warning +MEMBER: Comment +SIGNATURE: #05 +MESSAGE: Comment contains '#05', which looks like a project tracking reference; bookkeeping references should not appear in code documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.Transport/Import/BundleImporter.cs +LINE: 2190 +CATEGORY: TrackingReferenceInComment +SEVERITY: Warning +MEMBER: Comment +SIGNATURE: #05 +MESSAGE: Comment contains '#05', which looks like a project tracking reference; bookkeeping references should not appear in code documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.Transport/Import/BundleImporter.cs +LINE: 2256 +CATEGORY: TrackingReferenceInComment +SEVERITY: Warning +MEMBER: Comment +SIGNATURE: #05 +MESSAGE: Comment contains '#05', which looks like a project tracking reference; bookkeeping references should not appear in code documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.Transport/Import/BundleImporter.cs +LINE: 2298 +CATEGORY: TrackingReferenceInComment +SEVERITY: Warning +MEMBER: Comment +SIGNATURE: #05 +MESSAGE: Comment contains '#05', which looks like a project tracking reference; bookkeeping references should not appear in code documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.Transport/Import/BundleImporter.cs +LINE: 4339 +CATEGORY: TrackingReferenceInComment +SEVERITY: Warning +MEMBER: Comment +SIGNATURE: Task 15 +MESSAGE: Comment contains 'Task 15', which looks like a project tracking reference; bookkeeping references should not appear in code documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.Transport/Import/BundleImporter.cs +LINE: 4339 +CATEGORY: TaskReferenceInComment +SEVERITY: Warning +MEMBER: Comment +SIGNATURE: Pass-1 +MESSAGE: Comment contains 'Pass-1', which looks like a task/issue tracking identifier; tracking IDs should not appear in code documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.Transport/Import/BundleImporter.cs +LINE: 4410 +CATEGORY: TrackingReferenceInComment +SEVERITY: Warning +MEMBER: Comment +SIGNATURE: #05 +MESSAGE: Comment contains '#05', which looks like a project tracking reference; bookkeeping references should not appear in code documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.Transport/Import/BundleSessionStore.cs +LINE: 76 +CATEGORY: TrackingReferenceInComment +SEVERITY: Warning +MEMBER: Comment +SIGNATURE: #05 +MESSAGE: Comment contains '#05', which looks like a project tracking reference; bookkeeping references should not appear in code documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.Transport/Import/LineDiffer.cs +LINE: 76 +CATEGORY: MissingReturns +SEVERITY: Warning +MEMBER: Method +SIGNATURE: Diff(string? oldText, string? newText, int maxLines) +MESSAGE: Method 'Diff(string? oldText, string? newText, int maxLines)' returns a value but is missing . + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.Transport/Import/TemplateChildEquality.cs +LINE: 7 +CATEGORY: TrackingReferenceInComment +SEVERITY: Warning +MEMBER: Comment +SIGNATURE: #05 +MESSAGE: Comment contains '#05', which looks like a project tracking reference; bookkeeping references should not appear in code documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.Transport/Import/TemplateChildEquality.cs +LINE: 32 +CATEGORY: MissingParam +SEVERITY: Warning +MEMBER: Method +SIGNATURE: AttributesEqual(TemplateAttribute e, TemplateAttributeDto i) +MESSAGE: Method 'AttributesEqual(TemplateAttribute e, TemplateAttributeDto i)' is missing documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.Transport/Import/TemplateChildEquality.cs +LINE: 32 +CATEGORY: MissingParam +SEVERITY: Warning +MEMBER: Method +SIGNATURE: AttributesEqual(TemplateAttribute e, TemplateAttributeDto i) +MESSAGE: Method 'AttributesEqual(TemplateAttribute e, TemplateAttributeDto i)' is missing documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.Transport/Import/TemplateChildEquality.cs +LINE: 32 +CATEGORY: MissingReturns +SEVERITY: Warning +MEMBER: Method +SIGNATURE: AttributesEqual(TemplateAttribute e, TemplateAttributeDto i) +MESSAGE: Method 'AttributesEqual(TemplateAttribute e, TemplateAttributeDto i)' returns a value but is missing . + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.Transport/Import/TemplateChildEquality.cs +LINE: 50 +CATEGORY: MissingParam +SEVERITY: Warning +MEMBER: Method +SIGNATURE: AlarmsEqual(TemplateAlarm e, TemplateAlarmDto i, Func scriptNameById) +MESSAGE: Method 'AlarmsEqual(TemplateAlarm e, TemplateAlarmDto i, Func scriptNameById)' is missing documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.Transport/Import/TemplateChildEquality.cs +LINE: 50 +CATEGORY: MissingParam +SEVERITY: Warning +MEMBER: Method +SIGNATURE: AlarmsEqual(TemplateAlarm e, TemplateAlarmDto i, Func scriptNameById) +MESSAGE: Method 'AlarmsEqual(TemplateAlarm e, TemplateAlarmDto i, Func scriptNameById)' is missing documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.Transport/Import/TemplateChildEquality.cs +LINE: 50 +CATEGORY: MissingParam +SEVERITY: Warning +MEMBER: Method +SIGNATURE: AlarmsEqual(TemplateAlarm e, TemplateAlarmDto i, Func scriptNameById) +MESSAGE: Method 'AlarmsEqual(TemplateAlarm e, TemplateAlarmDto i, Func scriptNameById)' is missing documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.Transport/Import/TemplateChildEquality.cs +LINE: 50 +CATEGORY: MissingReturns +SEVERITY: Warning +MEMBER: Method +SIGNATURE: AlarmsEqual(TemplateAlarm e, TemplateAlarmDto i, Func scriptNameById) +MESSAGE: Method 'AlarmsEqual(TemplateAlarm e, TemplateAlarmDto i, Func scriptNameById)' returns a value but is missing . + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.Transport/Import/TemplateChildEquality.cs +LINE: 64 +CATEGORY: MissingParam +SEVERITY: Warning +MEMBER: Method +SIGNATURE: ScriptsEqual(TemplateScript e, TemplateScriptDto i) +MESSAGE: Method 'ScriptsEqual(TemplateScript e, TemplateScriptDto i)' is missing documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.Transport/Import/TemplateChildEquality.cs +LINE: 64 +CATEGORY: MissingParam +SEVERITY: Warning +MEMBER: Method +SIGNATURE: ScriptsEqual(TemplateScript e, TemplateScriptDto i) +MESSAGE: Method 'ScriptsEqual(TemplateScript e, TemplateScriptDto i)' is missing documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.Transport/Import/TemplateChildEquality.cs +LINE: 64 +CATEGORY: MissingReturns +SEVERITY: Warning +MEMBER: Method +SIGNATURE: ScriptsEqual(TemplateScript e, TemplateScriptDto i) +MESSAGE: Method 'ScriptsEqual(TemplateScript e, TemplateScriptDto i)' returns a value but is missing . + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.Transport/Import/TemplateChildEquality.cs +LINE: 80 +CATEGORY: MissingParam +SEVERITY: Warning +MEMBER: Method +SIGNATURE: NativeAlarmSourcesEqual(TemplateNativeAlarmSource e, TemplateNativeAlarmSourceDto i) +MESSAGE: Method 'NativeAlarmSourcesEqual(TemplateNativeAlarmSource e, TemplateNativeAlarmSourceDto i)' is missing documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.Transport/Import/TemplateChildEquality.cs +LINE: 80 +CATEGORY: MissingParam +SEVERITY: Warning +MEMBER: Method +SIGNATURE: NativeAlarmSourcesEqual(TemplateNativeAlarmSource e, TemplateNativeAlarmSourceDto i) +MESSAGE: Method 'NativeAlarmSourcesEqual(TemplateNativeAlarmSource e, TemplateNativeAlarmSourceDto i)' is missing documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.Transport/Import/TemplateChildEquality.cs +LINE: 80 +CATEGORY: MissingReturns +SEVERITY: Warning +MEMBER: Method +SIGNATURE: NativeAlarmSourcesEqual(TemplateNativeAlarmSource e, TemplateNativeAlarmSourceDto i) +MESSAGE: Method 'NativeAlarmSourcesEqual(TemplateNativeAlarmSource e, TemplateNativeAlarmSourceDto i)' returns a value but is missing . + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.Transport/Import/TemplateChildEquality.cs +LINE: 94 +CATEGORY: MissingParam +SEVERITY: Warning +MEMBER: Method +SIGNATURE: ScriptNameResolver(IEnumerable scripts) +MESSAGE: Method 'ScriptNameResolver(IEnumerable scripts)' is missing documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.Transport/Import/TemplateChildEquality.cs +LINE: 94 +CATEGORY: MissingReturns +SEVERITY: Warning +MEMBER: Method +SIGNATURE: ScriptNameResolver(IEnumerable scripts) +MESSAGE: Method 'ScriptNameResolver(IEnumerable scripts)' returns a value but is missing . + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.Transport/Serialization/BundleSerializer.cs +LINE: 87 +CATEGORY: TaskReferenceInComment +SEVERITY: Warning +MEMBER: Comment +SIGNATURE: Step-4 +MESSAGE: Comment contains 'Step-4', which looks like a task/issue tracking identifier; tracking IDs should not appear in code documentation. + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.Transport/Serialization/EntityDtos.cs +LINE: 34 +CATEGORY: MissingDoc +SEVERITY: Error +MEMBER: Property +SIGNATURE: Sites +MESSAGE: Property 'Sites' is missing XML documentation + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.Transport/Serialization/EntityDtos.cs +LINE: 35 +CATEGORY: MissingDoc +SEVERITY: Error +MEMBER: Property +SIGNATURE: DataConnections +MESSAGE: Property 'DataConnections' is missing XML documentation + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.Transport/Serialization/EntityDtos.cs +LINE: 36 +CATEGORY: MissingDoc +SEVERITY: Error +MEMBER: Property +SIGNATURE: Instances +MESSAGE: Property 'Instances' is missing XML documentation + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.Transport/Serialization/EntityDtos.cs +LINE: 43 +CATEGORY: MissingDoc +SEVERITY: Error +MEMBER: Property +SIGNATURE: SmsConfigurations +MESSAGE: Property 'SmsConfigurations' is missing XML documentation + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.Transport/Serialization/EntityDtos.cs +LINE: 51 +CATEGORY: MissingDoc +SEVERITY: Error +MEMBER: Property +SIGNATURE: AreaNameById +MESSAGE: Property 'AreaNameById' is missing XML documentation + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.Transport/Serialization/EntityDtos.cs +LINE: 93 +CATEGORY: MissingDoc +SEVERITY: Error +MEMBER: Property +SIGNATURE: Sites +MESSAGE: Property 'Sites' is missing XML documentation + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.Transport/Serialization/EntityDtos.cs +LINE: 94 +CATEGORY: MissingDoc +SEVERITY: Error +MEMBER: Property +SIGNATURE: DataConnections +MESSAGE: Property 'DataConnections' is missing XML documentation + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.Transport/Serialization/EntityDtos.cs +LINE: 95 +CATEGORY: MissingDoc +SEVERITY: Error +MEMBER: Property +SIGNATURE: Instances +MESSAGE: Property 'Instances' is missing XML documentation + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.Transport/Serialization/EntityDtos.cs +LINE: 106 +CATEGORY: MissingDoc +SEVERITY: Error +MEMBER: Property +SIGNATURE: SmsConfigs +MESSAGE: Property 'SmsConfigs' is missing XML documentation + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.Transport/Serialization/EntityDtos.cs +LINE: 143 +CATEGORY: MissingDoc +SEVERITY: Error +MEMBER: Property +SIGNATURE: NativeAlarmSources +MESSAGE: Property 'NativeAlarmSources' is missing XML documentation + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.Transport/Serialization/ImportValueNormalizer.cs +LINE: 35 +CATEGORY: MissingReturns +SEVERITY: Warning +MEMBER: Method +SIGNATURE: NormalizeListValue(string? value, DataType dataType, DataType? elementType, ILogger? logger, string? attributeName) +MESSAGE: Method 'NormalizeListValue(string? value, DataType dataType, DataType? elementType, ILogger? logger, string? attributeName)' returns a value but is missing . + +--- + +FILE: /Users/dohertj2/Desktop/ScadaBridge/src/ZB.MOM.WW.ScadaBridge.Transport/TransportOptions.cs +LINE: 32 +CATEGORY: TrackingReferenceInComment +SEVERITY: Warning +MEMBER: Comment +SIGNATURE: #05 +MESSAGE: Comment contains '#05', which looks like a project tracking reference; bookkeeping references should not appear in code documentation. + diff --git a/deferred.md b/deferred.md new file mode 100644 index 00000000..cf8c02c0 --- /dev/null +++ b/deferred.md @@ -0,0 +1,44 @@ +# Remaining Deferred Work + +Source: `docs/plans/2026-07-08-deferred-work-register.md` (snapshot 2026-07-10). +Everything in the register's "Fix-now" table is already landed via the archreview +plans; what's left are the intentional deferrals below. + +## Product / roadmap-locked (revisit needs a decision or a trigger event) + +| # | Item | Why deferred | Revisit trigger | +|---|------|--------------|-----------------| +| 8 | Hash-chain tamper evidence (CLI `verify-chain` is a no-op stub) | v1.x by locked decision — append-only DB roles are the current control | A compliance requirement for cryptographic tamper evidence | +| 9 | Parquet audit archival (endpoint returns `501`) | v1.x — the `501` + CLI messaging are honest, not broken | AuditLog partition volume nears the retention ceiling | +| 11 | Central-persisted OPC UA cert-trust audit | Broadcast-to-both-nodes already covers HA | A governance/audit requirement for trust decisions | +| 19 | Bundle signing / cluster-to-cluster pull / differential bundles | v1 manifest hash + AES-GCM held sufficient | A non-repudiation requirement across orgs | +| 17 | Unified notifications + site-calls outbox page | Explicit M9 decision to keep two pages | Operator confusion reports | +| 18 | Folder drag-drop | Permanently closed — menu reorder shipped instead | — (closed) | + +## Scale / YAGNI (deferred until load justifies it) + +| # | Item | Why deferred | Revisit trigger | Status | +|---|------|--------------|-----------------|--------| +| 10 | Aggregated live alarm stream for Alarm Summary | Snapshot fan-out is acceptable at current instance counts | Latency complaints or >~50 instances/site | ✅ **SHIPPED + MERGED to main 2026-07-10** (`8c888f13`, plan `docs/plans/2026-07-10-aggregated-live-alarm-stream-plan.md`, T1–T8). Transient per-site in-memory live cache (`ISiteAlarmLiveCache`/`SiteAlarmAggregatorActor`) seeded by snapshot fan-out + additive `SubscribeSite` alarm-only gRPC stream; live-cache-driven Alarm Summary with 15s poll fallback; `[PERM]` no-central-store honored (code-reviewer-confirmed); validated options + telemetry; end-to-end trace. Register row moved to Resolved. | +| 22 | KPI history hourly rollups | 90-day retention already bounds the table | `KpiSample` query latency on dashboards | ✅ **SHIPPED + MERGED to main 2026-07-10** (`8c888f13`, plan `docs/plans/2026-07-10-kpi-history-hourly-rollups-plan.md`, T1–T8). Separate `KpiRollupHourly` table (migration `20260710153953`), recorder hourly fold w/ failover-safe lookback re-fold + idempotent upsert, per-metric gauge-vs-rate aggregation, range-threshold query routing (`RollupThresholdHours` 168h), longer rollup retention (365 ≥ 90) + dual purge, one-shot backfill, and 30 d/90 d window buttons. Register row moved to Resolved. | + +## Low-priority polish (near-complete, small remainder) + +| # | Item | Why deferred | Revisit trigger | +|---|------|--------------|-----------------| +| 12 | Native-alarm-source-override CSV import — Central UI upload button only | CLI + Management API + parser shipped 2026-07-10; the Blazor upload affordance is the only piece left, and it's pure polish (needs a live Blazor smoke) | First request to bulk-import native sources from the UI instead of the CLI | + +## New deferrals from review 08 (engineering debt, no defect) + +| Item | Why deferred | Revisit trigger | +|------|--------------|-----------------| +| Communication → HealthMonitoring layering inversion | Moving the interface + `SiteHealthState` to Commons ripples across 5 projects for a cosmetic inversion | Next breaking change to `ICentralHealthAggregator` | +| Reference docs for ScriptAnalysis, KpiHistory, DelmiaNotifier | Full StyleGuide-conformant docs are substantial; README claim was scoped instead (PLAN-08 T10) | Next doc-writing session touching those components | +| Test-coverage backfill: SiteCallAudit.Tests, DeploymentManager.Tests | No defect identified; coverage partly lives in ManagementService/Host/Integration suites | First regression escaping either component | +| Failover-timing + broader perf envelope (S&F drain rate, per-subscriber backpressure) | Needs the PLAN-01 two-node rig; placeholder harness already shipped (PLAN-08 T8) | PLAN-01 rig landing | + +--- + +Summary: 12 open deferrals (13th, folder drag-drop #18, is permanently closed). +None are currently actionable without a triggering event or product decision — +except row #12's UI upload button, whose CLI/API/parser core already shipped.