GTKX

API Reference / @gtkx/codegen / ApiSymbol

Type Alias: ApiSymbol ​

ApiSymbol = object

Defined in: packages/codegen/src/docs/api-reference.ts:63

An indexed symbol, without its reference page.

Properties ​

kind ​

kind: ApiSymbolKind

Defined in: packages/codegen/src/docs/api-reference.ts:69

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

name ​

name: string

Defined in: packages/codegen/src/docs/api-reference.ts:67

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

namespace ​

namespace: string

Defined in: packages/codegen/src/docs/api-reference.ts:65

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

summary ​

summary: string

Defined in: packages/codegen/src/docs/api-reference.ts:71

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