@noyrax/documentation-system-plugin 1.0.4-beta.1

package/docs/modules/src__parsers__json-yaml.ts.md

@@ -0,0 +1,81 @@
+# Modul: src/parsers/json-yaml.ts
+
+### class: JsonYamlParser
+Rolle: other (Sichtbarkeit: public, Priorität: normal)
+Signatur: `class JsonYamlParser`
+```ts
+class JsonYamlParser
+```
+
+Diese Klasse bündelt 3 Methoden. Die detaillierten Signaturen sind in den nachfolgenden `method:`-Abschnitten dokumentiert.
+
+### method: JsonYamlParser.parse
+Rolle: other (Sichtbarkeit: public, Priorität: normal)
+Signatur: `parse(filePath: string, fileContent: string): ParsedSymbol[]`
+```ts
+parse(filePath: string, fileContent: string): ParsedSymbol[]
+```
+
+Parameter:
+
+| Name | Typ | Optional | Default |
+|------|-----|----------|---------|
+| `fileContent` | `string` | nein | nein |
+| `filePath` | `string` | nein | nein |
+
+Rückgabewert: `ParsedSymbol[]`
+
+### method: JsonYamlParser.collectFromObject
+Rolle: other (Sichtbarkeit: internal, Priorität: low)
+Signatur: `collectFromObject(obj: any, repoRel: string, out: ParsedSymbol[], lang: string): void`
+```ts
+collectFromObject(obj: any, repoRel: string, out: ParsedSymbol[], lang: string): void
+```
+
+Parameter:
+
+| Name | Typ | Optional | Default |
+|------|-----|----------|---------|
+| `lang` | `string` | nein | nein |
+| `obj` | `any` | nein | nein |
+| `out` | `ParsedSymbol[]` | nein | nein |
+| `repoRel` | `string` | nein | nein |
+
+Rückgabewert: `void`
+
+### method: JsonYamlParser.extractFrontMatter
+Rolle: other (Sichtbarkeit: internal, Priorität: low)
+Signatur: `extractFrontMatter(content: string): any | null`
+```ts
+extractFrontMatter(content: string): any | null
+```
+
+Parameter:
+
+| Name | Typ | Optional | Default |
+|------|-----|----------|---------|
+| `content` | `string` | nein | nein |
+
+Rückgabewert: `any | null`
+
+### function: asRepoRel
+Rolle: other (Sichtbarkeit: public, Priorität: normal)
+Signatur: `asRepoRel(p: string): string`
+```ts
+asRepoRel(p: string): string
+```
+
+Parameter:
+
+| Name | Typ | Optional | Default |
+|------|-----|----------|---------|
+| `p` | `string` | nein | nein |
+
+Rückgabewert: `string`
+
+### variable: JsonYamlParser.language
+Rolle: other (Sichtbarkeit: public, Priorität: normal)
+Signatur: `language: string`
+```ts
+language: string
+```

package/docs/modules/src__parsers__python.ts.md

