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

package/docs/modules/src__generator__dependency-graph.ts.md

@@ -0,0 +1,63 @@
+# Modul: src/generator/dependency-graph.ts
+
+### function: appendDependencySection
+Rolle: other (Sichtbarkeit: public, Priorität: normal)
+Signatur: `appendDependencySection(lines: string[], title: string, deps: ModuleDependency[]): void`
+```ts
+appendDependencySection(lines: string[], title: string, deps: ModuleDependency[]): void
+```
+
+Parameter:
+
+| Name | Typ | Optional | Default |
+|------|-----|----------|---------|
+| `deps` | `ModuleDependency[]` | nein | nein |
+| `lines` | `string[]` | nein | nein |
+| `title` | `string` | nein | nein |
+
+Rückgabewert: `void`
+
+### function: generateDependencyOverview
+Rolle: other (Sichtbarkeit: public, Priorität: normal)
+Signatur: `generateDependencyOverview(dependencies: ModuleDependency[]): string`
+```ts
+generateDependencyOverview(dependencies: ModuleDependency[]): string
+```
+
+Parameter:
+
+| Name | Typ | Optional | Default |
+|------|-----|----------|---------|
+| `dependencies` | `ModuleDependency[]` | nein | nein |
+
+Rückgabewert: `string`
+
+### function: generateMermaidGraph
+Rolle: other (Sichtbarkeit: public, Priorität: normal)
+Signatur: `generateMermaidGraph(dependencies: ModuleDependency[]): string`
+```ts
+generateMermaidGraph(dependencies: ModuleDependency[]): string
+```
+
+Parameter:
+
+| Name | Typ | Optional | Default |
+|------|-----|----------|---------|
+| `dependencies` | `ModuleDependency[]` | nein | nein |
+
+Rückgabewert: `string`
+
+### function: groupDependenciesByFrom
+Rolle: other (Sichtbarkeit: public, Priorität: normal)
+Signatur: `groupDependenciesByFrom(dependencies: ModuleDependency[]): Map<string, ModuleDependency[]>`
+```ts
+groupDependenciesByFrom(dependencies: ModuleDependency[]): Map<string, ModuleDependency[]>
+```
+
+Parameter:
+
+| Name | Typ | Optional | Default |
+|------|-----|----------|---------|
+| `dependencies` | `ModuleDependency[]` | nein | nein |
+
+Rückgabewert: `Map<string, ModuleDependency[]>`

package/docs/modules/src__generator__index.ts.md

@@ -0,0 +1,40 @@
+# Modul: src/generator/index.ts
+
+## Relevante ADRs
+
+- [ADR-003: Kritische Probleme in der generierten Dokumentation](../adr/003-documentation-generation-bugs.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-023: ADR-Verknüpfung mit Modul-Dokumentation](../adr/023-adr-verknuepfung-modul-doku.md)
+
+### function: generatePerFileDocs
+Rolle: other (Sichtbarkeit: public, Priorität: normal)
+Signatur: `generatePerFileDocs(symbols: ParsedSymbol[], modulesDir: string, existingDocs: Map<string, string>): Map<string, string>`
+```ts
+generatePerFileDocs(symbols: ParsedSymbol[], modulesDir: string, existingDocs: Map<string, string>): Map<string, string>
+```
+
+Parameter:
+
+| Name | Typ | Optional | Default |
+|------|-----|----------|---------|
+| `existingDocs` | `Map<string, string>` | nein | nein |
+| `modulesDir` | `string` | nein | nein |
+| `symbols` | `ParsedSymbol[]` | nein | nein |
+
+Rückgabewert: `Map<string, string>`
+
+### function: makeSafeFileName
+Rolle: other (Sichtbarkeit: public, Priorität: normal)
+Signatur: `makeSafeFileName(filePath: string): string`
+```ts
+makeSafeFileName(filePath: string): string
+```
+
+Parameter:
+
+| Name | Typ | Optional | Default |
+|------|-----|----------|---------|
+| `filePath` | `string` | nein | nein |
+
+Rückgabewert: `string`

