Interface: OxContentApiDocsResult

Result produced by API docs generation.

Signature

export interface OxContentApiDocsResult

Properties

Name	Type	Description
diagnostics	string[]	Diagnostic messages reported while extracting docs.
docs	JsDocsMarkdownModule[]	Markdown module data generated from extracted declarations.
files	Record<string, string>	Generated markdown and artifact contents keyed by relative output path.
generatedFiles	string[]	Absolute paths for files written to disk or planned when write is false.
hash	string	Hash representing the current generation options and watched input files.
nav	ApiDocsNavItem[]	Navigation metadata derived from generated docs.
resolvedOptions	ResolvedOxContentApiDocsOptions	Normalized options used for this generation run.