@@ -0,0 +1,73 @@
+# Modul: src/parsers/python.ts
+
+### class: PythonParser
+Rolle: other (Sichtbarkeit: public, Priorität: normal)
+Signatur: `class PythonParser`
+```ts
+class PythonParser
+```
+
+Diese Klasse bündelt 3 Methoden. Die detaillierten Signaturen sind in den nachfolgenden `method:`-Abschnitten dokumentiert.
+
+### method: PythonParser.parse
+Rolle: other (Sichtbarkeit: public, Priorität: normal)
+Signatur: `parse(filePath: string, fileContent: string): ParsedSymbol[]`
+```ts
+parse(filePath: string, fileContent: string): ParsedSymbol[]
+```
+
+Parameter:
+
+| Name | Typ | Optional | Default |
+|------|-----|----------|---------|
+| `fileContent` | `string` | nein | nein |
+| `filePath` | `string` | nein | nein |
+
+Rückgabewert: `ParsedSymbol[]`
+
+### method: PythonParser.extractParameters
+Rolle: other (Sichtbarkeit: internal, Priorität: low)
+Signatur: `extractParameters(funcNode: Parser.SyntaxNode, source: string): Array<{ name: string; type?: string; hasDefault?: boolean }>`
+```ts
+extractParameters(funcNode: Parser.SyntaxNode, source: string): Array<{ name: string; type?: string; hasDefault?: boolean }>
+```
+
+Parameter:
+
+| Name | Typ | Optional | Default |
+|------|-----|----------|---------|
+| `funcNode` | `Parser.SyntaxNode` | nein | nein |
+| `source` | `string` | nein | nein |
+
+Rückgabewert: `Array<{ name: string; type?: string; hasDefault?: boolean }>`
+
+### method: PythonParser.getNodeText
+Rolle: other (Sichtbarkeit: internal, Priorität: low)
+Signatur: `getNodeText(node: Parser.SyntaxNode, childType: string, source: string): string | null`
+```ts
+getNodeText(node: Parser.SyntaxNode, childType: string, source: string): string | null
+```
+
+Parameter:
+
+| Name | Typ | Optional | Default |
+|------|-----|----------|---------|
+| `childType` | `string` | nein | nein |
+| `node` | `Parser.SyntaxNode` | nein | nein |
+| `source` | `string` | nein | nein |
+
+Rückgabewert: `string | null`
+
+### variable: PythonParser.language
+Rolle: other (Sichtbarkeit: public, Priorität: normal)
+Signatur: `language: string`
+```ts
+language: string
+```
+
+### variable: PythonParser.parser
+Rolle: other (Sichtbarkeit: internal, Priorität: low)
+Signatur: `parser: Parser`
+```ts
+parser: Parser
+```

package/docs/modules/src__parsers__ts-js.ts.md

@@ -0,0 +1,48 @@
+# Modul: src/parsers/ts-js.ts
+
+## Relevante ADRs
+
+- [ADR-003: Kritische Probleme in der generierten Dokumentation](../adr/003-documentation-generation-bugs.md)
+- [ADR-005: validator-generic-simplification-tightening](../adr/005-validator-generic-simplification-tightening.md)
+- [ADR-006: parser-variable-type-extraction](../adr/006-parser-variable-type-extraction.md)
+- [ADR-007: ts-parser-load-libs-for-accurate-types](../adr/007-ts-parser-load-libs-for-accurate-types.md)
+- [ADR-023: ADR-Verknüpfung mit Modul-Dokumentation](../adr/023-adr-verknuepfung-modul-doku.md)
+
+### class: TsJsParser
+Rolle: other (Sichtbarkeit: public, Priorität: normal)
+Signatur: `class TsJsParser`
+```ts
+class TsJsParser
+```
+
+Diese Klasse bündelt 1 Methoden. Die detaillierten Signaturen sind in den nachfolgenden `method:`-Abschnitten dokumentiert.
+
+### method: TsJsParser.parse
+Rolle: other (Sichtbarkeit: public, Priorität: normal)
+Signatur: `parse(filePath: string, fileContent: string): ParsedSymbol[]`
+```ts
+parse(filePath: string, fileContent: string): ParsedSymbol[]
+```
+
+Parameter:
+
+| Name | Typ | Optional | Default |
+|------|-----|----------|---------|
+| `fileContent` | `string` | nein | nein |
+| `filePath` | `string` | nein | nein |
+
+Rückgabewert: `ParsedSymbol[]`
+
+### variable: TsJsParser.language
+Rolle: other (Sichtbarkeit: public, Priorität: normal)
+Signatur: `language: string`
+```ts
+language: string
+```
+
+### variable: TsJsParser.project
+Rolle: other (Sichtbarkeit: internal, Priorität: low)
+Signatur: `project: Project`
+```ts
+project: Project
+```

package/docs/modules/src__parsers__types.ts.md

