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

package/docs/modules/src__core__signature-formatter.ts.md

@@ -1,232 +0,0 @@
-# Modul: src/core/signature-formatter.ts
-
-## Relevante ADRs
-
-- [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-023: ADR-Verknüpfung mit Modul-Dokumentation](../adr/023-adr-verknuepfung-modul-doku.md)
-
-<!-- change: symbol-added name="SignatureFormatter.formatFunctionOrMethod" kind="method" -->
-### class: SignatureFormatter
-Rolle: other (Sichtbarkeit: public, Priorität: normal)
-Signatur: `class SignatureFormatter`
-```ts
-class SignatureFormatter
-```
-
-Diese Klasse bündelt 11 Methoden. Die detaillierten Signaturen sind in den nachfolgenden `method:`-Abschnitten dokumentiert.
-
-<!-- change: symbol-added name="SignatureFormatter.formatFunctionParameter" kind="method" -->
-### interface: CompareResult
-Rolle: domain-model (Sichtbarkeit: public, Priorität: high)
-Signatur: `interface CompareResult {
-  match: boolean;
-  reason: 'exact' | 'optional-fields' | 'generic-simplification' | 'mismatch';
-}`
-```ts
-interface CompareResult {
-  match: boolean;
-  reason: 'exact' | 'optional-fields' | 'generic-simplification' | 'mismatch';
-}
-```
-
-Eigenschaften:
-
-| Name | Typ | Optional |
-|------|-----|----------|
-| `match` | `boolean` | nein |
-| `reason` | `'exact' | 'optional-fields' | 'generic-simplification' | 'mismatch'` | nein |
-
-<!-- change: symbol-added name="SignatureFormatter.formatInterface" kind="method" -->
-### interface: CompareOptions
-Rolle: config (Sichtbarkeit: public, Priorität: normal)
-Signatur: `interface CompareOptions {
-  tolerateOptionalFields?: boolean;
-  tolerateGenericSimplification?: boolean;
-}`
-```ts
-interface CompareOptions {
-  tolerateOptionalFields?: boolean;
-  tolerateGenericSimplification?: boolean;
-}
-```
-
-Eigenschaften:
-
-| Name | Typ | Optional |
-|------|-----|----------|
-| `tolerateGenericSimplification` | `boolean` | ja |
-| `tolerateOptionalFields` | `boolean` | ja |
-
-<!-- change: symbol-added name="SignatureFormatter.formatInterfaceProperty" kind="method" -->
-### method: SignatureFormatter.compare
-Rolle: other (Sichtbarkeit: public, Priorität: normal)
-Signatur: `compare(expected: string, documented: string, options: CompareOptions = …): CompareResult`
-```ts
-compare(expected: string, documented: string, options: CompareOptions = …): CompareResult
-```
-
-Parameter:
-
-| Name | Typ | Optional | Default |
-|------|-----|----------|---------|
-| `documented` | `string` | nein | nein |
-| `expected` | `string` | nein | nein |
-| `options` | `CompareOptions` | nein | ja |
-
-Rückgabewert: `CompareResult`
-
-<!-- change: symbol-added name="SignatureFormatter.formatVariable" kind="method" -->
-### method: SignatureFormatter.formatForDoc
-Rolle: other (Sichtbarkeit: public, Priorität: normal)
-Signatur: `formatForDoc(symbol: ParsedSymbol): string`
-```ts
-formatForDoc(symbol: ParsedSymbol): string
-```
-
-Parameter:
-
-| Name | Typ | Optional | Default |
-|------|-----|----------|---------|
-| `symbol` | `ParsedSymbol` | nein | nein |
-
-Rückgabewert: `string`
-
-<!-- change: symbol-added name="SignatureFormatter.isGenericTypeSimplification" kind="method" -->
-### method: SignatureFormatter.normalize
-Rolle: other (Sichtbarkeit: public, Priorität: normal)
-Signatur: `normalize(signature: string): string`
-```ts
-normalize(signature: string): string
-```
-
-Parameter:
-
-| Name | Typ | Optional | Default |
-|------|-----|----------|---------|
-| `signature` | `string` | nein | nein |
-
-Rückgabewert: `string`
-
-<!-- change: symbol-added name="SignatureFormatter.isOptionalFieldCompatible" kind="method" -->
-### method: SignatureFormatter.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`
-
-### method: SignatureFormatter.formatFunctionOrMethod
-Rolle: other (Sichtbarkeit: internal, Priorität: low)
-Signatur: `formatFunctionOrMethod(symbol: ParsedSymbol): string`
-```ts
-formatFunctionOrMethod(symbol: ParsedSymbol): string
-```
-
-Parameter:
-
-| Name | Typ | Optional | Default |
-|------|-----|----------|---------|
-| `symbol` | `ParsedSymbol` | nein | nein |
-
-Rückgabewert: `string`
-
-### method: SignatureFormatter.formatFunctionParameter
-Rolle: other (Sichtbarkeit: internal, Priorität: low)
-Signatur: `formatFunctionParameter(p: { name: string; optional?: boolean; type?: string; hasDefault?: boolean }): string`
-```ts
-formatFunctionParameter(p: { name: string; optional?: boolean; type?: string; hasDefault?: boolean }): string
-```
-
-Parameter:
-
-| Name | Typ | Optional | Default |
-|------|-----|----------|---------|
-| `p` | `{ name: string; optional?: boolean; type?: string; hasDefault?: boolean }` | nein | nein |
-
-Rückgabewert: `string`
-
-### method: SignatureFormatter.formatInterface
-Rolle: other (Sichtbarkeit: internal, Priorität: low)
-Signatur: `formatInterface(symbol: ParsedSymbol): string`
-```ts
-formatInterface(symbol: ParsedSymbol): string
-```
-
-Parameter:
-
-| Name | Typ | Optional | Default |
-|------|-----|----------|---------|
-| `symbol` | `ParsedSymbol` | nein | nein |
-
-Rückgabewert: `string`
-
-### method: SignatureFormatter.formatInterfaceProperty
-Rolle: other (Sichtbarkeit: internal, Priorität: low)
-Signatur: `formatInterfaceProperty(p: { name: string; optional?: boolean; type?: string }): string`
-```ts
-formatInterfaceProperty(p: { name: string; optional?: boolean; type?: string }): string
-```
-
-Parameter:
-
-| Name | Typ | Optional | Default |
-|------|-----|----------|---------|
-| `p` | `{ name: string; optional?: boolean; type?: string }` | nein | nein |
-
-Rückgabewert: `string`
-
-### method: SignatureFormatter.formatVariable
-Rolle: other (Sichtbarkeit: internal, Priorität: low)
-Signatur: `formatVariable(symbol: ParsedSymbol): string`
-```ts
-formatVariable(symbol: ParsedSymbol): string
-```
-
-Parameter:
-
-| Name | Typ | Optional | Default |
-|------|-----|----------|---------|
-| `symbol` | `ParsedSymbol` | nein | nein |
-
-Rückgabewert: `string`
-
-### method: SignatureFormatter.isGenericTypeSimplification
-Rolle: other (Sichtbarkeit: internal, Priorität: low)
-Signatur: `isGenericTypeSimplification(expected: string, documented: string): boolean`
-```ts
-isGenericTypeSimplification(expected: string, documented: string): boolean
-```
-
-Parameter:
-
-| Name | Typ | Optional | Default |
-|------|-----|----------|---------|
-| `documented` | `string` | nein | nein |
-| `expected` | `string` | nein | nein |
-
-Rückgabewert: `boolean`
-
-### method: SignatureFormatter.isOptionalFieldCompatible
-Rolle: other (Sichtbarkeit: internal, Priorität: low)
-Signatur: `isOptionalFieldCompatible(expected: string, documented: string): boolean`
-```ts
-isOptionalFieldCompatible(expected: string, documented: string): boolean
-```
-
-Parameter:
-
-| Name | Typ | Optional | Default |
-|------|-----|----------|---------|
-| `documented` | `string` | nein | nein |
-| `expected` | `string` | nein | nein |
-
-Rückgabewert: `boolean`

