API Reference / @gtkx/codegen / ApiSymbol

Type Alias: ApiSymbol

ApiSymbol = object

Defined in: codegen/dist/docs/api-reference.d.ts:34

An indexed symbol, without its reference page.

Properties

kind

kind: ApiSymbolKind

Defined in: codegen/dist/docs/api-reference.d.ts:40

Kind the reference groups and filters the symbol by, "element" for a JSX tag.

---

name

name: string

Defined in: codegen/dist/docs/api-reference.d.ts:38

Name within the namespace, which for an element is its GLib type name.

---

namespace

namespace: string

Defined in: codegen/dist/docs/api-reference.d.ts:36

GIR namespace declaring the symbol, such as "Gtk".

---

summary

summary: string

Defined in: codegen/dist/docs/api-reference.d.ts:42

First sentence of the symbol's GIR documentation, elided past 220 characters and empty when it has none.