@@ -0,0 +1,99 @@
+# Modul: src/parsers/types.ts
+
+### interface: ParsedSymbol
+Rolle: other (Sichtbarkeit: public, Priorität: normal)
+Signatur: `interface ParsedSymbol {
+  language: string;
+  filePath: string;
+  fullyQualifiedName: string;
+  signature: SymbolSignature;
+  kind: 'class' | 'interface' | 'function' | 'method' | 'type' | 'enum' | 'variable' | 'module';
+}`
+```ts
+interface ParsedSymbol {
+  language: string;
+  filePath: string;
+  fullyQualifiedName: string;
+  signature: SymbolSignature;
+  kind: 'class' | 'interface' | 'function' | 'method' | 'type' | 'enum' | 'variable' | 'module';
+}
+```
+
+Eigenschaften:
+
+| Name | Typ | Optional |
+|------|-----|----------|
+| `filePath` | `string` | nein |
+| `fullyQualifiedName` | `string` | nein |
+| `kind` | `'class' | 'interface' | 'function' | 'method' | 'type' | 'enum' | 'variable' | 'module'` | nein |
+| `language` | `string` | nein |
+| `signature` | `SymbolSignature` | nein |
+
+### interface: ParserAdapter
+Rolle: other (Sichtbarkeit: public, Priorität: normal)
+Signatur: `interface ParserAdapter {
+  language: string;
+}`
+```ts
+interface ParserAdapter {
+  language: string;
+}
+```
+
+Eigenschaften:
+
+| Name | Typ | Optional |
+|------|-----|----------|
+| `language` | `string` | nein |
+
+### interface: SymbolParameter
+Rolle: other (Sichtbarkeit: public, Priorität: normal)
+Signatur: `interface SymbolParameter {
+  name: string;
+  type?: string;
+  hasDefault?: boolean;
+  optional?: boolean;
+}`
+```ts
+interface SymbolParameter {
+  name: string;
+  type?: string;
+  hasDefault?: boolean;
+  optional?: boolean;
+}
+```
+
+Eigenschaften:
+
+| Name | Typ | Optional |
+|------|-----|----------|
+| `hasDefault` | `boolean` | ja |
+| `name` | `string` | nein |
+| `optional` | `boolean` | ja |
+| `type` | `string` | ja |
+
+### interface: SymbolSignature
+Rolle: other (Sichtbarkeit: public, Priorität: normal)
+Signatur: `interface SymbolSignature {
+  name: string;
+  parameters: SymbolParameter[];
+  returnType?: string;
+  visibility?: 'public' | 'protected' | 'private' | 'package';
+}`
+```ts
+interface SymbolSignature {
+  name: string;
+  parameters: SymbolParameter[];
+  returnType?: string;
+  visibility?: 'public' | 'protected' | 'private' | 'package';
+}
+```
+
+Eigenschaften:
+
+| Name | Typ | Optional |
+|------|-----|----------|
+| `name` | `string` | nein |
+| `parameters` | `SymbolParameter[]` | nein |
+| `returnType` | `string` | ja |
+| `visibility` | `'public' | 'protected' | 'private' | 'package'` | ja |

package/docs/modules/src__ui__commands-provider.ts.md

