@noyrax/documentation-system-plugin 1.0.4-beta.3 → 1.0.4-beta.5

package/docs/modules/src__extension.ts.md

@@ -1,418 +0,0 @@
-# Modul: src/extension.ts
-
-## Relevante ADRs
-
-- [ADR-008: dependencies-cache-phase1](../adr/008-dependencies-cache-phase1.md)
-- [ADR-009: consolidation-union-logic-phase1-2](../adr/009-consolidation-union-logic-phase1-2.md)
-- [ADR-010: extension-union-integration-phase1-3-and-phase2](../adr/010-extension-union-integration-phase1-3-and-phase2.md)
-- [ADR-011: module-doc-change-tracking-phase3](../adr/011-module-doc-change-tracking-phase3.md)
-- [ADR-012: git-deletions-change-report-phase4](../adr/012-git-deletions-change-report-phase4.md)
-- [ADR-013: system-functionality-fixes](../adr/013-system-functionality-fixes.md)
-- [ADR-027: Scanner-Excludes und Union-Logik Fix](../adr/027-scanner-excludes-and-union-logic-fix.md)
-- [ADR-028: Vollständige `src`-Abdeckung, Union-Logik & Resync-Strategie](../adr/028-src-coverage-union-resync.md)
-- [ADR-029: Parser-Flow-Kopplung und Sync/Drift-Modi für die Validierung](../adr/029-parser-flow-kopplung-und-sync-drift-modi.md)
-
-<!-- change: symbol-added name="DocumentationProvider.refresh" kind="method" -->
-### class: DocumentationItem
-Rolle: other (Sichtbarkeit: public, Priorität: normal)
-Signatur: `class DocumentationItem`
-```ts
-class DocumentationItem
-```
-
-<!-- change: symbol-added name="DocumentationProvider.getDocumentationFiles" kind="method" -->
-### class: DocumentationProvider
-Rolle: other (Sichtbarkeit: public, Priorität: normal)
-Signatur: `class DocumentationProvider`
-```ts
-class DocumentationProvider
-```
-
-Diese Klasse bündelt 4 Methoden. Die detaillierten Signaturen sind in den nachfolgenden `method:`-Abschnitten dokumentiert.
-
-<!-- change: symbol-added name="activate" kind="function" -->
-### interface: SearchResult
-Rolle: domain-model (Sichtbarkeit: public, Priorität: high)
-Signatur: `interface SearchResult {
-  file: string;
-  module: string;
-  matches: Array<{
-        line: number;
-        content: string;
-        context: string;
-    }>;
-  score: number;
-}`
-```ts
-interface SearchResult {
-  file: string;
-  module: string;
-  matches: Array<{
-        line: number;
-        content: string;
-        context: string;
-    }>;
-  score: number;
-}
-```
-
-Eigenschaften:
-
-| Name | Typ | Optional |
-|------|-----|----------|
-| `file` | `string` | nein |
-| `matches` | `Array<{
-        line: number;
-        content: string;
-        context: string;
-    }>` | nein |
-| `module` | `string` | nein |
-| `score` | `number` | nein |
-
-<!-- change: symbol-added name="checkDriftTs" kind="function" -->
-### interface: ValidationResult
-Rolle: domain-model (Sichtbarkeit: public, Priorität: high)
-Signatur: `interface ValidationResult {
-  total_files: number;
-  valid_files: number;
-  invalid_files: number;
-  warnings: string[];
-  errors: string[];
-  status?: any;
-  file_results: Array<{
-        file: string;
-        valid: boolean;
-        warnings: string[];
-        errors: string[];
-        checks: Record<string, any>;
-    }>;
-}`
-```ts
-interface ValidationResult {
-  total_files: number;
-  valid_files: number;
-  invalid_files: number;
-  warnings: string[];
-  errors: string[];
-  status?: any;
-  file_results: Array<{
-        file: string;
-        valid: boolean;
-        warnings: string[];
-        errors: string[];
-        checks: Record<string, any>;
-    }>;
-}
-```
-
-Eigenschaften:
-
-| Name | Typ | Optional |
-|------|-----|----------|
-| `errors` | `string[]` | nein |
-| `file_results` | `Array<{
-        file: string;
-        valid: boolean;
-        warnings: string[];
-        errors: string[];
-        checks: Record<string, any>;
-    }>` | nein |
-| `invalid_files` | `number` | nein |
-| `status` | `any` | ja |
-| `total_files` | `number` | nein |
-| `valid_files` | `number` | nein |
-| `warnings` | `string[]` | nein |
-
-<!-- change: symbol-added name="deactivate" kind="function" -->
-### method: DocumentationProvider.getChildren
-Rolle: other (Sichtbarkeit: public, Priorität: normal)
-Signatur: `getChildren(element: DocumentationItem): Thenable<DocumentationItem[]>`
-```ts
-getChildren(element: DocumentationItem): Thenable<DocumentationItem[]>
-```
-
-Parameter:
-
-| Name | Typ | Optional | Default |
-|------|-----|----------|---------|
-| `element` | `DocumentationItem` | nein | nein |
-
-Rückgabewert: `Thenable<DocumentationItem[]>`
-
-<!-- change: symbol-added name="escapeHtml" kind="function" -->
-### method: DocumentationProvider.getTreeItem
-Rolle: other (Sichtbarkeit: public, Priorität: normal)
-Signatur: `getTreeItem(element: DocumentationItem): vscode.TreeItem`
-```ts
-getTreeItem(element: DocumentationItem): vscode.TreeItem
-```
-
-Parameter:
-
-| Name | Typ | Optional | Default |
-|------|-----|----------|---------|
-| `element` | `DocumentationItem` | nein | nein |
-
-Rückgabewert: `vscode.TreeItem`
-
-<!-- change: symbol-added name="findSourceDirectories" kind="function" -->
-### method: DocumentationProvider.refresh
-Rolle: other (Sichtbarkeit: public, Priorität: normal)
-Signatur: `refresh(): void`
-```ts
-refresh(): void
-```
-
-Rückgabewert: `void`
-
-<!-- change: symbol-added name="generateDocumentationTs" kind="function" -->
-### method: DocumentationProvider.getDocumentationFiles
-Rolle: other (Sichtbarkeit: internal, Priorität: low)
-Signatur: `getDocumentationFiles(): Promise<DocumentationItem[]>`
-```ts
-getDocumentationFiles(): Promise<DocumentationItem[]>
-```
-
-Rückgabewert: `Promise<DocumentationItem[]>`
-
-<!-- change: symbol-added name="getConfig" kind="function" -->
-### function: activate
-Rolle: other (Sichtbarkeit: public, Priorität: normal)
-Signatur: `activate(context: vscode.ExtensionContext): void`
-```ts
-activate(context: vscode.ExtensionContext): void
-```
-
-Parameter:
-
-| Name | Typ | Optional | Default |
-|------|-----|----------|---------|
-| `context` | `vscode.ExtensionContext` | nein | nein |
-
-Rückgabewert: `void`
-
-<!-- change: symbol-added name="loadEnv" kind="function" -->
-### function: checkDriftTs
-Rolle: other (Sichtbarkeit: public, Priorität: normal)
-Signatur: `checkDriftTs(): any`
-```ts
-checkDriftTs(): any
-```
-
-Rückgabewert: `any`
-
-<!-- change: symbol-added name="openDocumentationFile" kind="function" -->
-### function: deactivate
-Rolle: other (Sichtbarkeit: public, Priorität: normal)
-Signatur: `deactivate(): void`
-```ts
-deactivate(): void
-```
-
-Rückgabewert: `void`
-
-<!-- change: symbol-added name="registerCommand" kind="function" -->
-### function: escapeHtml
-Rolle: other (Sichtbarkeit: public, Priorität: normal)
-Signatur: `escapeHtml(text: string): string`
-```ts
-escapeHtml(text: string): string
-```
-
-Parameter:
-
-| Name | Typ | Optional | Default |
-|------|-----|----------|---------|
-| `text` | `string` | nein | nein |
-
-Rückgabewert: `string`
-
-<!-- change: symbol-added name="scanSystemTs" kind="function" -->
-### function: findSourceDirectories
-Rolle: other (Sichtbarkeit: public, Priorität: normal)
-Signatur: `findSourceDirectories(workspaceRoot: string): string[]`
-```ts
-findSourceDirectories(workspaceRoot: string): string[]
-```
-
-Parameter:
-
-| Name | Typ | Optional | Default |
-|------|-----|----------|---------|
-| `workspaceRoot` | `string` | nein | nein |
-
-Rückgabewert: `string[]`
-
-<!-- change: symbol-added name="searchDocumentation" kind="function" -->
-### function: generateDocumentationTs
-Rolle: other (Sichtbarkeit: public, Priorität: normal)
-Signatur: `generateDocumentationTs(): any`
-```ts
-generateDocumentationTs(): any
-```
-
-Rückgabewert: `any`
-
-<!-- change: symbol-added name="showSearchResults" kind="function" -->
-### function: getConfig
-Rolle: other (Sichtbarkeit: public, Priorität: normal)
-Signatur: `getConfig(): { workspaceRoot: any; outputPath: string; }`
-```ts
-getConfig(): { workspaceRoot: any; outputPath: string; }
-```
-
-Rückgabewert: `{ workspaceRoot: any; outputPath: string; }`
-
-<!-- change: symbol-added name="showSystemOverview" kind="function" -->
-### function: loadEnv
-Rolle: other (Sichtbarkeit: public, Priorität: normal)
-Signatur: `loadEnv(envFile: string): Record<string, string>`
-```ts
-loadEnv(envFile: string): Record<string, string>
-```
-
-Parameter:
-
-| Name | Typ | Optional | Default |
-|------|-----|----------|---------|
-| `envFile` | `string` | nein | nein |
-
-Rückgabewert: `Record<string, string>`
-
-<!-- change: symbol-added name="showValidationResults" kind="function" -->
-### function: openDocumentationFile
-Rolle: other (Sichtbarkeit: public, Priorität: normal)
-Signatur: `openDocumentationFile(): any`
-```ts
-openDocumentationFile(): any
-```
-
-Rückgabewert: `any`
-
-<!-- change: symbol-added name="syncDocumentation" kind="function" -->
-### function: registerCommand
-Rolle: other (Sichtbarkeit: public, Priorität: normal)
-Signatur: `registerCommand(context: vscode.ExtensionContext, command: string, title: string, callback: (...args: any[]) => any): void`
-```ts
-registerCommand(context: vscode.ExtensionContext, command: string, title: string, callback: (...args: any[]) => any): void
-```
-
-Parameter:
-
-| Name | Typ | Optional | Default |
-|------|-----|----------|---------|
-| `callback` | `(...args: any[]) => any` | nein | nein |
-| `command` | `string` | nein | nein |
-| `context` | `vscode.ExtensionContext` | nein | nein |
-| `title` | `string` | nein | nein |
-
-Rückgabewert: `void`
-
-<!-- change: symbol-added name="validateDocumentationTs" kind="function" -->
-### function: scanSystemTs
-Rolle: other (Sichtbarkeit: public, Priorität: normal)
-Signatur: `scanSystemTs(): any`
-```ts
-scanSystemTs(): any
-```
-
-Rückgabewert: `any`
-
-<!-- change: symbol-added name="DocumentationProvider.onDidChangeTreeData" kind="variable" -->
-### function: searchDocumentation
-Rolle: other (Sichtbarkeit: public, Priorität: normal)
-Signatur: `searchDocumentation(): any`
-```ts
-searchDocumentation(): any
-```
-
-Rückgabewert: `any`
-
-<!-- change: symbol-added name="globalOutput" kind="variable" -->
-### function: showSearchResults
-Rolle: other (Sichtbarkeit: public, Priorität: normal)
-Signatur: `showSearchResults(results: SearchResult[], query: string): void`
-```ts
-showSearchResults(results: SearchResult[], query: string): void
-```
-
-Parameter:
-
-| Name | Typ | Optional | Default |
-|------|-----|----------|---------|
-| `query` | `string` | nein | nein |
-| `results` | `SearchResult[]` | nein | nein |
-
-Rückgabewert: `void`
-
-<!-- change: symbol-added name="globalStatusBar" kind="variable" -->
-### function: showSystemOverview
-Rolle: other (Sichtbarkeit: public, Priorität: normal)
-Signatur: `showSystemOverview(): any`
-```ts
-showSystemOverview(): any
-```
-
-Rückgabewert: `any`
-
-<!-- change: symbol-added name="DocumentationProvider._onDidChangeTreeData" kind="variable" -->
-### function: showValidationResults
-Rolle: other (Sichtbarkeit: public, Priorität: normal)
-Signatur: `showValidationResults(results: ValidationResult): void`
-```ts
-showValidationResults(results: ValidationResult): void
-```
-
-Parameter:
-
-| Name | Typ | Optional | Default |
-|------|-----|----------|---------|
-| `results` | `ValidationResult` | nein | nein |
-
-Rückgabewert: `void`
-
-### function: syncDocumentation
-Rolle: other (Sichtbarkeit: public, Priorität: normal)
-Signatur: `syncDocumentation(): any`
-```ts
-syncDocumentation(): any
-```
-
-Rückgabewert: `any`
-
-### function: validateDocumentationTs
-Rolle: other (Sichtbarkeit: public, Priorität: normal)
-Signatur: `validateDocumentationTs(): any`
-```ts
-validateDocumentationTs(): any
-```
-
-Rückgabewert: `any`
-
-### variable: DocumentationProvider.onDidChangeTreeData
-Rolle: other (Sichtbarkeit: public, Priorität: normal)
-Signatur: `onDidChangeTreeData: vscode.Event<DocumentationItem | undefined | null | void>`
-```ts
-onDidChangeTreeData: vscode.Event<DocumentationItem | undefined | null | void>
-```
-
-### variable: globalOutput
-Rolle: other (Sichtbarkeit: public, Priorität: normal)
-Signatur: `globalOutput: vscode.OutputChannel`
-```ts
-globalOutput: vscode.OutputChannel
-```
-
-### variable: globalStatusBar
-Rolle: other (Sichtbarkeit: public, Priorität: normal)
-Signatur: `globalStatusBar: StatusBarManager`
-```ts
-globalStatusBar: StatusBarManager
-```
-
-### variable: DocumentationProvider._onDidChangeTreeData
-Rolle: other (Sichtbarkeit: internal, Priorität: low)
-Signatur: `_onDidChangeTreeData: vscode.EventEmitter<DocumentationItem | undefined | null | void>`
-```ts
-_onDidChangeTreeData: vscode.EventEmitter<DocumentationItem | undefined | null | void>
-```

