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).
This commit was merged in pull request #19.
This commit is contained in:
Joseph Doherty
@@ -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.
|
||||
|
||||
Reference in New Issue
Block a user