@@ -0,0 +1,70 @@
+# Modul: src/ui/commands-provider.ts
+
+### class: CommandItem
+Rolle: other (Sichtbarkeit: public, Priorität: normal)
+Signatur: `class CommandItem`
+```ts
+class CommandItem
+```
+
+### class: CommandsProvider
+Rolle: other (Sichtbarkeit: public, Priorität: normal)
+Signatur: `class CommandsProvider`
+```ts
+class CommandsProvider
+```
+
+Diese Klasse bündelt 3 Methoden. Die detaillierten Signaturen sind in den nachfolgenden `method:`-Abschnitten dokumentiert.
+
+### method: CommandsProvider.getChildren
+Rolle: other (Sichtbarkeit: public, Priorität: normal)
+Signatur: `getChildren(element: CommandItem): Thenable<CommandItem[]>`
+```ts
+getChildren(element: CommandItem): Thenable<CommandItem[]>
+```
+
+Parameter:
+
+| Name | Typ | Optional | Default |
+|------|-----|----------|---------|
+| `element` | `CommandItem` | nein | nein |
+
+Rückgabewert: `Thenable<CommandItem[]>`
+
+### method: CommandsProvider.getTreeItem
+Rolle: other (Sichtbarkeit: public, Priorität: normal)
+Signatur: `getTreeItem(element: CommandItem): vscode.TreeItem`
+```ts
+getTreeItem(element: CommandItem): vscode.TreeItem
+```
+
+Parameter:
+
+| Name | Typ | Optional | Default |
+|------|-----|----------|---------|
+| `element` | `CommandItem` | nein | nein |
+
+Rückgabewert: `vscode.TreeItem`
+
+### method: CommandsProvider.refresh
+Rolle: other (Sichtbarkeit: public, Priorität: normal)
+Signatur: `refresh(): void`
+```ts
+refresh(): void
+```
+
+Rückgabewert: `void`
+
+### variable: CommandsProvider.onDidChangeTreeData
+Rolle: other (Sichtbarkeit: public, Priorität: normal)
+Signatur: `onDidChangeTreeData: vscode.Event<CommandItem | undefined | null | void>`
+```ts
+onDidChangeTreeData: vscode.Event<CommandItem | undefined | null | void>
+```
+
+### variable: CommandsProvider._onDidChangeTreeData
+Rolle: other (Sichtbarkeit: internal, Priorität: low)
+Signatur: `_onDidChangeTreeData: vscode.EventEmitter<CommandItem | undefined | null | void>`
+```ts
+_onDidChangeTreeData: vscode.EventEmitter<CommandItem | undefined | null | void>
+```

package/docs/modules/src__ui__status-bar.ts.md

@@ -0,0 +1,79 @@
+# Modul: src/ui/status-bar.ts
+
+<!-- change: symbol-added name="StatusBarManager.validateButton" kind="variable" -->
+### class: StatusBarManager
+Rolle: service-api (Sichtbarkeit: public, Priorität: high)
+Signatur: `class StatusBarManager`
+```ts
+class StatusBarManager
+```
+
+Diese Klasse bündelt 3 Methoden. Die detaillierten Signaturen sind in den nachfolgenden `method:`-Abschnitten dokumentiert.
+
+### method: StatusBarManager.hideProgress
+Rolle: other (Sichtbarkeit: public, Priorität: normal)
+Signatur: `hideProgress(): void`
+```ts
+hideProgress(): void
+```
+
+Rückgabewert: `void`
+
+### method: StatusBarManager.showProgress
+Rolle: other (Sichtbarkeit: public, Priorität: normal)
+Signatur: `showProgress(operation: string): void`
+```ts
+showProgress(operation: string): void
+```
+
+Parameter:
+
+| Name | Typ | Optional | Default |
+|------|-----|----------|---------|
+| `operation` | `string` | nein | nein |
+
+Rückgabewert: `void`
+
+### method: StatusBarManager.updateStatus
+Rolle: other (Sichtbarkeit: public, Priorität: normal)
+Signatur: `updateStatus(status: 'green' | 'yellow' | 'red' | 'unknown', message: string): void`
+```ts
+updateStatus(status: 'green' | 'yellow' | 'red' | 'unknown', message: string): void
+```
+
+Parameter:
+
+| Name | Typ | Optional | Default |
+|------|-----|----------|---------|
+| `message` | `string` | nein | nein |
+| `status` | `'green' | 'yellow' | 'red' | 'unknown'` | nein | nein |
+
+Rückgabewert: `void`
+
+### variable: StatusBarManager.generateButton
+Rolle: other (Sichtbarkeit: internal, Priorität: low)
+Signatur: `generateButton: vscode.StatusBarItem`
+```ts
+generateButton: vscode.StatusBarItem
+```
+
+### variable: StatusBarManager.scanButton
+Rolle: other (Sichtbarkeit: internal, Priorität: low)
+Signatur: `scanButton: vscode.StatusBarItem`
+```ts
+scanButton: vscode.StatusBarItem
+```
+
+### variable: StatusBarManager.statusIndicator
+Rolle: other (Sichtbarkeit: internal, Priorität: low)
+Signatur: `statusIndicator: vscode.StatusBarItem`
+```ts
+statusIndicator: vscode.StatusBarItem
+```
+
+### variable: StatusBarManager.validateButton
+Rolle: other (Sichtbarkeit: internal, Priorität: low)
+Signatur: `validateButton: vscode.StatusBarItem`
+```ts
+validateButton: vscode.StatusBarItem
+```