package/docs/modules/src__generator__adr-linker.ts.md

@@ -1,154 +0,0 @@
-# Modul: src/generator/adr-linker.ts
-
-## Relevante ADRs
-
-- [ADR-023: ADR-Verknüpfung mit Modul-Dokumentation](../adr/023-adr-verknuepfung-modul-doku.md)
-
-<!-- change: symbol-added name="AdrLinker.parseAdrFile" kind="method" -->
-### class: AdrLinker
-Rolle: other (Sichtbarkeit: public, Priorität: normal)
-Signatur: `class AdrLinker`
-```ts
-class AdrLinker
-```
-
-Diese Klasse bündelt 6 Methoden. Die detaillierten Signaturen sind in den nachfolgenden `method:`-Abschnitten dokumentiert.
-
-<!-- change: symbol-added name="AdrLinker.adrMetadata" kind="variable" -->
-### interface: AdrMetadata
-Rolle: other (Sichtbarkeit: public, Priorität: normal)
-Signatur: `interface AdrMetadata {
-  number: string;
-  title: string;
-  fileName: string;
-}`
-```ts
-interface AdrMetadata {
-  number: string;
-  title: string;
-  fileName: string;
-}
-```
-
-Eigenschaften:
-
-| Name | Typ | Optional |
-|------|-----|----------|
-| `fileName` | `string` | nein |
-| `number` | `string` | nein |
-| `title` | `string` | nein |
-
-<!-- change: symbol-added name="AdrLinker.excludes" kind="variable" -->
-### method: AdrLinker.getAdrMetadata
-Rolle: other (Sichtbarkeit: public, Priorität: normal)
-Signatur: `getAdrMetadata(adrNumber: string): AdrMetadata | undefined`
-```ts
-getAdrMetadata(adrNumber: string): AdrMetadata | undefined
-```
-
-Parameter:
-
-| Name | Typ | Optional | Default |
-|------|-----|----------|---------|
-| `adrNumber` | `string` | nein | nein |
-
-Rückgabewert: `AdrMetadata | undefined`
-
-<!-- change: symbol-added name="AdrLinker.filePathToAdrs" kind="variable" -->
-### method: AdrLinker.getAllAdrMappings
-Rolle: other (Sichtbarkeit: public, Priorität: normal)
-Signatur: `getAllAdrMappings(): Map<string, string[]>`
-```ts
-getAllAdrMappings(): Map<string, string[]>
-```
-
-Rückgabewert: `Map<string, string[]>`
-
-<!-- change: symbol-added name="AdrLinker.overrides" kind="variable" -->
-### method: AdrLinker.getRelevantAdrs
-Rolle: other (Sichtbarkeit: public, Priorität: normal)
-Signatur: `getRelevantAdrs(filePath: string): string[]`
-```ts
-getRelevantAdrs(filePath: string): string[]
-```
-
-Parameter:
-
-| Name | Typ | Optional | Default |
-|------|-----|----------|---------|
-| `filePath` | `string` | nein | nein |
-
-Rückgabewert: `string[]`
-
-### method: AdrLinker.loadAdrMappings
-Rolle: other (Sichtbarkeit: internal, Priorität: low)
-Signatur: `loadAdrMappings(adrDir: string): void`
-```ts
-loadAdrMappings(adrDir: string): void
-```
-
-Parameter:
-
-| Name | Typ | Optional | Default |
-|------|-----|----------|---------|
-| `adrDir` | `string` | nein | nein |
-
-Rückgabewert: `void`
-
-### method: AdrLinker.loadMetadataOverrides
-Rolle: other (Sichtbarkeit: internal, Priorität: low)
-Signatur: `loadMetadataOverrides(metadataPath: string): void`
-```ts
-loadMetadataOverrides(metadataPath: string): void
-```
-
-Parameter:
-
-| Name | Typ | Optional | Default |
-|------|-----|----------|---------|
-| `metadataPath` | `string` | nein | nein |
-
-Rückgabewert: `void`
-
-### method: AdrLinker.parseAdrFile
-Rolle: other (Sichtbarkeit: internal, Priorität: low)
-Signatur: `parseAdrFile(adrPath: string): { number: string; filePaths: string[]; metadata: AdrMetadata | null }`
-```ts
-parseAdrFile(adrPath: string): { number: string; filePaths: string[]; metadata: AdrMetadata | null }
-```
-
-Parameter:
-
-| Name | Typ | Optional | Default |
-|------|-----|----------|---------|
-| `adrPath` | `string` | nein | nein |
-
-Rückgabewert: `{ number: string; filePaths: string[]; metadata: AdrMetadata | null }`
-
-### variable: AdrLinker.adrMetadata
-Rolle: other (Sichtbarkeit: internal, Priorität: low)
-Signatur: `adrMetadata: Map<string, AdrMetadata>`
-```ts
-adrMetadata: Map<string, AdrMetadata>
-```
-
-### variable: AdrLinker.excludes
-Rolle: other (Sichtbarkeit: internal, Priorität: low)
-Signatur: `excludes: Map<string, Set<string>>`
-```ts
-excludes: Map<string, Set<string>>
-```
-
-### variable: AdrLinker.filePathToAdrs
-Rolle: other (Sichtbarkeit: internal, Priorität: low)
-Signatur: `filePathToAdrs: Map<string, string[]>`
-```ts
-filePathToAdrs: Map<string, string[]>
-```
-
-### variable: AdrLinker.overrides
-Rolle: other (Sichtbarkeit: internal, Priorität: low)
-Signatur: `overrides: Map<string, string[]>`
-```ts
-overrides: Map<string, string[]>
-```

