docs(public-api): DIN-orientierte Public-API-Dokumentation vereinheitlichen#81
Merged
tomtastisch merged 5 commits intomainfrom Feb 16, 2026
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
Vereinheitlicht die DIN-/NORM-orientierte XML-Dokumentation und das Layout der externen Public-API in src/FileTypeDetection (inkl. Catch-Filter-Form), ohne beabsichtigte Logik- oder Signaturänderungen.
Changes:
- XML-Dokumentation (summary/remarks/param/returns/exception/example) und Terminologie für Public-API-Typen vereinheitlicht.
- Signatur- und Layout-Harmonisierung (multiline Signaturen, Blocktrennung).
- Catch-Blöcke auf Catch-Filter-Form umgestellt (ohne intendierte Verhaltensänderung).
Reviewed changes
Copilot reviewed 16 out of 16 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| src/FileTypeDetection/FileTypeOptions.vb | Public-API-Doku/Remarks ergänzt; Catch-Layout in Options-Parsing/Path-Load vereinheitlicht. |
| src/FileTypeDetection/FileTypeDetector.vb | Public-API-Doku ausgebaut, Signaturlayout harmonisiert, Catch-Filter eingeführt. |
| src/FileTypeDetection/FileMaterializer.vb | Umfassende Public-API-Doku inkl. Beispiele; Catch-Filter-Umstellung (inkl. einem regressiven Log-Bug). |
| src/FileTypeDetection/EvidenceHashing.vb | XML-Doku für Hash-/RoundTrip-Fassade ergänzt; Catch-Filter-Form in Cleanup/Key-Parsing. |
| src/FileTypeDetection/Configuration/FileTypeProjectOptions.vb | Doku/Remarks zur Sicherheits- und Normalisierungslogik geschärft. |
| src/FileTypeDetection/Configuration/FileTypeProjectBaseline.vb | Baseline-Doku/Remarks und Nebenwirkungsbeschreibung ergänzt. |
| src/FileTypeDetection/ArchiveProcessing.vb | Öffentliche Archiv-Fassade dokumentiert, Parameter/Returns/Exceptions ergänzt. |
| src/FileTypeDetection/Abstractions/Hashing/HashSourceType.vb | Enum-Werte mit XML-Docs (auditierbarer Ursprungskanal) ergänzt. |
| src/FileTypeDetection/Abstractions/Hashing/HashRoundTripReport.vb | Report-Properties detailliert dokumentiert. |
| src/FileTypeDetection/Abstractions/Hashing/HashOptions.vb | Options-Doku/Remarks ergänzt (Normalisierung MaterializedFileName). |
| src/FileTypeDetection/Abstractions/Hashing/HashEvidence.vb | Evidence-Properties dokumentiert (Herkunft, Payloadkopien, Digests, Notes). |
| src/FileTypeDetection/Abstractions/Hashing/HashDigestSet.vb | Digest-Set-Properties dokumentiert (physisch/logisch, optional fast/HMAC). |
| src/FileTypeDetection/Abstractions/Detection/FileType.vb | FileType-Doku/Remarks und ToString-Doku ergänzt. |
| src/FileTypeDetection/Abstractions/Detection/FileKind.vb | Enum-Werte und fachlicher Kontext dokumentiert. |
| src/FileTypeDetection/Abstractions/Detection/DetectionDetail.vb | Detailobjekt/Properties für auditierbare Entscheidung dokumentiert. |
| src/FileTypeDetection/Abstractions/Archive/ZipExtractedEntry.vb | Entry-Modell/Properties und Stream-API dokumentiert. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Ziel & Scope
FileMaterializerund alle extern erreichbaren Public-API-Typen insrc/FileTypeDetection.src/FileTypeDetection/Infrastructure/CoreInternals.vbwurde bewusst nicht verändert.Umgesetzte Aufgaben (abhaken)
FileMaterializervollständig dokumentiert (summary,remarks,param,returns,exception,example).FileMaterializernach vorgegebenem Schema (Guard/Path/secureExtract/Raw-Fallback).Try/Catch-Layouts konsistent auf Catch-Filter-Form vereinheitlicht (ohne neue Fehlerpfade).Nachbesserungen aus Review (iterativ)
Materialize,Persist,Path,Fail-Closed).Security- und Merge-Gates
codex/docs/public-api-doku-style-rollout.docs(public-api): ....security/code-scanning/toolsmit 0 offene Alerts ist Merge-Voraussetzung; Merge erfolgt nur bei grünem Gate-Status.Evidence (auditierbar)
dotnet build FileClassifier.sln-> pass, 0 Fehler, 0 Warnungen.dotnet test FileClassifier.sln-> pass, 413/413.dotnet test tests/FileTypeDetectionLib.Tests/FileTypeDetectionLib.Tests.csproj --filter "FullyQualifiedName~PublicApiContractSnapshotTests"-> pass, 1/1.git diff -- tests/FileTypeDetectionLib.Tests/Contracts/public-api.snapshot.txt-> kein Diff.python3 tools/check-docs.py-> Doc check OK.python3 tools/check-doc-consistency.py-> Doc consistency check OK.python3 tools/check-doc-shell-compat.py-> Doc shell compatibility check OK.dotnet list FileClassifier.sln package --vulnerable --include-transitive-> keine anfälligen Pakete.bash tools/ci/check-versioning-svt.sh-> pass.bash tools/ci/check-naming-snt.sh-> pass.DoD (mindestens 2 pro Punkt)
exampleinsrc/FileTypeDetection/FileMaterializer.vbdotnet build,dotnet test)public-api.snapshot.txtohne Diff)PublicApiContractSnapshotTestserfolgreichdotnet list --vulnerable,check-versioning-svt,check-naming-snt)