package/docs/modules/src__validator__index.ts.md

@@ -0,0 +1,211 @@
+# Modul: src/validator/index.ts
+
+## Relevante ADRs
+
+- [ADR-002: Datei-spezifische Signatur-Validierung und Release 1.0.1](../adr/002-file-specific-validation-1.0.1.md)
+- [ADR-025: MCP-Server Tools Scan/Validate – CLI-Bridge-Pattern](../adr/025-mcp-tools-scan-validate-cli-bridge.md)
+
+<!-- change: symbol-added name="validateMarkdownContent" kind="function" -->
+### interface: CoverageMetrics
+Rolle: infra (Sichtbarkeit: public, Priorität: low)
+Signatur: `interface CoverageMetrics {
+  totalClasses: number;
+  documentedClasses: number;
+  totalInterfaces: number;
+  documentedInterfaces: number;
+  totalMethods: number;
+  documentedMethods: number;
+  totalFunctions: number;
+  documentedFunctions: number;
+}`
+```ts
+interface CoverageMetrics {
+  totalClasses: number;
+  documentedClasses: number;
+  totalInterfaces: number;
+  documentedInterfaces: number;
+  totalMethods: number;
+  documentedMethods: number;
+  totalFunctions: number;
+  documentedFunctions: number;
+}
+```
+
+Eigenschaften:
+
+| Name | Typ | Optional |
+|------|-----|----------|
+| `documentedClasses` | `number` | nein |
+| `documentedFunctions` | `number` | nein |
+| `documentedInterfaces` | `number` | nein |
+| `documentedMethods` | `number` | nein |
+| `totalClasses` | `number` | nein |
+| `totalFunctions` | `number` | nein |
+| `totalInterfaces` | `number` | nein |
+| `totalMethods` | `number` | nein |
+
+<!-- change: symbol-added name="validateMarkdownDir" kind="function" -->
+### interface: CoverageReport
+Rolle: infra (Sichtbarkeit: public, Priorität: low)
+Signatur: `interface CoverageReport {
+  metrics: CoverageMetrics;
+  errors: string[];
+  warnings: string[];
+}`
+```ts
+interface CoverageReport {
+  metrics: CoverageMetrics;
+  errors: string[];
+  warnings: string[];
+}
+```
+
+Eigenschaften:
+
+| Name | Typ | Optional |
+|------|-----|----------|
+| `errors` | `string[]` | nein |
+| `metrics` | `CoverageMetrics` | nein |
+| `warnings` | `string[]` | nein |
+
+<!-- change: symbol-added name="validateSymbols" kind="function" -->
+### interface: CoverageThresholds
+Rolle: infra (Sichtbarkeit: public, Priorität: low)
+Signatur: `interface CoverageThresholds {
+  classes: number;
+  interfaces: number;
+  methods: number;
+  functions: number;
+}`
+```ts
+interface CoverageThresholds {
+  classes: number;
+  interfaces: number;
+  methods: number;
+  functions: number;
+}
+```
+
+Eigenschaften:
+
+| Name | Typ | Optional |
+|------|-----|----------|
+| `classes` | `number` | nein |
+| `functions` | `number` | nein |
+| `interfaces` | `number` | nein |
+| `methods` | `number` | nein |
+
+### interface: MarkdownDirReport
+Rolle: infra (Sichtbarkeit: public, Priorität: low)
+Signatur: `interface MarkdownDirReport {
+  errors: string[];
+  warnings: string[];
+  files: Array<{ file: string; errors: string[]; warnings: string[] }>;
+  mismatchesCount?: number;
+}`
+```ts
+interface MarkdownDirReport {
+  errors: string[];
+  warnings: string[];
+  files: Array<{ file: string; errors: string[]; warnings: string[] }>;
+  mismatchesCount?: number;
+}
+```
+
+Eigenschaften:
+
+| Name | Typ | Optional |
+|------|-----|----------|
+| `errors` | `string[]` | nein |
+| `files` | `Array<{ file: string; errors: string[]; warnings: string[] }>` | nein |
+| `mismatchesCount` | `number` | ja |
+| `warnings` | `string[]` | nein |
+
+### interface: ValidationReport
+Rolle: infra (Sichtbarkeit: public, Priorität: low)
+Signatur: `interface ValidationReport {
+  totalSymbols: number;
+  errors: string[];
+  warnings: string[];
+  status?: StatusReport;
+}`
+```ts
+interface ValidationReport {
+  totalSymbols: number;
+  errors: string[];
+  warnings: string[];
+  status?: StatusReport;
+}
+```
+
+Eigenschaften:
+
+| Name | Typ | Optional |
+|------|-----|----------|
+| `errors` | `string[]` | nein |
+| `status` | `StatusReport` | ja |
+| `totalSymbols` | `number` | nein |
+| `warnings` | `string[]` | nein |
+
+### function: computeCoverage
+Rolle: infra (Sichtbarkeit: public, Priorität: low)
+Signatur: `computeCoverage(symbols: ParsedSymbol[], modulesDir: string, thresholds: CoverageThresholds = …): CoverageReport`
+```ts
+computeCoverage(symbols: ParsedSymbol[], modulesDir: string, thresholds: CoverageThresholds = …): CoverageReport
+```
+
+Parameter:
+
+| Name | Typ | Optional | Default |
+|------|-----|----------|---------|
+| `modulesDir` | `string` | nein | nein |
+| `symbols` | `ParsedSymbol[]` | nein | nein |
+| `thresholds` | `CoverageThresholds` | nein | ja |
+
+Rückgabewert: `CoverageReport`
+
+### function: validateMarkdownContent
+Rolle: infra (Sichtbarkeit: public, Priorität: low)
+Signatur: `validateMarkdownContent(md: string): { errors: string[]; warnings: string[] }`
+```ts
+validateMarkdownContent(md: string): { errors: string[]; warnings: string[] }
+```
+
+Parameter:
+
+| Name | Typ | Optional | Default |
+|------|-----|----------|---------|
+| `md` | `string` | nein | nein |
+
+Rückgabewert: `{ errors: string[]; warnings: string[] }`
+
+### function: validateMarkdownDir
+Rolle: infra (Sichtbarkeit: public, Priorität: low)
+Signatur: `validateMarkdownDir(modulesDir: string, symbols: ParsedSymbol[]): MarkdownDirReport`
+```ts
+validateMarkdownDir(modulesDir: string, symbols: ParsedSymbol[]): MarkdownDirReport
+```
+
+Parameter:
+
+| Name | Typ | Optional | Default |
+|------|-----|----------|---------|
+| `modulesDir` | `string` | nein | nein |
+| `symbols` | `ParsedSymbol[]` | nein | nein |
+
+Rückgabewert: `MarkdownDirReport`
+
+### function: validateSymbols
+Rolle: infra (Sichtbarkeit: public, Priorität: low)
+Signatur: `validateSymbols(symbols: ParsedSymbol[]): ValidationReport`
+```ts
+validateSymbols(symbols: ParsedSymbol[]): ValidationReport
+```
+
+Parameter:
+
+| Name | Typ | Optional | Default |
+|------|-----|----------|---------|
+| `symbols` | `ParsedSymbol[]` | nein | nein |
+
+Rückgabewert: `ValidationReport`