ClassPageEmitter
Renders one class as a Starlight page.
The output follows the site’s own conventions: the H1 comes from the frontmatter title, so the body starts at ##; a lead paragraph precedes the first heading; internal links are root-absolute and end in a slash. Signatures are inline code rather than fenced PHP, which keeps several thousand syntax-highlighting passes out of the site build; the tables beside them carry the linked types instead.
Synopsis
Section titled “Synopsis”final class ClassPageEmitter
| Source | Emitter/ClassPageEmitter.php |
Constructor
Section titled “Constructor”__construct()
Section titled “__construct()”public function __construct(ApiIndex $index, TypeLinker $linker, Markdown $markdown = new Markdown(…)): mixed
| Parameter | Type | Description |
|---|---|---|
$index | ApiIndex | |
$linker | TypeLinker | |
$markdown | Markdown |
Returns mixed
Methods
Section titled “Methods”| Method | Description |
|---|---|
emit(ClassDoc $class): EmittedArtifact |
emit()
Section titled “emit()”public function emit(ClassDoc $class): EmittedArtifact
| Parameter | Type | Description |
|---|---|---|
$class | ClassDoc |
Returns EmittedArtifact