package/docs/modules/src__core__symbol-classifier.ts.md

@@ -1,178 +0,0 @@
-# Modul: src/core/symbol-classifier.ts
-
-## Relevante ADRs
-
-- [ADR-021: Semantische API-Doku-Tiefe & SymbolClassifier](../adr/021-semantic-api-docs-and-symbol-classifier.md)
-
-<!-- change: symbol-added name="hasAnySuffix" kind="function" -->
-### interface: SymbolClassification
-Rolle: other (Sichtbarkeit: public, Priorität: normal)
-Signatur: `interface SymbolClassification {
-  visibility: SymbolVisibility;
-  role: SymbolRole;
-  priority: SymbolPriority;
-}`
-```ts
-interface SymbolClassification {
-  visibility: SymbolVisibility;
-  role: SymbolRole;
-  priority: SymbolPriority;
-}
-```
-
-Eigenschaften:
-
-| Name | Typ | Optional |
-|------|-----|----------|
-| `priority` | `SymbolPriority` | nein |
-| `role` | `SymbolRole` | nein |
-| `visibility` | `SymbolVisibility` | nein |
-
-<!-- change: symbol-added name="normalizePath" kind="function" -->
-### function: classifyPriority
-Rolle: other (Sichtbarkeit: public, Priorität: normal)
-Signatur: `classifyPriority(role: SymbolRole, visibility: SymbolVisibility): SymbolPriority`
-```ts
-classifyPriority(role: SymbolRole, visibility: SymbolVisibility): SymbolPriority
-```
-
-Parameter:
-
-| Name | Typ | Optional | Default |
-|------|-----|----------|---------|
-| `role` | `SymbolRole` | nein | nein |
-| `visibility` | `SymbolVisibility` | nein | nein |
-
-Rückgabewert: `SymbolPriority`
-
-<!-- change: symbol-added name="SymbolPriority" kind="type" -->
-### function: classifyRole
-Rolle: other (Sichtbarkeit: public, Priorität: normal)
-Signatur: `classifyRole(symbol: ParsedSymbol): SymbolRole`
-```ts
-classifyRole(symbol: ParsedSymbol): SymbolRole
-```
-
-Parameter:
-
-| Name | Typ | Optional | Default |
-|------|-----|----------|---------|
-| `symbol` | `ParsedSymbol` | nein | nein |
-
-Rückgabewert: `SymbolRole`
-
-<!-- change: symbol-added name="SymbolRole" kind="type" -->
-### function: classifySymbol
-Rolle: other (Sichtbarkeit: public, Priorität: normal)
-Signatur: `classifySymbol(symbol: ParsedSymbol): SymbolClassification`
-```ts
-classifySymbol(symbol: ParsedSymbol): SymbolClassification
-```
-
-Parameter:
-
-| Name | Typ | Optional | Default |
-|------|-----|----------|---------|
-| `symbol` | `ParsedSymbol` | nein | nein |
-
-Rückgabewert: `SymbolClassification`
-
-<!-- change: symbol-added name="SymbolVisibility" kind="type" -->
-### function: classifyVisibility
-Rolle: other (Sichtbarkeit: public, Priorität: normal)
-Signatur: `classifyVisibility(symbol: ParsedSymbol): SymbolVisibility`
-```ts
-classifyVisibility(symbol: ParsedSymbol): SymbolVisibility
-```
-
-Parameter:
-
-| Name | Typ | Optional | Default |
-|------|-----|----------|---------|
-| `symbol` | `ParsedSymbol` | nein | nein |
-
-Rückgabewert: `SymbolVisibility`
-
-### function: filePathIncludes
-Rolle: other (Sichtbarkeit: public, Priorität: normal)
-Signatur: `filePathIncludes(path: string, segments: string[]): boolean`
-```ts
-filePathIncludes(path: string, segments: string[]): boolean
-```
-
-Parameter:
-
-| Name | Typ | Optional | Default |
-|------|-----|----------|---------|
-| `path` | `string` | nein | nein |
-| `segments` | `string[]` | nein | nein |
-
-Rückgabewert: `boolean`
-
-### function: hasAnySubstring
-Rolle: other (Sichtbarkeit: public, Priorität: normal)
-Signatur: `hasAnySubstring(name: string, parts: string[]): boolean`
-```ts
-hasAnySubstring(name: string, parts: string[]): boolean
-```
-
-Parameter:
-
-| Name | Typ | Optional | Default |
-|------|-----|----------|---------|
-| `name` | `string` | nein | nein |
-| `parts` | `string[]` | nein | nein |
-
-Rückgabewert: `boolean`
-
-### function: hasAnySuffix
-Rolle: other (Sichtbarkeit: public, Priorität: normal)
-Signatur: `hasAnySuffix(name: string, suffixes: string[]): boolean`
-```ts
-hasAnySuffix(name: string, suffixes: string[]): boolean
-```
-
-Parameter:
-
-| Name | Typ | Optional | Default |
-|------|-----|----------|---------|
-| `name` | `string` | nein | nein |
-| `suffixes` | `string[]` | nein | nein |
-
-Rückgabewert: `boolean`
-
-### function: normalizePath
-Rolle: other (Sichtbarkeit: public, Priorität: normal)
-Signatur: `normalizePath(p: string): string`
-```ts
-normalizePath(p: string): string
-```
-
-Parameter:
-
-| Name | Typ | Optional | Default |
-|------|-----|----------|---------|
-| `p` | `string` | nein | nein |
-
-Rückgabewert: `string`
-
-### type: SymbolPriority
-Rolle: other (Sichtbarkeit: public, Priorität: normal)
-Signatur: `type SymbolPriority`
-```ts
-type SymbolPriority
-```
-
-### type: SymbolRole
-Rolle: other (Sichtbarkeit: public, Priorität: normal)
-Signatur: `type SymbolRole`
-```ts
-type SymbolRole
-```
-
-### type: SymbolVisibility
-Rolle: other (Sichtbarkeit: public, Priorität: normal)
-Signatur: `type SymbolVisibility`
-```ts
-type SymbolVisibility
-```