package/docs/modules/src__generator__module-doc.ts.md

@@ -0,0 +1,242 @@
+# Modul: src/generator/module-doc.ts
+
+## Relevante ADRs
+
+- [ADR-011: module-doc-change-tracking-phase3](../adr/011-module-doc-change-tracking-phase3.md)
+- [ADR-019: System-Schwachstellen-Analyse und proaktive Fixes](../adr/019-system-schwachstellen-analyse-und-fixes.md)
+- [ADR-020: API-Doku-Tiefe & zentrale Signatur-Formatierung](../adr/020-api-doc-tiefe-und-signatureformatter.md)
+- [ADR-021: Semantische API-Doku-Tiefe & SymbolClassifier](../adr/021-semantic-api-docs-and-symbol-classifier.md)
+- [ADR-022: semantic-class-and-constants-rendering](../adr/022-semantic-class-and-constants-rendering.md)
+- [ADR-023: ADR-Verknüpfung mit Modul-Dokumentation](../adr/023-adr-verknuepfung-modul-doku.md)
+
+<!-- change: symbol-added name="isTrivialNormalizedSignature" kind="function" -->
+### interface: ModuleDoc
+Rolle: other (Sichtbarkeit: public, Priorität: normal)
+Signatur: `interface ModuleDoc {
+  blocks: ModuleDocBlock[];
+}`
+```ts
+interface ModuleDoc {
+  blocks: ModuleDocBlock[];
+}
+```
+
+Eigenschaften:
+
+| Name | Typ | Optional |
+|------|-----|----------|
+| `blocks` | `ModuleDocBlock[]` | nein |
+
+<!-- change: symbol-added name="normalizeSignature" kind="function" -->
+### interface: ModuleDocBlock
+Rolle: other (Sichtbarkeit: public, Priorität: normal)
+Signatur: `interface ModuleDocBlock {
+  comment: string;
+  symbol: ParsedSymbol;
+}`
+```ts
+interface ModuleDocBlock {
+  comment: string;
+  symbol: ParsedSymbol;
+}
+```
+
+Eigenschaften:
+
+| Name | Typ | Optional |
+|------|-----|----------|
+| `comment` | `string` | nein |
+| `symbol` | `ParsedSymbol` | nein |
+
+<!-- change: symbol-added name="parseModuleDoc" kind="function" -->
+### interface: ParsedBlock
+Rolle: other (Sichtbarkeit: public, Priorität: normal)
+Signatur: `interface ParsedBlock {
+  fullyQualifiedName: string;
+  kind: ParsedSymbol['kind'];
+  signature: SymbolSignature;
+  comment: string;
+  symbol: ParsedSymbol;
+}`
+```ts
+interface ParsedBlock {
+  fullyQualifiedName: string;
+  kind: ParsedSymbol['kind'];
+  signature: SymbolSignature;
+  comment: string;
+  symbol: ParsedSymbol;
+}
+```
+
+Eigenschaften:
+
+| Name | Typ | Optional |
+|------|-----|----------|
+| `comment` | `string` | nein |
+| `fullyQualifiedName` | `string` | nein |
+| `kind` | `ParsedSymbol['kind']` | nein |
+| `signature` | `SymbolSignature` | nein |
+| `symbol` | `ParsedSymbol` | nein |
+
+<!-- change: symbol-added name="parseSignatureFromCode" kind="function" -->
+### interface: ParsedModuleDoc
+Rolle: other (Sichtbarkeit: public, Priorität: normal)
+Signatur: `interface ParsedModuleDoc {
+  blocks: ParsedBlock[];
+}`
+```ts
+interface ParsedModuleDoc {
+  blocks: ParsedBlock[];
+}
+```
+
+Eigenschaften:
+
+| Name | Typ | Optional |
+|------|-----|----------|
+| `blocks` | `ParsedBlock[]` | nein |
+
+<!-- change: symbol-added name="renderModuleDoc" kind="function" -->
+### function: buildModuleDocWithChanges
+Rolle: other (Sichtbarkeit: public, Priorität: normal)
+Signatur: `buildModuleDocWithChanges(symbols: ParsedSymbol[], existingDoc: ParsedModuleDoc): ModuleDoc`
+```ts
+buildModuleDocWithChanges(symbols: ParsedSymbol[], existingDoc: ParsedModuleDoc): ModuleDoc
+```
+
+Parameter:
+
+| Name | Typ | Optional | Default |
+|------|-----|----------|---------|
+| `existingDoc` | `ParsedModuleDoc` | nein | nein |
+| `symbols` | `ParsedSymbol[]` | nein | nein |
+
+Rückgabewert: `ModuleDoc`
+
+<!-- change: symbol-added name="signatureChanged" kind="function" -->
+### function: compareBlocks
+Rolle: other (Sichtbarkeit: public, Priorität: normal)
+Signatur: `compareBlocks(a: ModuleDocBlock, b: ModuleDocBlock): number`
+```ts
+compareBlocks(a: ModuleDocBlock, b: ModuleDocBlock): number
+```
+
+Parameter:
+
+| Name | Typ | Optional | Default |
+|------|-----|----------|---------|
+| `a` | `ModuleDocBlock` | nein | nein |
+| `b` | `ModuleDocBlock` | nein | nein |
+
+Rückgabewert: `number`
+
+<!-- change: symbol-added name="isFormatterMigration" kind="function" -->
+### function: isTrivialNormalizedSignature
+Rolle: other (Sichtbarkeit: public, Priorität: normal)
+Signatur: `isTrivialNormalizedSignature(sig: string): boolean`
+```ts
+isTrivialNormalizedSignature(sig: string): boolean
+```
+
+Parameter:
+
+| Name | Typ | Optional | Default |
+|------|-----|----------|---------|
+| `sig` | `string` | nein | nein |
+
+Rückgabewert: `boolean`
+
+### function: normalizeSignature
+Rolle: other (Sichtbarkeit: public, Priorität: normal)
+Signatur: `normalizeSignature(sig: SymbolSignature): string`
+```ts
+normalizeSignature(sig: SymbolSignature): string
+```
+
+Parameter:
+
+| Name | Typ | Optional | Default |
+|------|-----|----------|---------|
+| `sig` | `SymbolSignature` | nein | nein |
+
+Rückgabewert: `string`
+
+### function: parseModuleDoc
+Rolle: other (Sichtbarkeit: public, Priorität: normal)
+Signatur: `parseModuleDoc(content: string): ParsedModuleDoc`
+```ts
+parseModuleDoc(content: string): ParsedModuleDoc
+```
+
+Parameter:
+
+| Name | Typ | Optional | Default |
+|------|-----|----------|---------|
+| `content` | `string` | nein | nein |
+
+Rückgabewert: `ParsedModuleDoc`
+
+### function: parseSignatureFromCode
+Rolle: other (Sichtbarkeit: public, Priorität: normal)
+Signatur: `parseSignatureFromCode(code: string, kind: ParsedSymbol['kind']): SymbolSignature`
+```ts
+parseSignatureFromCode(code: string, kind: ParsedSymbol['kind']): SymbolSignature
+```
+
+Parameter:
+
+| Name | Typ | Optional | Default |
+|------|-----|----------|---------|
+| `code` | `string` | nein | nein |
+| `kind` | `ParsedSymbol['kind']` | nein | nein |
+
+Rückgabewert: `SymbolSignature`
+
+### function: renderModuleDoc
+Rolle: other (Sichtbarkeit: public, Priorität: normal)
+Signatur: `renderModuleDoc(doc: ModuleDoc, filePath: string, adrLinker: AdrLinker): string`
+```ts
+renderModuleDoc(doc: ModuleDoc, filePath: string, adrLinker: AdrLinker): string
+```
+
+Parameter:
+
+| Name | Typ | Optional | Default |
+|------|-----|----------|---------|
+| `adrLinker` | `AdrLinker` | nein | nein |
+| `doc` | `ModuleDoc` | nein | nein |
+| `filePath` | `string` | nein | nein |
+
+Rückgabewert: `string`
+
+### function: signatureChanged
+Rolle: other (Sichtbarkeit: public, Priorität: normal)
+Signatur: `signatureChanged(a: ParsedSymbol, b: ParsedSymbol): boolean`
+```ts
+signatureChanged(a: ParsedSymbol, b: ParsedSymbol): boolean
+```
+
+Parameter:
+
+| Name | Typ | Optional | Default |
+|------|-----|----------|---------|
+| `a` | `ParsedSymbol` | nein | nein |
+| `b` | `ParsedSymbol` | nein | nein |
+
+Rückgabewert: `boolean`
+
+### function: isFormatterMigration
+Rolle: infra (Sichtbarkeit: public, Priorität: low)
+Signatur: `isFormatterMigration(oldSig: string, newSig: string): boolean`
+```ts
+isFormatterMigration(oldSig: string, newSig: string): boolean
+```
+
+Parameter:
+
+| Name | Typ | Optional | Default |
+|------|-----|----------|---------|
+| `newSig` | `string` | nein | nein |
+| `oldSig` | `string` | nein | nein |
+
+Rückgabewert: `boolean`