package/docs/modules/src__generator__change-report.ts.md

@@ -1,85 +0,0 @@
-# Modul: src/generator/change-report.ts
-
-## Relevante ADRs
-
-- [ADR-012: git-deletions-change-report-phase4](../adr/012-git-deletions-change-report-phase4.md)
-
-### interface: ChangeData
-Rolle: other (Sichtbarkeit: public, Priorität: normal)
-Signatur: `interface ChangeData {
-  runType: 'full' | 'incremental';
-  parsedFiles: number;
-  skippedFiles: number;
-  symbolsAdded: Array<{ filePath: string; symbolName: string; kind: string }>;
-  symbolsRemoved: Array<{ filePath: string; symbolName: string; kind: string }>;
-  symbolsChanged: Array<{ filePath: string; symbolName: string; oldSignature: string; newSignature: string }>;
-  dependenciesAdded: number;
-  dependenciesRemoved: number;
-  totalDependencies: number;
-  validationErrors: number;
-  validationWarnings: number;
-  validationDetails?: string[];
-}`
-```ts
-interface ChangeData {
-  runType: 'full' | 'incremental';
-  parsedFiles: number;
-  skippedFiles: number;
-  symbolsAdded: Array<{ filePath: string; symbolName: string; kind: string }>;
-  symbolsRemoved: Array<{ filePath: string; symbolName: string; kind: string }>;
-  symbolsChanged: Array<{ filePath: string; symbolName: string; oldSignature: string; newSignature: string }>;
-  dependenciesAdded: number;
-  dependenciesRemoved: number;
-  totalDependencies: number;
-  validationErrors: number;
-  validationWarnings: number;
-  validationDetails?: string[];
-}
-```
-
-Eigenschaften:
-
-| Name | Typ | Optional |
-|------|-----|----------|
-| `dependenciesAdded` | `number` | nein |
-| `dependenciesRemoved` | `number` | nein |
-| `parsedFiles` | `number` | nein |
-| `runType` | `'full' | 'incremental'` | nein |
-| `skippedFiles` | `number` | nein |
-| `symbolsAdded` | `Array<{ filePath: string; symbolName: string; kind: string }>` | nein |
-| `symbolsChanged` | `Array<{ filePath: string; symbolName: string; oldSignature: string; newSignature: string }>` | nein |
-| `symbolsRemoved` | `Array<{ filePath: string; symbolName: string; kind: string }>` | nein |
-| `totalDependencies` | `number` | nein |
-| `validationDetails` | `string[]` | ja |
-| `validationErrors` | `number` | nein |
-| `validationWarnings` | `number` | nein |
-
-### function: extractChangesFromModuleDocs
-Rolle: other (Sichtbarkeit: public, Priorität: normal)
-Signatur: `extractChangesFromModuleDocs(moduleDocs: Map<string, string>): { symbolsAdded: ChangeData['symbolsAdded']; symbolsRemoved: ChangeData['symbolsRemoved']; symbolsChanged: ChangeData['symbolsChanged']; }`
-```ts
-extractChangesFromModuleDocs(moduleDocs: Map<string, string>): { symbolsAdded: ChangeData['symbolsAdded']; symbolsRemoved: ChangeData['symbolsRemoved']; symbolsChanged: ChangeData['symbolsChanged']; }
-```
-
-Parameter:
-
-| Name | Typ | Optional | Default |
-|------|-----|----------|---------|
-| `moduleDocs` | `Map<string, string>` | nein | nein |
-
-Rückgabewert: `{ symbolsAdded: ChangeData['symbolsAdded']; symbolsRemoved: ChangeData['symbolsRemoved']; symbolsChanged: ChangeData['symbolsChanged']; }`
-
-### function: generateChangeReport
-Rolle: other (Sichtbarkeit: public, Priorität: normal)
-Signatur: `generateChangeReport(data: ChangeData): string`
-```ts
-generateChangeReport(data: ChangeData): string
-```
-
-Parameter:
-
-| Name | Typ | Optional | Default |
-|------|-----|----------|---------|
-| `data` | `ChangeData` | nein | nein |
-
-Rückgabewert: `string`