package/docs/modules/src__core__symbols.ts.md

@@ -1,31 +0,0 @@
-# Modul: src/core/symbols.ts
-
-### function: computeSignatureHash
-Rolle: other (Sichtbarkeit: public, Priorität: normal)
-Signatur: `computeSignatureHash(symbol: ParsedSymbol): string`
-```ts
-computeSignatureHash(symbol: ParsedSymbol): string
-```
-
-Parameter:
-
-| Name | Typ | Optional | Default |
-|------|-----|----------|---------|
-| `symbol` | `ParsedSymbol` | nein | nein |
-
-Rückgabewert: `string`
-
-### function: makeStableSymbolId
-Rolle: other (Sichtbarkeit: public, Priorität: normal)
-Signatur: `makeStableSymbolId(symbol: ParsedSymbol): string`
-```ts
-makeStableSymbolId(symbol: ParsedSymbol): string
-```
-
-Parameter:
-
-| Name | Typ | Optional | Default |
-|------|-----|----------|---------|
-| `symbol` | `ParsedSymbol` | nein | nein |
-
-Rückgabewert: `string`

package/docs/modules/src__drift__index.ts.md

@@ -1,53 +0,0 @@
-# Modul: src/drift/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)
-
-### interface: DriftResult
-Rolle: domain-model (Sichtbarkeit: public, Priorität: high)
-Signatur: `interface DriftResult {
-  staleSymbols: string[];
-}`
-```ts
-interface DriftResult {
-  staleSymbols: string[];
-}
-```
-
-Eigenschaften:
-
-| Name | Typ | Optional |
-|------|-----|----------|
-| `staleSymbols` | `string[]` | nein |
-
-### function: detectDrift
-Rolle: other (Sichtbarkeit: public, Priorität: normal)
-Signatur: `detectDrift(previous: SignatureCacheData | null, current: CacheEntry[]): DriftResult`
-```ts
-detectDrift(previous: SignatureCacheData | null, current: CacheEntry[]): DriftResult
-```
-
-Parameter:
-
-| Name | Typ | Optional | Default |
-|------|-----|----------|---------|
-| `current` | `CacheEntry[]` | nein | nein |
-| `previous` | `SignatureCacheData | null` | nein | nein |
-
-Rückgabewert: `DriftResult`
-
-### function: computeCacheEntries
-Rolle: infra (Sichtbarkeit: public, Priorität: low)
-Signatur: `computeCacheEntries(symbols: ParsedSymbol[]): CacheEntry[]`
-```ts
-computeCacheEntries(symbols: ParsedSymbol[]): CacheEntry[]
-```
-
-Parameter:
-
-| Name | Typ | Optional | Default |
-|------|-----|----------|---------|
-| `symbols` | `ParsedSymbol[]` | nein | nein |
-
-Rückgabewert: `CacheEntry[]`