package/docs/modules/src__index__index.ts.md

@@ -0,0 +1,141 @@
+# Modul: src/index/index.ts
+
+## Relevante ADRs
+
+- [ADR-029: Parser-Flow-Kopplung und Sync/Drift-Modi für die Validierung](../adr/029-parser-flow-kopplung-und-sync-drift-modi.md)
+- [ADR-030: Dependency Import Symbol Names Preservation (Index JSONL)](../adr/030-dependency-import-symbol-names-preservation.md)
+- [ADR-036: Enhanced Dependency Metadata (Aliasing, Type-Only, Re-Exports)](../adr/036-enhanced-dependency-metadata.md)
+
+### interface: DependencyAccumulator
+Rolle: other (Sichtbarkeit: public, Priorität: normal)
+Signatur: `interface DependencyAccumulator {
+  module: string;
+  symbols: string[];
+  isTypeOnly: boolean;
+  isReexport: boolean;
+}`
+```ts
+interface DependencyAccumulator {
+  module: string;
+  symbols: string[];
+  isTypeOnly: boolean;
+  isReexport: boolean;
+}
+```
+
+Eigenschaften:
+
+| Name | Typ | Optional |
+|------|-----|----------|
+| `isReexport` | `boolean` | nein |
+| `isTypeOnly` | `boolean` | nein |
+| `module` | `string` | nein |
+| `symbols` | `string[]` | nein |
+
+### interface: DependencyEntry
+Rolle: other (Sichtbarkeit: public, Priorität: normal)
+Signatur: `interface DependencyEntry {
+  module: string;
+  symbols?: string[];
+  isTypeOnly?: boolean;
+  isReexport?: boolean;
+}`
+```ts
+interface DependencyEntry {
+  module: string;
+  symbols?: string[];
+  isTypeOnly?: boolean;
+  isReexport?: boolean;
+}
+```
+
+Eigenschaften:
+
+| Name | Typ | Optional |
+|------|-----|----------|
+| `isReexport` | `boolean` | ja |
+| `isTypeOnly` | `boolean` | ja |
+| `module` | `string` | nein |
+| `symbols` | `string[]` | ja |
+
+### interface: IndexRow
+Rolle: other (Sichtbarkeit: public, Priorität: normal)
+Signatur: `interface IndexRow {
+  symbol_id: string;
+  path: string;
+  kind: string;
+  name: string;
+  signature?: SymbolSignature;
+  summary?: string;
+  dependencies?: string[] | DependencyEntry[];
+}`
+```ts
+interface IndexRow {
+  symbol_id: string;
+  path: string;
+  kind: string;
+  name: string;
+  signature?: SymbolSignature;
+  summary?: string;
+  dependencies?: string[] | DependencyEntry[];
+}
+```
+
+Eigenschaften:
+
+| Name | Typ | Optional |
+|------|-----|----------|
+| `dependencies` | `string[] | DependencyEntry[]` | ja |
+| `kind` | `string` | nein |
+| `name` | `string` | nein |
+| `path` | `string` | nein |
+| `signature` | `SymbolSignature` | ja |
+| `summary` | `string` | ja |
+| `symbol_id` | `string` | nein |
+
+### function: buildIndexFromSymbols
+Rolle: other (Sichtbarkeit: public, Priorität: normal)
+Signatur: `buildIndexFromSymbols(symbols: ParsedSymbol[], dependencies: DependencyCacheEntry[] = …): IndexRow[]`
+```ts
+buildIndexFromSymbols(symbols: ParsedSymbol[], dependencies: DependencyCacheEntry[] = …): IndexRow[]
+```
+
+Parameter:
+
+| Name | Typ | Optional | Default |
+|------|-----|----------|---------|
+| `dependencies` | `DependencyCacheEntry[]` | nein | ja |
+| `symbols` | `ParsedSymbol[]` | nein | nein |
+
+Rückgabewert: `IndexRow[]`
+
+### function: readSymbolsFromIndex
+Rolle: other (Sichtbarkeit: public, Priorität: normal)
+Signatur: `readSymbolsFromIndex(indexFile: string): ParsedSymbol[]`
+```ts
+readSymbolsFromIndex(indexFile: string): ParsedSymbol[]
+```
+
+Parameter:
+
+| Name | Typ | Optional | Default |
+|------|-----|----------|---------|
+| `indexFile` | `string` | nein | nein |
+
+Rückgabewert: `ParsedSymbol[]`
+
+### function: writeJsonlIndex
+Rolle: other (Sichtbarkeit: public, Priorität: normal)
+Signatur: `writeJsonlIndex(rows: IndexRow[], outFile: string): void`
+```ts
+writeJsonlIndex(rows: IndexRow[], outFile: string): void
+```
+
+Parameter:
+
+| Name | Typ | Optional | Default |
+|------|-----|----------|---------|
+| `outFile` | `string` | nein | nein |
+| `rows` | `IndexRow[]` | nein | nein |
+
+Rückgabewert: `void`

package/docs/modules/src__logging__index.ts.md

@@ -0,0 +1,87 @@
+# Modul: src/logging/index.ts
+
+### class: Logger
+Rolle: other (Sichtbarkeit: public, Priorität: normal)
+Signatur: `class Logger`
+```ts
+class Logger
+```
+
+Diese Klasse bündelt 3 Methoden. Die detaillierten Signaturen sind in den nachfolgenden `method:`-Abschnitten dokumentiert.
+
+### interface: LoggerOptions
+Rolle: config (Sichtbarkeit: public, Priorität: normal)
+Signatur: `interface LoggerOptions {
+  component: string;
+}`
+```ts
+interface LoggerOptions {
+  component: string;
+}
+```
+
+Eigenschaften:
+
+| Name | Typ | Optional |
+|------|-----|----------|
+| `component` | `string` | nein |
+
+### method: Logger.error
+Rolle: other (Sichtbarkeit: public, Priorität: normal)
+Signatur: `error(message: string, err: unknown): void`
+```ts
+error(message: string, err: unknown): void
+```
+
+Parameter:
+
+| Name | Typ | Optional | Default |
+|------|-----|----------|---------|
+| `err` | `unknown` | nein | nein |
+| `message` | `string` | nein | nein |
+
+Rückgabewert: `void`
+
+### method: Logger.info
+Rolle: other (Sichtbarkeit: public, Priorität: normal)
+Signatur: `info(message: string): void`
+```ts
+info(message: string): void
+```
+
+Parameter:
+
+| Name | Typ | Optional | Default |
+|------|-----|----------|---------|
+| `message` | `string` | nein | nein |
+
+Rückgabewert: `void`
+
+### method: Logger.warn
+Rolle: other (Sichtbarkeit: public, Priorität: normal)
+Signatur: `warn(message: string): void`
+```ts
+warn(message: string): void
+```
+
+Parameter:
+
+| Name | Typ | Optional | Default |
+|------|-----|----------|---------|
+| `message` | `string` | nein | nein |
+
+Rückgabewert: `void`
+
+### variable: Logger.component
+Rolle: other (Sichtbarkeit: internal, Priorität: low)
+Signatur: `component: string`
+```ts
+component: string
+```
+
+### type: LogLevel
+Rolle: other (Sichtbarkeit: public, Priorität: normal)
+Signatur: `type LogLevel`
+```ts
+type LogLevel
+```

package/docs/modules/src__parsers__dependencies.ts.md

@@ -0,0 +1,69 @@
+# Modul: src/parsers/dependencies.ts
+
+## Relevante ADRs
+
+- [ADR-036: Enhanced Dependency Metadata (Aliasing, Type-Only, Re-Exports)](../adr/036-enhanced-dependency-metadata.md)
+
+### interface: ModuleDependency
+Rolle: other (Sichtbarkeit: public, Priorität: normal)
+Signatur: `interface ModuleDependency {
+  from: string;
+  to: string;
+  type: 'import' | 'export' | 'require';
+  symbols?: string[];
+  isTypeOnly?: boolean;
+  isReexport?: boolean;
+}`
+```ts
+interface ModuleDependency {
+  from: string;
+  to: string;
+  type: 'import' | 'export' | 'require';
+  symbols?: string[];
+  isTypeOnly?: boolean;
+  isReexport?: boolean;
+}
+```
+
+Eigenschaften:
+
+| Name | Typ | Optional |
+|------|-----|----------|
+| `from` | `string` | nein |
+| `isReexport` | `boolean` | ja |
+| `isTypeOnly` | `boolean` | ja |
+| `symbols` | `string[]` | ja |
+| `to` | `string` | nein |
+| `type` | `'import' | 'export' | 'require'` | nein |
+
+### function: extractPythonDependencies
+Rolle: other (Sichtbarkeit: public, Priorität: normal)
+Signatur: `extractPythonDependencies(content: string, repoRelPath: string): ModuleDependency[]`
+```ts
+extractPythonDependencies(content: string, repoRelPath: string): ModuleDependency[]
+```
+
+Parameter:
+
+| Name | Typ | Optional | Default |
+|------|-----|----------|---------|
+| `content` | `string` | nein | nein |
+| `repoRelPath` | `string` | nein | nein |
+
+Rückgabewert: `ModuleDependency[]`
+
+### function: extractTsJsDependencies
+Rolle: other (Sichtbarkeit: public, Priorität: normal)
+Signatur: `extractTsJsDependencies(sourceFile: SourceFile, repoRelPath: string): ModuleDependency[]`
+```ts
+extractTsJsDependencies(sourceFile: SourceFile, repoRelPath: string): ModuleDependency[]
+```
+
+Parameter:
+
+| Name | Typ | Optional | Default |
+|------|-----|----------|---------|
+| `repoRelPath` | `string` | nein | nein |
+| `sourceFile` | `SourceFile` | nein | nein |
+
+Rückgabewert: `ModuleDependency[]`