@gtkx/codegen 1.0.0-rc.4 → 1.1.0

package/dist/docs/render.js.map

@@ -1 +1 @@
-{"version":3,"file":"render.js","sourceRoot":"","sources":["../../src/docs/render.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AAOxD,OAAO,EAAE,uBAAuB,EAAE,cAAc,EAAE,MAAM,4BAA4B,CAAC;AACrF,OAAO,EAAE,uBAAuB,EAAE,uBAAuB,EAAE,MAAM,gCAAgC,CAAC;AAClG,OAAO,EAAE,gBAAgB,EAAE,cAAc,EAAqB,MAAM,wBAAwB,CAAC;AAC7F,OAAO,EAAE,eAAe,EAAE,aAAa,EAAE,6BAA6B,EAAE,MAAM,0BAA0B,CAAC;AACzG,OAAO,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAC;AACzD,OAAO,EAAE,aAAa,EAAE,MAAM,sBAAsB,CAAC;AACrD,OAAO,EAAE,gBAAgB,EAAE,MAAM,sBAAsB,CAAC;AAUxD,MAAM,mBAAmB,GAA2B,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC;AACnG,MAAM,UAAU,GAAG,eAAe,CAAC;AACnC,MAAM,YAAY,GAAG,WAAW,CAAC;AACjC,MAAM,kBAAkB,GAAG,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;AAC1C,MAAM,wBAAwB,GAAG,OAAO,CAAC;AAEzC,MAAM,UAAU,GAAG,CAAC,OAAgB,EAAgB,EAAE,CAClD,gBAAgB,CACZ,OAAO,EACP,CAAC,IAAI,EAAE,EAAE,CAAC,GAAG,IAAI,CAAC,aAAa,IAAI,IAAI,CAAC,QAAQ,EAAE,EAClD,GAAG,EAAE,CAAC,cAAc,CACvB,CAAC;AAEN,MAAM,cAAc,GAAG,CAAC,OAAgB,EAAE,GAAuB,EAAE,UAAmB,EAAU,EAAE;IAC9F,MAAM,IAAI,GAAG,cAAc,CAAC,OAAO,EAAE,UAAU,CAAC,OAAO,CAAC,EAAE,GAAG,CAAC,CAAC;IAE/D,OAAO,UAAU,CAAC,CAAC,CAAC,GAAG,IAAI,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC;AAChD,CAAC,CAAC;AAEF,MAAM,2BAA2B,GAAG,CAAC,OAAgB,EAAE,MAAmB,EAAU,EAAE,CAClF,uBAAuB,CAAC;IACpB,OAAO;IACP,MAAM;IACN,UAAU,EAAE,CAAC,GAAG,EAAE,QAAQ,EAAE,EAAE,CAAC,cAAc,CAAC,OAAO,EAAE,GAAG,EAAE,QAAQ,CAAC;IACrE,4BAA4B,EAAE,KAAK;IACnC,QAAQ,EAAE,IAAI;CACjB,CAAC,CAAC;AAEP,MAAM,2BAA2B,GAAG,CAAC,OAAgB,EAAE,MAAmB,EAAY,EAAE,CACpF,uBAAuB,CAAC,MAAM,CAAC,UAAU,EAAE,CAAC,GAAG,EAAE,QAAQ,EAAE,EAAE,CAAC,cAAc,CAAC,OAAO,EAAE,GAAG,EAAE,QAAQ,CAAC,CAAC,CAAC;AAE1G,MAAM,yBAAyB,GAAG,CAAC,OAAgB,EAAE,MAAmB,EAAE,QAAgB,EAAU,EAAE;IAClG,MAAM,MAAM,GAAG,CAAC,GAAG,2BAA2B,CAAC,OAAO,EAAE,MAAM,CAAC,EAAE,SAAS,QAAQ,EAAE,CAAC,CAAC;IAEtF,OAAO,IAAI,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,2BAA2B,CAAC,OAAO,EAAE,MAAM,CAAC,EAAE,CAAC;AACvF,CAAC,CAAC;AAEF,MAAM,2BAA2B,GAAG,CAAC,OAAgB,EAAE,MAAmB,EAAU,EAAE,CAClF,IAAI,2BAA2B,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,2BAA2B,CAAC,OAAO,EAAE,MAAM,CAAC,EAAE,CAAC;AAEtH,MAAM,gBAAgB,GAAG,CAAC,KAAa,EAAU,EAAE,CAAC,mBAAmB,CAAC,KAAK,CAAC,IAAI,KAAK,CAAC;AAExF,MAAM,aAAa,GAAG,CAAC,QAAgB,EAAU,EAAE,CAC/C,QAAQ;KACH,UAAU,CAAC,8BAA8B,EAAE,EAAE,CAAC;KAC9C,UAAU,CAAC,kCAAkC,EAAE,EAAE,CAAC;KAClD,UAAU,CAAC,aAAa,EAAE,EAAE,CAAC,CAAC;AAEvC,MAAM,UAAU,GAAG,CAAC,IAAY,EAAE,SAAkB,EAAwC,EAAE;IAC1F,IAAI,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;QACxB,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC,SAAS,EAAE,CAAC;IACjD,CAAC;IAED,IAAI,SAAS,EAAE,CAAC;QACZ,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC;IACrC,CAAC;IAED,OAAO,EAAE,IAAI,EAAE,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,IAAI,EAAE,CAAC,CAAC,CAAC,IAAI,EAAE,SAAS,EAAE,CAAC;AAC5E,CAAC,CAAC;AAEF,MAAM,cAAc,GAAG,CAAC,QAAgB,EAAU,EAAE;IAChD,IAAI,SAAS,GAAG,KAAK,CAAC;IACtB,MAAM,KAAK,GAAa,EAAE,CAAC;IAE3B,KAAK,MAAM,IAAI,IAAI,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC;QACtC,MAAM,MAAM,GAAG,UAAU,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC;QAC3C,SAAS,GAAG,MAAM,CAAC,SAAS,CAAC;QAC7B,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;IAC5B,CAAC;IAED,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AAC5B,CAAC,CAAC;AAEF,MAAM,WAAW,GAAG,CAAC,GAAuB,EAAU,EAAE,CACpD,GAAG,KAAK,SAAS,IAAI,GAAG,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,cAAc,CAAC,aAAa,CAAC,gBAAgB,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;AAE7G,MAAM,aAAa,GAAG,CAAC,QAAgB,EAAU,EAAE,CAC/C,QAAQ;KACH,UAAU,CAAC,iBAAiB,EAAE,GAAG,CAAC;KAClC,UAAU,CAAC,YAAY,EAAE,IAAI,CAAC;KAC9B,UAAU,CAAC,yBAAyB,EAAE,IAAI,CAAC;KAC3C,UAAU,CAAC,SAAS,EAAE,EAAE,CAAC;KACzB,UAAU,CAAC,MAAM,EAAE,GAAG,CAAC;KACvB,IAAI,EAAE,CAAC;AAEhB,MAAM,aAAa,GAAG,CAAC,GAAuB,EAAU,EAAE;IACtD,MAAM,IAAI,GAAG,aAAa,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,CAAC;IAE7C,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACpB,OAAO,EAAE,CAAC;IACd,CAAC;IAED,MAAM,KAAK,GAAG,mBAAmB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC7C,MAAM,QAAQ,GAAG,KAAK,EAAE,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC;IAEpC,OAAO,QAAQ,CAAC,MAAM,GAAG,GAAG,CAAC,CAAC,CAAC,GAAG,QAAQ,CAAC,KAAK,CAAC,CAAC,EAAE,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,QAAQ,CAAC;AAC7E,CAAC,CAAC;AAEF,MAAM,WAAW,GAAG,CAAC,SAAiB,EAAU,EAAE,CAC9C,SAAS;KACJ,UAAU,CAAC,oBAAoB,EAAE,OAAO,CAAC;KACzC,UAAU,CAAC,wBAAwB,EAAE,KAAK,CAAC;KAC3C,WAAW,EAAE,CAAC;AAEvB,MAAM,cAAc,GAAG,CAAC,KAAe,EAAY,EAAE;IACjD,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACrB,OAAO,EAAE,CAAC;IACd,CAAC;IAED,MAAM,WAAW,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,KAAK,IAAI,IAAI,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAElE,OAAO,CAAC,cAAc,WAAW,GAAG,CAAC,CAAC;AAC1C,CAAC,CAAC;AAEF,MAAM,YAAY,GAAG,CAAC,QAAkB,EAAU,EAAE,CAChD,GAAG,QAAQ,CAAC,MAAM,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC;AAEzE,MAAM,SAAS,GAAG,CAAC,IAAY,EAAE,IAAY,EAAE,GAAW,EAAU,EAAE;IAClE,MAAM,KAAK,GAAG,CAAC,SAAS,IAAI,IAAI,EAAE,EAAE,EAAE,IAAI,CAAC,CAAC;IAE5C,IAAI,GAAG,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACjB,KAAK,CAAC,IAAI,CAAC,EAAE,EAAE,GAAG,CAAC,CAAC;IACxB,CAAC;IAED,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AAC5B,CAAC,CAAC;AAEF,MAAM,cAAc,GAAG,CAAC,IAAY,EAAE,SAAiB,EAAE,KAAe,EAAU,EAAE;IAChF,MAAM,KAAK,GAAG,CAAC,SAAS,IAAI,IAAI,EAAE,EAAE,EAAE,aAAa,SAAS,UAAU,CAAC,CAAC;IAExE,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;QACvB,IAAI,IAAI,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAClB,KAAK,CAAC,IAAI,CAAC,EAAE,EAAE,IAAI,CAAC,CAAC;QACzB,CAAC;IACL,CAAC;IAED,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AAC5B,CAAC,CAAC;AAEF,MAAM,cAAc,GAAG,CAAC,IAAY,EAAU,EAAE;IAC5C,MAAM,KAAK,GAAG,kBAAkB,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IAE/C,OAAO,KAAK,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,IAAI,EAAE,CAAC,CAAC,CAAC,IAAI,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC;AAC3D,CAAC,CAAC;AAEF,MAAM,oBAAoB,GAAG,CAAC,SAAuB,EAAE,OAAgB,EAAiB,EAAE,CACtF,IAAI,aAAa,CAAC,EAAE,GAAG,SAAS,EAAE,IAAI,EAAE,wBAAwB,EAAE,EAAE,OAAO,CAAC,CAAC;AAEjF,MAAM,qBAAqB,GAAG,CAAC,OAA+B,EAAY,EAAE,CACxE,aAAa,CAAC,OAAO,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CACrD,cAAc,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,SAAS,EAAE;IACtC,IAAI,CAAC,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,UAAU,IAAI,CAAC,MAAM,KAAK;IAC3D,IAAI,CAAC,GAAG;CACX,CAAC,CACL,CAAC;AAEN,MAAM,kBAAkB,GAAG,CAAC,OAAgB,EAAE,SAAuB,EAAE,KAAe,EAAoB,EAAE;IACxG,MAAM,WAAW,GAAG,IAAI,aAAa,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC;IAC1D,MAAM,gBAAgB,GAAG,oBAAoB,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC;IAClE,MAAM,SAAS,GAAG,UAAU,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;IACzC,MAAM,SAAS,GAAG,uBAAuB,CAAC,WAAW,EAAE,KAAK,CAAC,CAAC;IAE9D,OAAO,qBAAqB,CAAC,gBAAgB,EAAE,KAAK,EAAE,CAAC,MAAM,EAAE,EAAE,CAC7D,cAAc,CAAC,WAAW,EAAE,MAAM,EAAE,SAAS,EAAE,SAAS,CAAC,CAC5D,CAAC;AACN,CAAC,CAAC;AAEF,MAAM,oBAAoB,GAAG,CAAC,OAAyB,EAAE,KAAa,EAAY,EAAE,CAChF,OAAO,CAAC,MAAM,KAAK,CAAC;IAChB,CAAC,CAAC,EAAE;IACJ,CAAC,CAAC,CAAC,YAAY,EAAE,KAAK,EAAE,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,cAAc,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,SAAS,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;AAEjH,MAAM,qBAAqB,GAAG,CAC1B,gBAA+B,EAC/B,KAAe,EACf,MAA+C,EAC/B,EAAE;IAClB,MAAM,OAAO,GAAG,eAAe,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;IAE/C,MAAM,KAAK,GAAG,aAAa,CAAC,UAAU,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE;QAChD,YAAY,EAAE,eAAe,CAAC,KAAK,CAAC,YAAY,CAAC;QACjD,SAAS,EAAE,eAAe,CAAC,KAAK,CAAC,SAAS,CAAC;QAC3C,OAAO,EAAE,OAAO;KACnB,CAAC,CAAC;IAEH,MAAM,OAAO,GAAqB,EAAE,CAAC;IAErC,KAAK,MAAM,MAAM,IAAI,OAAO,EAAE,CAAC;QAC3B,MAAM,YAAY,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC;QAEpC,MAAM,QAAQ,GAAG,6BAA6B,CAC1C,gBAAgB,EAChB,EAAE,GAAG,MAAM,EAAE,GAAG,EAAE,SAAS,EAAE,EAC7B,KAAK,EACL,YAAY,CACf,CAAC;QAEF,IAAI,QAAQ,KAAK,SAAS,EAAE,CAAC;YACzB,SAAS;QACb,CAAC;QAED,OAAO,CAAC,IAAI,CAAC;YACT,IAAI,EAAE,YAAY,IAAI,gBAAgB,CAAC,MAAM,CAAC;YAC9C,SAAS,EAAE,QAAQ,CAAC,IAAI,EAAE,CAAC,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC;YAC5C,GAAG,EAAE,WAAW,CAAC,MAAM,CAAC,GAAG,CAAC;SAC/B,CAAC,CAAC;IACP,CAAC;IAED,OAAO,aAAa,CAAC,OAAO,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;AACzD,CAAC,CAAC;AAEF,OAAO,EACH,cAAc,EACd,yBAAyB,EACzB,2BAA2B,EAC3B,gBAAgB,EAChB,WAAW,EACX,aAAa,EACb,WAAW,EACX,cAAc,EACd,YAAY,EACZ,SAAS,EACT,cAAc,EACd,cAAc,EACd,oBAAoB,EACpB,qBAAqB,EACrB,kBAAkB,EAClB,oBAAoB,EACpB,qBAAqB,GAGxB,CAAC","sourcesContent":["import { pascalCase, sortStringsBy } from \"@gtkx/utils\";\nimport type { GirClass } from \"../gir/class.js\";\nimport type { GirFunction } from \"../gir/function.js\";\nimport type { Library } from \"../gir/library.js\";\nimport type { GirNamespace } from \"../gir/namespace.js\";\nimport type { GirCallable } from \"../gir/parameter.js\";\nimport type { TypeId } from \"../gir/type-id.js\";\nimport { collectInheritedMethods, conflictRename } from \"../analysis/inheritance.js\";\nimport { renderHandlerParameters, renderHandlerResultType } from \"../analysis/param-structure.js\";\nimport { recordTypeTarget, renderBaseType, type TsTypeTarget } from \"../analysis/ts-type.js\";\nimport { dedupeCallables, instanceScope, renderInstanceMethodSignature } from \"../store/gi/callables.js\";\nimport { methodExportName } from \"../store/gi/method.js\";\nimport { ModuleContext } from \"../writer/context.js\";\nimport { gtkDocToMarkdown } from \"../writer/gtk-doc.js\";\n\ntype SignatureEntry = {\n    name: string;\n    signature: string;\n    doc: string;\n};\n\ntype OriginSignatureEntry = SignatureEntry & { origin: string | undefined };\n\nconst DOCS_DEFAULT_VALUES: Record<string, string> = { TRUE: \"true\", FALSE: \"false\", NULL: \"null\" };\nconst FENCE_LINE = /^\\s*(```|~~~)/;\nconst HEADING_LINE = /^#{1,5}\\s/;\nconst LEADING_NAMESPACES = [\"Gtk\", \"Adw\"];\nconst DOCS_SIGNATURE_NAMESPACE = \"$docs\";\n\nconst docsTarget = (library: Library): TsTypeTarget =>\n    recordTypeTarget(\n        library,\n        (name) => `${name.namespaceName}.${name.typeName}`,\n        () => \"GObject.Type\",\n    );\n\nconst renderDocsType = (library: Library, ref: TypeId | undefined, isNullable: boolean): string => {\n    const base = renderBaseType(library, docsTarget(library), ref);\n\n    return isNullable ? `${base} | null` : base;\n};\n\nconst renderDocsHandlerResultType = (library: Library, signal: GirCallable): string =>\n    renderHandlerResultType({\n        library,\n        signal,\n        renderType: (ref, nullable) => renderDocsType(library, ref, nullable),\n        shouldIncludeCallerAllocated: false,\n        isOptOut: true,\n    });\n\nconst renderDocsHandlerParameters = (library: Library, signal: GirCallable): string[] =>\n    renderHandlerParameters(signal.parameters, (ref, nullable) => renderDocsType(library, ref, nullable));\n\nconst renderDocsSignalSignature = (library: Library, signal: GirCallable, selfType: string): string => {\n    const params = [...renderDocsHandlerParameters(library, signal), `self: ${selfType}`];\n\n    return `(${params.join(\", \")}) => ${renderDocsHandlerResultType(library, signal)}`;\n};\n\nconst renderDocsSignalHandlerType = (library: Library, signal: GirCallable): string =>\n    `(${renderDocsHandlerParameters(library, signal).join(\", \")}) => ${renderDocsHandlerResultType(library, signal)}`;\n\nconst docsDefaultValue = (value: string): string => DOCS_DEFAULT_VALUES[value] ?? value;\n\nconst stripDocMedia = (markdown: string): string =>\n    markdown\n        .replaceAll(/<picture[\\s\\S]*?<\\/picture>/g, \"\")\n        .replaceAll(/<video[\\s\\S]*?(?:<\\/video>|\\/>)/g, \"\")\n        .replaceAll(/<img[^>]*>/g, \"\");\n\nconst demoteLine = (line: string, isInFence: boolean): { text: string; isInFence: boolean } => {\n    if (FENCE_LINE.test(line)) {\n        return { text: line, isInFence: !isInFence };\n    }\n\n    if (isInFence) {\n        return { text: line, isInFence };\n    }\n\n    return { text: HEADING_LINE.test(line) ? `#${line}` : line, isInFence };\n};\n\nconst demoteHeadings = (markdown: string): string => {\n    let isInFence = false;\n    const lines: string[] = [];\n\n    for (const line of markdown.split(\"\\n\")) {\n        const result = demoteLine(line, isInFence);\n        isInFence = result.isInFence;\n        lines.push(result.text);\n    }\n\n    return lines.join(\"\\n\");\n};\n\nconst docMarkdown = (doc: string | undefined): string =>\n    doc === undefined || doc.length === 0 ? \"\" : demoteHeadings(stripDocMedia(gtkDocToMarkdown(doc))).trim();\n\nconst stripMarkdown = (markdown: string): string =>\n    markdown\n        .replaceAll(/```[\\s\\S]*?```/g, \" \")\n        .replaceAll(/`([^`]*)`/g, \"$1\")\n        .replaceAll(/\\[([^[\\]]*)\\]\\([^)]*\\)/g, \"$1\")\n        .replaceAll(/[*_#>]/g, \"\")\n        .replaceAll(/\\s+/g, \" \")\n        .trim();\n\nconst firstSentence = (doc: string | undefined): string => {\n    const text = stripMarkdown(docMarkdown(doc));\n\n    if (text.length === 0) {\n        return \"\";\n    }\n\n    const match = /^.*?[.!?](?=\\s|$)/.exec(text);\n    const sentence = match?.[0] ?? text;\n\n    return sentence.length > 220 ? `${sentence.slice(0, 217)}...` : sentence;\n};\n\nconst elementSlug = (className: string): string =>\n    className\n        .replaceAll(/([a-z0-9])([A-Z])/g, \"$1-$2\")\n        .replaceAll(/([A-Z])(?=[A-Z][a-z])/g, \"$1-\")\n        .toLowerCase();\n\nconst implementsLine = (names: string[]): string[] => {\n    if (names.length === 0) {\n        return [];\n    }\n\n    const quotedNames = names.map((name) => `\\`${name}\\``).join(\", \");\n\n    return [`Implements ${quotedNames}.`];\n};\n\nconst joinSections = (sections: string[]): string =>\n    `${sections.filter((section) => section.length > 0).join(\"\\n\\n\")}\\n`;\n\nconst metaBlock = (name: string, meta: string, doc: string): string => {\n    const lines = [`### \\`${name}\\``, \"\", meta];\n\n    if (doc.length > 0) {\n        lines.push(\"\", doc);\n    }\n\n    return lines.join(\"\\n\");\n};\n\nconst signatureBlock = (name: string, signature: string, notes: string[]): string => {\n    const lines = [`### \\`${name}\\``, \"\", `\\`\\`\\`ts\\n${signature}\\n\\`\\`\\``];\n\n    for (const note of notes) {\n        if (note.length > 0) {\n            lines.push(\"\", note);\n        }\n    }\n\n    return lines.join(\"\\n\");\n};\n\nconst namespaceOrder = (name: string): string => {\n    const index = LEADING_NAMESPACES.indexOf(name);\n\n    return index === -1 ? `1${name}` : `0${String(index)}`;\n};\n\nconst docsSignatureContext = (namespace: GirNamespace, library: Library): ModuleContext =>\n    new ModuleContext({ ...namespace, name: DOCS_SIGNATURE_NAMESPACE }, library);\n\nconst originSignatureBlocks = (entries: OriginSignatureEntry[]): string[] =>\n    sortStringsBy(entries, (item) => item.name).map((item) =>\n        signatureBlock(item.name, item.signature, [\n            item.origin === undefined ? \"\" : `From \\`${item.origin}\\`.`,\n            item.doc,\n        ]),\n    );\n\nconst classMethodEntries = (library: Library, namespace: GirNamespace, klass: GirClass): SignatureEntry[] => {\n    const realContext = new ModuleContext(namespace, library);\n    const signatureContext = docsSignatureContext(namespace, library);\n    const className = pascalCase(klass.name);\n    const inherited = collectInheritedMethods(realContext, klass);\n\n    return instanceMethodEntries(signatureContext, klass, (method) =>\n        conflictRename(realContext, method, inherited, className),\n    );\n};\n\nconst methodsSectionBlocks = (entries: SignatureEntry[], intro: string): string[] =>\n    entries.length === 0\n        ? []\n        : [\"## Methods\", intro, ...entries.map((item) => signatureBlock(item.name, item.signature, [item.doc]))];\n\nconst instanceMethodEntries = (\n    signatureContext: ModuleContext,\n    klass: GirClass,\n    rename: (fn: GirFunction) => string | undefined,\n): SignatureEntry[] => {\n    const deduped = dedupeCallables(klass.methods);\n\n    const scope = instanceScope(pascalCase(klass.name), {\n        constructors: dedupeCallables(klass.constructors),\n        functions: dedupeCallables(klass.functions),\n        methods: deduped,\n    });\n\n    const entries: SignatureEntry[] = [];\n\n    for (const method of deduped) {\n        const nameOverride = rename(method);\n\n        const rendered = renderInstanceMethodSignature(\n            signatureContext,\n            { ...method, doc: undefined },\n            scope,\n            nameOverride,\n        );\n\n        if (rendered === undefined) {\n            continue;\n        }\n\n        entries.push({\n            name: nameOverride ?? methodExportName(method),\n            signature: rendered.trim().replace(/;$/, \"\"),\n            doc: docMarkdown(method.doc),\n        });\n    }\n\n    return sortStringsBy(entries, (entry) => entry.name);\n};\n\nexport {\n    renderDocsType,\n    renderDocsSignalSignature,\n    renderDocsSignalHandlerType,\n    docsDefaultValue,\n    docMarkdown,\n    firstSentence,\n    elementSlug,\n    implementsLine,\n    joinSections,\n    metaBlock,\n    signatureBlock,\n    namespaceOrder,\n    docsSignatureContext,\n    originSignatureBlocks,\n    classMethodEntries,\n    methodsSectionBlocks,\n    instanceMethodEntries,\n    type SignatureEntry,\n    type OriginSignatureEntry,\n};\n"]}
+{"version":3,"file":"render.js","sourceRoot":"","sources":["../../src/docs/render.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,sBAAsB,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AAUpE,OAAO,EAAE,uBAAuB,EAAE,cAAc,EAAE,MAAM,4BAA4B,CAAC;AACrF,OAAO,EAAE,uBAAuB,EAAE,uBAAuB,EAAE,MAAM,gCAAgC,CAAC;AAClG,OAAO,EAAE,gBAAgB,EAAE,cAAc,EAAqB,MAAM,wBAAwB,CAAC;AAC7F,OAAO,EACH,eAAe,EACf,kBAAkB,EAClB,aAAa,EACb,6BAA6B,GAChC,MAAM,0BAA0B,CAAC;AAClC,OAAO,EAAE,cAAc,EAAE,WAAW,EAAE,eAAe,EAAE,MAAM,yBAAyB,CAAC;AACvF,OAAO,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAC;AACzD,OAAO,EAAE,aAAa,EAAE,MAAM,sBAAsB,CAAC;AACrD,OAAO,EAAE,aAAa,EAAE,MAAM,uBAAuB,CAAC;AACtD,OAAO,EAAE,gBAAgB,EAAE,MAAM,sBAAsB,CAAC;AAyBxD,MAAM,mBAAmB,GAA2B,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC;AACnG,MAAM,UAAU,GAAG,eAAe,CAAC;AACnC,MAAM,YAAY,GAAG,WAAW,CAAC;AACjC,MAAM,kBAAkB,GAAG,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;AAC1C,MAAM,wBAAwB,GAAG,OAAO,CAAC;AACzC,MAAM,cAAc,GAAG,MAAM,CAAC;AAE9B,MAAM,UAAU,GAAG,CAAC,OAAgB,EAAgB,EAAE,CAClD,gBAAgB,CACZ,OAAO,EACP,CAAC,IAAI,EAAE,EAAE,CAAC,GAAG,IAAI,CAAC,aAAa,IAAI,IAAI,CAAC,QAAQ,EAAE,EAClD,GAAG,EAAE,CAAC,cAAc,CACvB,CAAC;AAEN,MAAM,cAAc,GAAG,CAAC,OAAgB,EAAE,GAAuB,EAAE,UAAmB,EAAU,EAAE;IAC9F,MAAM,IAAI,GAAG,cAAc,CAAC,OAAO,EAAE,UAAU,CAAC,OAAO,CAAC,EAAE,GAAG,CAAC,CAAC;IAE/D,OAAO,UAAU,CAAC,CAAC,CAAC,GAAG,IAAI,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC;AAChD,CAAC,CAAC;AAEF,MAAM,2BAA2B,GAAG,CAAC,OAAgB,EAAE,MAAmB,EAAU,EAAE,CAClF,uBAAuB,CAAC;IACpB,OAAO;IACP,MAAM;IACN,UAAU,EAAE,CAAC,GAAG,EAAE,QAAQ,EAAE,EAAE,CAAC,cAAc,CAAC,OAAO,EAAE,GAAG,EAAE,QAAQ,CAAC;IACrE,4BAA4B,EAAE,KAAK;IACnC,QAAQ,EAAE,IAAI;CACjB,CAAC,CAAC;AAEP,MAAM,2BAA2B,GAAG,CAAC,OAAgB,EAAE,MAAmB,EAAY,EAAE,CACpF,uBAAuB,CAAC,MAAM,CAAC,UAAU,EAAE,CAAC,GAAG,EAAE,QAAQ,EAAE,EAAE,CAAC,cAAc,CAAC,OAAO,EAAE,GAAG,EAAE,QAAQ,CAAC,CAAC,CAAC;AAE1G,MAAM,yBAAyB,GAAG,CAAC,OAAgB,EAAE,MAAmB,EAAE,QAAgB,EAAU,EAAE;IAClG,MAAM,MAAM,GAAG,CAAC,GAAG,2BAA2B,CAAC,OAAO,EAAE,MAAM,CAAC,EAAE,SAAS,QAAQ,EAAE,CAAC,CAAC;IAEtF,OAAO,IAAI,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,2BAA2B,CAAC,OAAO,EAAE,MAAM,CAAC,EAAE,CAAC;AACvF,CAAC,CAAC;AAEF,MAAM,2BAA2B,GAAG,CAAC,OAAgB,EAAE,MAAmB,EAAU,EAAE,CAClF,IAAI,2BAA2B,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,2BAA2B,CAAC,OAAO,EAAE,MAAM,CAAC,EAAE,CAAC;AAEtH,MAAM,gBAAgB,GAAG,CAAC,KAAa,EAAU,EAAE,CAAC,mBAAmB,CAAC,KAAK,CAAC,IAAI,KAAK,CAAC;AAExF,MAAM,UAAU,GAAG,CAAC,IAAY,EAAE,SAAkB,EAAwC,EAAE;IAC1F,IAAI,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;QACxB,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC,SAAS,EAAE,CAAC;IACjD,CAAC;IAED,IAAI,SAAS,EAAE,CAAC;QACZ,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC;IACrC,CAAC;IAED,OAAO,EAAE,IAAI,EAAE,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,IAAI,EAAE,CAAC,CAAC,CAAC,IAAI,EAAE,SAAS,EAAE,CAAC;AAC5E,CAAC,CAAC;AAEF,MAAM,cAAc,GAAG,CAAC,QAAgB,EAAU,EAAE;IAChD,IAAI,SAAS,GAAG,KAAK,CAAC;IACtB,MAAM,KAAK,GAAa,EAAE,CAAC;IAE3B,KAAK,MAAM,IAAI,IAAI,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC;QACtC,MAAM,MAAM,GAAG,UAAU,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC;QAC3C,SAAS,GAAG,MAAM,CAAC,SAAS,CAAC;QAC7B,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;IAC5B,CAAC;IAED,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AAC5B,CAAC,CAAC;AAEF,MAAM,WAAW,GAAG,CAAC,GAAuB,EAAU,EAAE,CACpD,GAAG,KAAK,SAAS,IAAI,GAAG,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,cAAc,CAAC,aAAa,CAAC,gBAAgB,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;AAE7G,MAAM,aAAa,GAAG,CAAC,QAAgB,EAAU,EAAE,CAC/C,QAAQ;KACH,UAAU,CAAC,iBAAiB,EAAE,GAAG,CAAC;KAClC,UAAU,CAAC,YAAY,EAAE,IAAI,CAAC;KAC9B,UAAU,CAAC,yBAAyB,EAAE,IAAI,CAAC;KAC3C,UAAU,CAAC,QAAQ,EAAE,EAAE,CAAC;KACxB,UAAU,CAAC,cAAc,EAAE,GAAG,CAAC;KAC/B,IAAI,EAAE,CAAC;AAEhB,MAAM,cAAc,GAAG,CAAC,GAAuB,EAAU,EAAE,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,UAAU,CAAC,cAAc,EAAE,GAAG,CAAC,CAAC,IAAI,EAAE,CAAC;AACpH,MAAM,SAAS,GAAG,CAAC,GAAuB,EAAU,EAAE,CAAC,aAAa,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,CAAC;AAEvF,MAAM,aAAa,GAAG,CAAC,GAAuB,EAAU,EAAE;IACtD,MAAM,IAAI,GAAG,SAAS,CAAC,GAAG,CAAC,CAAC;IAE5B,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACpB,OAAO,EAAE,CAAC;IACd,CAAC;IAED,MAAM,KAAK,GAAG,mBAAmB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC7C,MAAM,QAAQ,GAAG,KAAK,EAAE,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC;IAEpC,OAAO,QAAQ,CAAC,MAAM,GAAG,GAAG,CAAC,CAAC,CAAC,GAAG,QAAQ,CAAC,KAAK,CAAC,CAAC,EAAE,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,QAAQ,CAAC;AAC7E,CAAC,CAAC;AAEF,MAAM,WAAW,GAAG,CAAC,SAAiB,EAAU,EAAE,CAC9C,SAAS;KACJ,UAAU,CAAC,oBAAoB,EAAE,OAAO,CAAC;KACzC,UAAU,CAAC,wBAAwB,EAAE,KAAK,CAAC;KAC3C,WAAW,EAAE,CAAC;AAEvB,MAAM,cAAc,GAAG,CAAC,KAAe,EAAY,EAAE;IACjD,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACrB,OAAO,EAAE,CAAC;IACd,CAAC;IAED,MAAM,WAAW,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,KAAK,IAAI,IAAI,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAElE,OAAO,CAAC,cAAc,WAAW,GAAG,CAAC,CAAC;AAC1C,CAAC,CAAC;AAEF,MAAM,YAAY,GAAG,CAAC,QAAkB,EAAU,EAAE,CAChD,GAAG,QAAQ,CAAC,MAAM,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC;AAEzE,MAAM,UAAU,GAAG,CAAC,MAAgC,EAAY,EAAE;IAC9D,MAAM,OAAO,GAAG,CAAC,MAAM,IAAI,EAAE,CAAC;SACzB,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,EAAE,IAAI,EAAE,KAAK,CAAC,IAAI,EAAE,IAAI,EAAE,cAAc,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;SACvE,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;IAE9C,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACvB,OAAO,EAAE,CAAC;IACd,CAAC;IAED,MAAM,OAAO,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,OAAO,KAAK,CAAC,IAAI,OAAO,KAAK,CAAC,IAAI,EAAE,CAAC,CAAC;IAE7E,OAAO,CAAC,CAAC,gBAAgB,EAAE,EAAE,EAAE,GAAG,OAAO,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;AAC3D,CAAC,CAAC;AAEF,MAAM,YAAY,GAAG,CAAC,KAAa,EAAE,IAAY,EAAY,EAAE,CAAC,CAAC,IAAI,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,GAAG,KAAK,IAAI,IAAI,EAAE,CAAC,CAAC,CAAC;AAEhH,MAAM,eAAe,GAAG,CAAC,WAAyC,EAAY,EAAE;IAC5E,IAAI,WAAW,KAAK,SAAS,EAAE,CAAC;QAC5B,OAAO,EAAE,CAAC;IACd,CAAC;IAED,MAAM,KAAK,GAAG,WAAW,CAAC,KAAK,CAAC;IAChC,MAAM,OAAO,GAAG,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,iBAAiB,CAAC,CAAC,CAAC,sBAAsB,KAAK,KAAK,CAAC;IAC3F,MAAM,IAAI,GAAG,cAAc,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC;IAC7C,MAAM,IAAI,GAAG,IAAI,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,OAAO,IAAI,IAAI,EAAE,CAAC;IAEhE,OAAO,CAAC,KAAK,IAAI,EAAE,CAAC,CAAC;AACzB,CAAC,CAAC;AAEF,MAAM,SAAS,GAAG,CAAC,KAAyB,EAAY,EAAE,CACtD,KAAK,KAAK,SAAS,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,oBAAoB,KAAK,IAAI,CAAC,CAAC;AAErF,MAAM,QAAQ,GAAG,CAAC,IAA2B,EAAY,EAAE;IACvD,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;QACrB,OAAO,EAAE,CAAC;IACd,CAAC;IAED,OAAO;QACH,GAAG,UAAU,CAAC,IAAI,CAAC,MAAM,CAAC;QAC1B,GAAG,YAAY,CAAC,aAAa,EAAE,WAAW,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACzD,GAAG,YAAY,CAAC,YAAY,EAAE,cAAc,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QAC1D,GAAG,eAAe,CAAC,IAAI,CAAC,UAAU,CAAC;QACnC,GAAG,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC;KAC3B,CAAC;AACN,CAAC,CAAC;AAEF,MAAM,eAAe,GAAG,CAAC,WAA2B,EAAY,EAAE;IAC9D,IAAI,CAAC,WAAW,CAAC,YAAY,EAAE,CAAC;QAC5B,OAAO,EAAE,CAAC;IACd,CAAC;IAED,MAAM,KAAK,GAAG,WAAW,CAAC,eAAe,CAAC;IAE1C,OAAO,CAAC,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,oBAAoB,KAAK,EAAE,CAAC,CAAC;AAC9E,CAAC,CAAC;AAEF,MAAM,eAAe,GAAG,CAAC,WAA2B,EAAY,EAAE,CAAC,QAAQ,CAAC,cAAc,CAAC,WAAW,CAAC,CAAC,CAAC;AAEzG,MAAM,UAAU,GAAG,CAAC,MAAmB,EAAE,cAAuB,EAAa,EAAE,CAC3E,cAAc,CAAC,CAAC,CAAC,eAAe,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC,MAAM,EAAE,MAAM,CAAC,UAAU,CAAC,CAAC;AAEtF,MAAM,SAAS,GAAG,CAAC,KAAmB,EAAU,EAAE;IAC9C,MAAM,KAAK,GAAG,CAAC,SAAS,KAAK,CAAC,IAAI,IAAI,EAAE,EAAE,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC;IAExD,KAAK,MAAM,IAAI,IAAI,CAAC,KAAK,CAAC,GAAG,EAAE,GAAG,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC;QACtD,IAAI,IAAI,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAClB,KAAK,CAAC,IAAI,CAAC,EAAE,EAAE,IAAI,CAAC,CAAC;QACzB,CAAC;IACL,CAAC;IAED,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AAC5B,CAAC,CAAC;AAEF,MAAM,gBAAgB,GAAG,CAAC,OAAuB,EAAY,EAAE,CAC3D,aAAa,CAAC,OAAO,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC;AAE/E,MAAM,gBAAgB,GAAG,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,WAAW,EAAE,MAAM,EAAuB,EAAU,EAAE;IAC9F,MAAM,IAAI,GAAG,CAAC,KAAK,IAAI,IAAI,CAAC,CAAC;IAE7B,IAAI,QAAQ,CAAC,YAAY,KAAK,SAAS,EAAE,CAAC;QACtC,IAAI,CAAC,IAAI,CAAC,aAAa,gBAAgB,CAAC,QAAQ,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;IACxE,CAAC;IAED,IAAI,QAAQ,CAAC,aAAa,EAAE,CAAC;QACzB,IAAI,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;IAChC,CAAC;IAED,IAAI,CAAC,IAAI,CAAC,GAAG,WAAW,EAAE,GAAG,eAAe,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC,CAAC;IAEpE,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;QACvB,IAAI,CAAC,IAAI,CAAC,UAAU,MAAM,IAAI,CAAC,CAAC;IACpC,CAAC;IAED,OAAO,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;AAC5B,CAAC,CAAC;AAEF,MAAM,cAAc,GAAG,CAAC,IAAY,EAAE,SAAiB,EAAE,KAAe,EAAU,EAAE;IAChF,MAAM,KAAK,GAAG,CAAC,SAAS,IAAI,IAAI,EAAE,EAAE,EAAE,aAAa,SAAS,UAAU,CAAC,CAAC;IAExE,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;QACvB,IAAI,IAAI,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAClB,KAAK,CAAC,IAAI,CAAC,EAAE,EAAE,IAAI,CAAC,CAAC;QACzB,CAAC;IACL,CAAC;IAED,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AAC5B,CAAC,CAAC;AAEF,MAAM,mBAAmB,GAAG,CAAC,KAAqB,EAAE,eAAyB,EAAE,EAAU,EAAE,CACvF,cAAc,CAAC,KAAK,CAAC,IAAI,EAAE,KAAK,CAAC,SAAS,EAAE,CAAC,GAAG,YAAY,EAAE,KAAK,CAAC,GAAG,EAAE,GAAG,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;AAEvG,MAAM,cAAc,GAAG,CAAC,IAAY,EAAU,EAAE;IAC5C,MAAM,KAAK,GAAG,kBAAkB,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IAE/C,OAAO,KAAK,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,IAAI,EAAE,CAAC,CAAC,CAAC,IAAI,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC;AAC3D,CAAC,CAAC;AAEF,MAAM,oBAAoB,GAAG,CAAC,SAAuB,EAAE,OAAgB,EAAiB,EAAE,CACtF,IAAI,aAAa,CAAC,EAAE,GAAG,SAAS,EAAE,IAAI,EAAE,wBAAwB,EAAE,EAAE,OAAO,CAAC,CAAC;AAEjF,MAAM,qBAAqB,GAAG,CAAC,OAA+B,EAAY,EAAE,CACxE,aAAa,CAAC,OAAO,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CACrD,mBAAmB,CAAC,IAAI,EAAE,IAAI,CAAC,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,UAAU,IAAI,CAAC,MAAM,KAAK,CAAC,CAAC,CAC3F,CAAC;AAEN,MAAM,kBAAkB,GAAG,CAAC,aAAqB,EAAE,SAAiB,EAAU,EAAE,CAC5E,GAAG,aAAa,IAAI,sBAAsB,CAAC,SAAS,CAAC,EAAE,CAAC;AAE5D,MAAM,kBAAkB,GAAG,CAAC,OAAgB,EAAE,SAAuB,EAAE,KAAe,EAAoB,EAAE;IACxG,MAAM,WAAW,GAAG,IAAI,aAAa,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC;IAC1D,MAAM,gBAAgB,GAAG,oBAAoB,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC;IAClE,MAAM,SAAS,GAAG,sBAAsB,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;IACrD,MAAM,SAAS,GAAG,uBAAuB,CAAC,WAAW,EAAE,KAAK,CAAC,CAAC;IAE9D,OAAO,qBAAqB,CAAC,gBAAgB,EAAE,KAAK,EAAE,CAAC,MAAM,EAAE,EAAE,CAC7D,cAAc,CAAC,WAAW,EAAE,MAAM,EAAE,SAAS,EAAE,SAAS,CAAC,CAC5D,CAAC;AACN,CAAC,CAAC;AAEF,MAAM,oBAAoB,GAAG,CAAC,OAAyB,EAAE,KAAa,EAAY,EAAE,CAChF,OAAO,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,YAAY,EAAE,KAAK,EAAE,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,mBAAmB,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;AAE3G,MAAM,qBAAqB,GAAG,CAC1B,gBAA+B,EAC/B,KAAe,EACf,MAA+C,EAC/B,EAAE;IAClB,MAAM,OAAO,GAAG,eAAe,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;IAE/C,MAAM,KAAK,GAAG,aAAa,CAAC,sBAAsB,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE;QAC5D,YAAY,EAAE,eAAe,CAAC,KAAK,CAAC,YAAY,CAAC;QACjD,SAAS,EAAE,eAAe,CAAC,KAAK,CAAC,SAAS,CAAC;QAC3C,OAAO,EAAE,OAAO;KACnB,CAAC,CAAC;IAEH,MAAM,OAAO,GAAqB,EAAE,CAAC;IAErC,KAAK,MAAM,MAAM,IAAI,OAAO,EAAE,CAAC;QAC3B,MAAM,YAAY,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC;QACpC,MAAM,QAAQ,GAAG,6BAA6B,CAAC,gBAAgB,EAAE,MAAM,EAAE,KAAK,EAAE,YAAY,CAAC,CAAC;QAE9F,IAAI,QAAQ,KAAK,SAAS,EAAE,CAAC;YACzB,SAAS;QACb,CAAC;QAED,OAAO,CAAC,IAAI,CAAC;YACT,IAAI,EAAE,YAAY,IAAI,gBAAgB,CAAC,MAAM,CAAC;YAC9C,SAAS,EAAE,aAAa,CAAC,QAAQ,CAAC;YAClC,GAAG,EAAE,WAAW,CAAC,MAAM,CAAC,GAAG,CAAC;YAC5B,IAAI,EAAE,kBAAkB,CAAC,gBAAgB,EAAE,MAAM,EAAE,KAAK,CAAC;SAC5D,CAAC,CAAC;IACP,CAAC;IAED,OAAO,aAAa,CAAC,OAAO,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;AACzD,CAAC,CAAC;AAEF,MAAM,aAAa,GAAG,CAAC,QAAgB,EAAU,EAAE;IAC/C,MAAM,KAAK,GAAG,QAAQ,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IAE1E,OAAO,QAAQ,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,IAAI,EAAE,CAAC,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;AAC1D,CAAC,CAAC;AAEF,OAAO,EACH,cAAc,EACd,yBAAyB,EACzB,2BAA2B,EAC3B,eAAe,EACf,eAAe,EACf,WAAW,EACX,aAAa,EACb,WAAW,EACX,cAAc,EACd,YAAY,EACZ,SAAS,EACT,gBAAgB,EAChB,UAAU,EACV,cAAc,EACd,mBAAmB,EACnB,gBAAgB,EAChB,cAAc,EACd,oBAAoB,EACpB,qBAAqB,EACrB,kBAAkB,EAClB,oBAAoB,EACpB,kBAAkB,EAClB,QAAQ,GAIX,CAAC","sourcesContent":["import { sanitizeTypeIdentifier, sortStringsBy } from \"@gtkx/utils\";\nimport type { GirAnnotations } from \"../gir/annotations.js\";\nimport type { GirClass } from \"../gir/class.js\";\nimport type { GirFunction } from \"../gir/function.js\";\nimport type { Library } from \"../gir/library.js\";\nimport type { GirNamespace } from \"../gir/namespace.js\";\nimport type { GirCallable } from \"../gir/parameter.js\";\nimport type { GirProperty } from \"../gir/property.js\";\nimport type { TypeId } from \"../gir/type-id.js\";\nimport type { JsDocDeprecation, JsDocParam, JsDocSpec } from \"../writer/doc-tags.js\";\nimport { collectInheritedMethods, conflictRename } from \"../analysis/inheritance.js\";\nimport { renderHandlerParameters, renderHandlerResultType } from \"../analysis/param-structure.js\";\nimport { recordTypeTarget, renderBaseType, type TsTypeTarget } from \"../analysis/ts-type.js\";\nimport {\n    dedupeCallables,\n    instanceMemberSpec,\n    instanceScope,\n    renderInstanceMethodSignature,\n} from \"../store/gi/callables.js\";\nimport { annotationSpec, handlerSpec, selfHandlerSpec } from \"../store/gi/doc-spec.js\";\nimport { methodExportName } from \"../store/gi/method.js\";\nimport { ModuleContext } from \"../writer/context.js\";\nimport { stripDocMedia } from \"../writer/doc-tags.js\";\nimport { gtkDocToMarkdown } from \"../writer/gtk-doc.js\";\n\ntype SignatureEntry = {\n    name: string;\n    signature: string;\n    doc: string;\n    tags?: JsDocSpec | undefined;\n};\n\ntype OriginSignatureEntry = SignatureEntry & { origin: string | undefined };\n\ntype MetaDocEntry = {\n    name: string;\n    meta: string;\n    doc: string;\n    tags?: JsDocSpec | undefined;\n};\n\ntype PropertyMetaOptions = {\n    type: string;\n    property: GirProperty;\n    accessNotes: string[];\n    origin: string | undefined;\n};\n\nconst DOCS_DEFAULT_VALUES: Record<string, string> = { TRUE: \"true\", FALSE: \"false\", NULL: \"null\" };\nconst FENCE_LINE = /^\\s*(```|~~~)/;\nconst HEADING_LINE = /^#{1,5}\\s/;\nconst LEADING_NAMESPACES = [\"Gtk\", \"Adw\"];\nconst DOCS_SIGNATURE_NAMESPACE = \"$docs\";\nconst WHITESPACE_RUN = /\\s+/g;\n\nconst docsTarget = (library: Library): TsTypeTarget =>\n    recordTypeTarget(\n        library,\n        (name) => `${name.namespaceName}.${name.typeName}`,\n        () => \"GObject.Type\",\n    );\n\nconst renderDocsType = (library: Library, ref: TypeId | undefined, isNullable: boolean): string => {\n    const base = renderBaseType(library, docsTarget(library), ref);\n\n    return isNullable ? `${base} | null` : base;\n};\n\nconst renderDocsHandlerResultType = (library: Library, signal: GirCallable): string =>\n    renderHandlerResultType({\n        library,\n        signal,\n        renderType: (ref, nullable) => renderDocsType(library, ref, nullable),\n        shouldIncludeCallerAllocated: false,\n        isOptOut: true,\n    });\n\nconst renderDocsHandlerParameters = (library: Library, signal: GirCallable): string[] =>\n    renderHandlerParameters(signal.parameters, (ref, nullable) => renderDocsType(library, ref, nullable));\n\nconst renderDocsSignalSignature = (library: Library, signal: GirCallable, selfType: string): string => {\n    const params = [...renderDocsHandlerParameters(library, signal), `self: ${selfType}`];\n\n    return `(${params.join(\", \")}) => ${renderDocsHandlerResultType(library, signal)}`;\n};\n\nconst renderDocsSignalHandlerType = (library: Library, signal: GirCallable): string =>\n    `(${renderDocsHandlerParameters(library, signal).join(\", \")}) => ${renderDocsHandlerResultType(library, signal)}`;\n\nconst docsDefaultValue = (value: string): string => DOCS_DEFAULT_VALUES[value] ?? value;\n\nconst demoteLine = (line: string, isInFence: boolean): { text: string; isInFence: boolean } => {\n    if (FENCE_LINE.test(line)) {\n        return { text: line, isInFence: !isInFence };\n    }\n\n    if (isInFence) {\n        return { text: line, isInFence };\n    }\n\n    return { text: HEADING_LINE.test(line) ? `#${line}` : line, isInFence };\n};\n\nconst demoteHeadings = (markdown: string): string => {\n    let isInFence = false;\n    const lines: string[] = [];\n\n    for (const line of markdown.split(\"\\n\")) {\n        const result = demoteLine(line, isInFence);\n        isInFence = result.isInFence;\n        lines.push(result.text);\n    }\n\n    return lines.join(\"\\n\");\n};\n\nconst docMarkdown = (doc: string | undefined): string =>\n    doc === undefined || doc.length === 0 ? \"\" : demoteHeadings(stripDocMedia(gtkDocToMarkdown(doc))).trim();\n\nconst stripMarkdown = (markdown: string): string =>\n    markdown\n        .replaceAll(/```[\\s\\S]*?```/g, \" \")\n        .replaceAll(/`([^`]*)`/g, \"$1\")\n        .replaceAll(/\\[([^[\\]]*)\\]\\([^)]*\\)/g, \"$1\")\n        .replaceAll(/[*#>]/g, \"\")\n        .replaceAll(WHITESPACE_RUN, \" \")\n        .trim();\n\nconst inlineMarkdown = (doc: string | undefined): string => docMarkdown(doc).replaceAll(WHITESPACE_RUN, \" \").trim();\nconst plainText = (doc: string | undefined): string => stripMarkdown(docMarkdown(doc));\n\nconst firstSentence = (doc: string | undefined): string => {\n    const text = plainText(doc);\n\n    if (text.length === 0) {\n        return \"\";\n    }\n\n    const match = /^.*?[.!?](?=\\s|$)/.exec(text);\n    const sentence = match?.[0] ?? text;\n\n    return sentence.length > 220 ? `${sentence.slice(0, 217)}...` : sentence;\n};\n\nconst elementSlug = (className: string): string =>\n    className\n        .replaceAll(/([a-z0-9])([A-Z])/g, \"$1-$2\")\n        .replaceAll(/([A-Z])(?=[A-Z][a-z])/g, \"$1-\")\n        .toLowerCase();\n\nconst implementsLine = (names: string[]): string[] => {\n    if (names.length === 0) {\n        return [];\n    }\n\n    const quotedNames = names.map((name) => `\\`${name}\\``).join(\", \");\n\n    return [`Implements ${quotedNames}.`];\n};\n\nconst joinSections = (sections: string[]): string =>\n    `${sections.filter((section) => section.length > 0).join(\"\\n\\n\")}\\n`;\n\nconst paramNotes = (params: JsDocParam[] | undefined): string[] => {\n    const entries = (params ?? [])\n        .map((param) => ({ name: param.name, text: inlineMarkdown(param.doc) }))\n        .filter((entry) => entry.text.length > 0);\n\n    if (entries.length === 0) {\n        return [];\n    }\n\n    const bullets = entries.map((entry) => `- \\`${entry.name}\\`: ${entry.text}`);\n\n    return [[\"**Parameters**\", \"\", ...bullets].join(\"\\n\")];\n};\n\nconst labelledNote = (label: string, text: string): string[] => (text.length === 0 ? [] : [`${label} ${text}`]);\n\nconst deprecationNote = (deprecation: JsDocDeprecation | undefined): string[] => {\n    if (deprecation === undefined) {\n        return [];\n    }\n\n    const since = deprecation.since;\n    const heading = since === undefined ? \"**Deprecated.**\" : `**Deprecated since ${since}.**`;\n    const text = inlineMarkdown(deprecation.doc);\n    const body = text.length === 0 ? heading : `${heading} ${text}`;\n\n    return [`> ${body}`];\n};\n\nconst sinceNote = (since: string | undefined): string[] =>\n    since === undefined || since.length === 0 ? [] : [`_Available since ${since}._`];\n\nconst tagNotes = (spec: JsDocSpec | undefined): string[] => {\n    if (spec === undefined) {\n        return [];\n    }\n\n    return [\n        ...paramNotes(spec.params),\n        ...labelledNote(\"**Returns**\", docMarkdown(spec.returns)),\n        ...labelledNote(\"**Throws**\", inlineMarkdown(spec.throws)),\n        ...deprecationNote(spec.deprecated),\n        ...sinceNote(spec.since),\n    ];\n};\n\nconst deprecationMeta = (annotations: GirAnnotations): string[] => {\n    if (!annotations.isDeprecated) {\n        return [];\n    }\n\n    const since = annotations.deprecatedSince;\n\n    return [since === undefined ? \"deprecated\" : `deprecated since ${since}`];\n};\n\nconst annotationNotes = (annotations: GirAnnotations): string[] => tagNotes(annotationSpec(annotations));\n\nconst signalTags = (signal: GirCallable, isSelfIncluded: boolean): JsDocSpec =>\n    isSelfIncluded ? selfHandlerSpec(signal) : handlerSpec(signal, signal.parameters);\n\nconst metaBlock = (entry: MetaDocEntry): string => {\n    const lines = [`### \\`${entry.name}\\``, \"\", entry.meta];\n\n    for (const note of [entry.doc, ...tagNotes(entry.tags)]) {\n        if (note.length > 0) {\n            lines.push(\"\", note);\n        }\n    }\n\n    return lines.join(\"\\n\");\n};\n\nconst sortedMetaBlocks = (entries: MetaDocEntry[]): string[] =>\n    sortStringsBy(entries, (item) => item.name).map((item) => metaBlock(item));\n\nconst propertyMetaLine = ({ type, property, accessNotes, origin }: PropertyMetaOptions): string => {\n    const meta = [`\\`${type}\\``];\n\n    if (property.defaultValue !== undefined) {\n        meta.push(`default \\`${docsDefaultValue(property.defaultValue)}\\``);\n    }\n\n    if (property.constructOnly) {\n        meta.push(\"construct-only\");\n    }\n\n    meta.push(...accessNotes, ...deprecationMeta(property.annotations));\n\n    if (origin !== undefined) {\n        meta.push(`from \\`${origin}\\``);\n    }\n\n    return meta.join(\" · \");\n};\n\nconst signatureBlock = (name: string, signature: string, notes: string[]): string => {\n    const lines = [`### \\`${name}\\``, \"\", `\\`\\`\\`ts\\n${signature}\\n\\`\\`\\``];\n\n    for (const note of notes) {\n        if (note.length > 0) {\n            lines.push(\"\", note);\n        }\n    }\n\n    return lines.join(\"\\n\");\n};\n\nconst signatureEntryBlock = (entry: SignatureEntry, leadingNotes: string[] = []): string =>\n    signatureBlock(entry.name, entry.signature, [...leadingNotes, entry.doc, ...tagNotes(entry.tags)]);\n\nconst namespaceOrder = (name: string): string => {\n    const index = LEADING_NAMESPACES.indexOf(name);\n\n    return index === -1 ? `1${name}` : `0${String(index)}`;\n};\n\nconst docsSignatureContext = (namespace: GirNamespace, library: Library): ModuleContext =>\n    new ModuleContext({ ...namespace, name: DOCS_SIGNATURE_NAMESPACE }, library);\n\nconst originSignatureBlocks = (entries: OriginSignatureEntry[]): string[] =>\n    sortStringsBy(entries, (item) => item.name).map((item) =>\n        signatureEntryBlock(item, item.origin === undefined ? [] : [`From \\`${item.origin}\\`.`]),\n    );\n\nconst qualifiedClassName = (namespaceName: string, className: string): string =>\n    `${namespaceName}.${sanitizeTypeIdentifier(className)}`;\n\nconst classMethodEntries = (library: Library, namespace: GirNamespace, klass: GirClass): SignatureEntry[] => {\n    const realContext = new ModuleContext(namespace, library);\n    const signatureContext = docsSignatureContext(namespace, library);\n    const className = sanitizeTypeIdentifier(klass.name);\n    const inherited = collectInheritedMethods(realContext, klass);\n\n    return instanceMethodEntries(signatureContext, klass, (method) =>\n        conflictRename(realContext, method, inherited, className),\n    );\n};\n\nconst methodsSectionBlocks = (entries: SignatureEntry[], intro: string): string[] =>\n    entries.length === 0 ? [] : [\"## Methods\", intro, ...entries.map((item) => signatureEntryBlock(item))];\n\nconst instanceMethodEntries = (\n    signatureContext: ModuleContext,\n    klass: GirClass,\n    rename: (fn: GirFunction) => string | undefined,\n): SignatureEntry[] => {\n    const deduped = dedupeCallables(klass.methods);\n\n    const scope = instanceScope(sanitizeTypeIdentifier(klass.name), {\n        constructors: dedupeCallables(klass.constructors),\n        functions: dedupeCallables(klass.functions),\n        methods: deduped,\n    });\n\n    const entries: SignatureEntry[] = [];\n\n    for (const method of deduped) {\n        const nameOverride = rename(method);\n        const rendered = renderInstanceMethodSignature(signatureContext, method, scope, nameOverride);\n\n        if (rendered === undefined) {\n            continue;\n        }\n\n        entries.push({\n            name: nameOverride ?? methodExportName(method),\n            signature: signatureText(rendered),\n            doc: docMarkdown(method.doc),\n            tags: instanceMemberSpec(signatureContext, method, scope),\n        });\n    }\n\n    return sortStringsBy(entries, (entry) => entry.name);\n};\n\nconst signatureText = (rendered: string): string => {\n    const start = rendered.startsWith(\"/**\") ? rendered.indexOf(\"*/\") + 2 : 0;\n\n    return rendered.slice(start).trim().replace(/;$/, \"\");\n};\n\nexport {\n    renderDocsType,\n    renderDocsSignalSignature,\n    renderDocsSignalHandlerType,\n    annotationNotes,\n    deprecationMeta,\n    docMarkdown,\n    firstSentence,\n    elementSlug,\n    implementsLine,\n    joinSections,\n    plainText,\n    propertyMetaLine,\n    signalTags,\n    signatureBlock,\n    signatureEntryBlock,\n    sortedMetaBlocks,\n    namespaceOrder,\n    docsSignatureContext,\n    originSignatureBlocks,\n    classMethodEntries,\n    methodsSectionBlocks,\n    qualifiedClassName,\n    tagNotes,\n    type MetaDocEntry,\n    type SignatureEntry,\n    type OriginSignatureEntry,\n};\n"]}

package/dist/docs/symbol-page.d.ts

@@ -16,29 +16,46 @@ type GiSymbolBase = {
 };
 /** A GIR symbol the reference indexes, discriminated by `kind` and carrying the GIR node its page renders from. */
 type GiSymbolEntry = (GiSymbolBase & {
+    /** Renders the class page: hierarchy, constructors, static methods, properties, signals, and methods. */
     kind: "class" | "interface";
+    /** Supplies the ancestry, members, and, on an interface, the vtable slots an implementer fills. */
     klass: GirClass;
 }) | (GiSymbolBase & {
+    /** Renders the record page, labeled `union` when the record is one. */
     kind: "record";
+    /** Supplies the constructors, static methods, fields, and instance methods. */
     record: GirRecord;
 }) | (GiSymbolBase & {
+    /** Renders the page for an enumeration, a flags type, or an error domain, as a table of members. */
     kind: "enum";
+    /** Supplies the members, their values, and the GError domain when the enum carries one. */
     enumeration: GirEnum;
 }) | (GiSymbolBase & {
+    /** Renders the callback page as a single function type signature. */
     kind: "callback";
+    /** Supplies the parameters and return type the signature is rendered from. */
     callback: GirCallback;
 }) | (GiSymbolBase & {
+    /** Renders the alias page as the type the alias resolves to. */
     kind: "alias";
+    /** Supplies the target type the page prints. */
     alias: GirAlias;
 }) | (GiSymbolBase & {
+    /** Renders the page for a namespace-level function, promisified when a finish function matches it. */
     kind: "function";
+    /** Supplies the parameters and return type the signature is rendered from. */
     fn: GirFunction;
 }) | (GiSymbolBase & {
+    /** Renders the page for a namespace-level constant, showing its type and literal value. */
     kind: "constant";
+    /** Supplies the type and the value the literal is emitted from. */
     constant: GirConstant;
 });
+/** What {@link renderSymbolPage} needs besides the entry itself. */
 type SymbolPageOptions = {
+    /** Parsed GIR the page resolves ancestry, interfaces, and referenced types against. */
     library: Library;
+    /** Looks up the JSX element a class is also available as, undefined when it has none. */
     elementNameFor: (namespaceName: string, className: string) => string | undefined;
 };
 declare const renderSymbolPage: (entry: GiSymbolEntry, options: SymbolPageOptions) => string;

package/dist/docs/symbol-page.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"symbol-page.d.ts","sourceRoot":"","sources":["../../src/docs/symbol-page.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,iBAAiB,CAAC;AAChD,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,gBAAgB,CAAC;AAC9C,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AACtD,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAC;AAEjD,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAC;AAKlD,OAAO,EAAsB,KAAK,WAAW,EAAE,MAAM,oBAAoB,CAAC;AAC1E,OAAO,EAAE,KAAK,QAAQ,EAAE,KAAK,WAAW,EAAE,KAAK,YAAY,EAAsB,MAAM,qBAAqB,CAAC;AAuC7G,gEAAgE;AAChE,KAAK,YAAY,GAAG;IAChB,0CAA0C;IAC1C,SAAS,EAAE,YAAY,CAAC;IACxB,kHAAkH;IAClH,IAAI,EAAE,MAAM,CAAC;IACb,gFAAgF;IAChF,GAAG,EAAE,MAAM,GAAG,SAAS,CAAC;CAC3B,CAAC;AAEF,mHAAmH;AACnH,KAAK,aAAa,GACZ,CAAC,YAAY,GAAG;IAAE,IAAI,EAAE,OAAO,GAAG,WAAW,CAAC;IAAC,KAAK,EAAE,QAAQ,CAAA;CAAE,CAAC,GACnE,CAAC,YAAY,GAAG;IAAE,IAAI,EAAE,QAAQ,CAAC;IAAC,MAAM,EAAE,SAAS,CAAA;CAAE,CAAC,GACtD,CAAC,YAAY,GAAG;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,WAAW,EAAE,OAAO,CAAA;CAAE,CAAC,GACvD,CAAC,YAAY,GAAG;IAAE,IAAI,EAAE,UAAU,CAAC;IAAC,QAAQ,EAAE,WAAW,CAAA;CAAE,CAAC,GAC5D,CAAC,YAAY,GAAG;IAAE,IAAI,EAAE,OAAO,CAAC;IAAC,KAAK,EAAE,QAAQ,CAAA;CAAE,CAAC,GACnD,CAAC,YAAY,GAAG;IAAE,IAAI,EAAE,UAAU,CAAC;IAAC,EAAE,EAAE,WAAW,CAAA;CAAE,CAAC,GACtD,CAAC,YAAY,GAAG;IAAE,IAAI,EAAE,UAAU,CAAC;IAAC,QAAQ,EAAE,WAAW,CAAA;CAAE,CAAC,CAAC;AAEjE,KAAK,iBAAiB,GAAG;IACrB,OAAO,EAAE,OAAO,CAAC;IACjB,cAAc,EAAE,CAAC,aAAa,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,KAAK,MAAM,GAAG,SAAS,CAAC;CACpF,CAAC;AAiWF,QAAA,MAAM,gBAAgB,GAAI,OAAO,aAAa,EAAE,SAAS,iBAAiB,KAAG,MAyB5E,CAAC;AA6IF,OAAO,EAAE,gBAAgB,EAAE,KAAK,aAAa,EAAE,KAAK,iBAAiB,EAAE,CAAC"}
+{"version":3,"file":"symbol-page.d.ts","sourceRoot":"","sources":["../../src/docs/symbol-page.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,iBAAiB,CAAC;AAChD,OAAO,KAAK,EAAc,OAAO,EAAE,MAAM,gBAAgB,CAAC;AAC1D,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AACtD,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAC;AACjD,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAC;AAMlD,OAAO,EAAsB,KAAK,WAAW,EAAE,MAAM,oBAAoB,CAAC;AAC1E,OAAO,EAAE,KAAK,QAAQ,EAAE,KAAK,WAAW,EAAE,KAAK,YAAY,EAAsB,MAAM,qBAAqB,CAAC;AAmD7G,gEAAgE;AAChE,KAAK,YAAY,GAAG;IAChB,0CAA0C;IAC1C,SAAS,EAAE,YAAY,CAAC;IACxB,kHAAkH;IAClH,IAAI,EAAE,MAAM,CAAC;IACb,gFAAgF;IAChF,GAAG,EAAE,MAAM,GAAG,SAAS,CAAC;CAC3B,CAAC;AAEF,mHAAmH;AACnH,KAAK,aAAa,GACZ,CAAC,YAAY,GAAG;IACd,yGAAyG;IACzG,IAAI,EAAE,OAAO,GAAG,WAAW,CAAC;IAC5B,mGAAmG;IACnG,KAAK,EAAE,QAAQ,CAAC;CACnB,CAAC,GACF,CAAC,YAAY,GAAG;IACZ,uEAAuE;IACvE,IAAI,EAAE,QAAQ,CAAC;IACf,+EAA+E;IAC/E,MAAM,EAAE,SAAS,CAAC;CACrB,CAAC,GACF,CAAC,YAAY,GAAG;IACZ,oGAAoG;IACpG,IAAI,EAAE,MAAM,CAAC;IACb,2FAA2F;IAC3F,WAAW,EAAE,OAAO,CAAC;CACxB,CAAC,GACF,CAAC,YAAY,GAAG;IACZ,qEAAqE;IACrE,IAAI,EAAE,UAAU,CAAC;IACjB,8EAA8E;IAC9E,QAAQ,EAAE,WAAW,CAAC;CACzB,CAAC,GACF,CAAC,YAAY,GAAG;IACZ,gEAAgE;IAChE,IAAI,EAAE,OAAO,CAAC;IACd,gDAAgD;IAChD,KAAK,EAAE,QAAQ,CAAC;CACnB,CAAC,GACF,CAAC,YAAY,GAAG;IACZ,sGAAsG;IACtG,IAAI,EAAE,UAAU,CAAC;IACjB,8EAA8E;IAC9E,EAAE,EAAE,WAAW,CAAC;CACnB,CAAC,GACF,CAAC,YAAY,GAAG;IACZ,2FAA2F;IAC3F,IAAI,EAAE,UAAU,CAAC;IACjB,mEAAmE;IACnE,QAAQ,EAAE,WAAW,CAAC;CACzB,CAAC,CAAC;AAKP,oEAAoE;AACpE,KAAK,iBAAiB,GAAG;IACrB,uFAAuF;IACvF,OAAO,EAAE,OAAO,CAAC;IACjB,yFAAyF;IACzF,cAAc,EAAE,CAAC,aAAa,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,KAAK,MAAM,GAAG,SAAS,CAAC;CACpF,CAAC;AAoaF,QAAA,MAAM,gBAAgB,GAAI,OAAO,aAAa,EAAE,SAAS,iBAAiB,KAAG,MAyB5E,CAAC;AA0KF,OAAO,EAAE,gBAAgB,EAAE,KAAK,aAAa,EAAE,KAAK,iBAAiB,EAAE,CAAC"}

package/dist/docs/symbol-page.js

@@ -1,20 +1,24 @@
-import { pascalCase, sortStringsBy } from "@gtkx/utils";
+import { sanitizeTypeIdentifier, sortStringsBy, upperFirst } from "@gtkx/utils";
 import { reservedSignalMemberRename } from "../analysis/inheritance.js";
 import { renderTsType } from "../analysis/ts-type.js";
 import { ancestorChain } from "../gir/ancestry.js";
 import { callbackAsFunction } from "../gir/callback.js";
 import { namespaceDirectory } from "../gir/namespace.js";
 import { PRIMITIVE_TS_TYPE, primitiveCategory } from "../gir/primitives.js";
+import { callableSpec } from "../store/gi/callable-doc.js";
 import { dedupeCallables, indexMethodsByName, instanceScope, matchStaticFinishFunction, renderInstanceMethodSignature, renderStaticSignature, } from "../store/gi/callables.js";
 import { constantLiteral } from "../store/gi/constant.js";
+import { annotationSpec } from "../store/gi/doc-spec.js";
 import { enumMemberKey } from "../store/gi/enum.js";
 import { methodExportName, renderMethodReturnType, renderMethodSignature, renderPromisifiedSignature, } from "../store/gi/method.js";
 import { resolveAccessor } from "../store/gi/property-accessor.js";
 import { resolveRecordFieldEntry } from "../store/gi/record-field-accessor.js";
 import { computeRecordFieldSlots } from "../store/gi/record-layout.js";
+import { vfuncEntries } from "../store/gi/vtable.js";
 import { implementedInterfaces, newlyImplementedInterfaces } from "../store/jsx/intrinsic-elements.js";
-import { classMethodEntries, docMarkdown, docsDefaultValue, docsSignatureContext, firstSentence, implementsLine, joinSections, metaBlock, methodsSectionBlocks, originSignatureBlocks, renderDocsSignalHandlerType, renderDocsType, signatureBlock, } from "./render.js";
+import { annotationNotes, classMethodEntries, deprecationMeta, docMarkdown, docsSignatureContext, firstSentence, implementsLine, joinSections, methodsSectionBlocks, originSignatureBlocks, plainText, propertyMetaLine, qualifiedClassName, renderDocsSignalHandlerType, renderDocsType, signalTags, signatureBlock, signatureEntryBlock, sortedMetaBlocks, tagNotes, } from "./render.js";
 const qualifiedName = (entry) => `${entry.namespace.name}.${entry.name}`;
+const pageTagNotes = (spec) => tagNotes({ ...spec, deprecated: undefined, since: undefined });
 const frontmatter = (entry, kindLabel) => {
     const sentence = firstSentence(entry.doc);
     const description = sentence.length > 0 ? sentence : `API reference for the ${qualifiedName(entry)} ${kindLabel}.`;
@@ -22,14 +26,40 @@ const frontmatter = (entry, kindLabel) => {
 };
 const kindLine = (kindLabel, namespace) => `\`${kindLabel}\` in \`@gtkx/gi/${namespaceDirectory(namespace)}\``;
 const importBlock = (entry) => `\`\`\`ts\nimport * as ${entry.namespace.name} from "@gtkx/gi/${namespaceDirectory(entry.namespace)}";\n\`\`\``;
+const entryAnnotations = (entry) => {
+    switch (entry.kind) {
+        case "class":
+        case "interface": {
+            return entry.klass.annotations;
+        }
+        case "record": {
+            return entry.record.annotations;
+        }
+        case "enum": {
+            return entry.enumeration.annotations;
+        }
+        case "callback": {
+            return entry.callback.annotations;
+        }
+        case "alias": {
+            return entry.alias.annotations;
+        }
+        case "function": {
+            return entry.fn.annotations;
+        }
+        case "constant": {
+            return entry.constant.annotations;
+        }
+    }
+};
 const pageHeader = (entry, kindLabel) => [
     frontmatter(entry, kindLabel),
     `# ${qualifiedName(entry)}`,
     kindLine(kindLabel, entry.namespace),
     docMarkdown(entry.doc),
+    ...annotationNotes(entryAnnotations(entry)),
     importBlock(entry),
 ];
-const qualifiedClassName = (namespaceName, className) => `${namespaceName}.${pascalCase(className)}`;
 const elementNote = (entry, options) => {
     const glibName = options.elementNameFor(entry.namespace.name, entry.klass.name);
     if (glibName === undefined) {
@@ -69,25 +99,59 @@ const prerequisitesLine = (entry, library) => {
     }
     return [`Requires ${names.join(", ")}.`];
 };
+const interfaceImplementingIntro = (entry) => {
+    const qualified = qualifiedName(entry);
+    return (`A class fills these vtable slots to adopt the interface: declare \`implements ${qualified}Impl\` ` +
+        `on it and pass \`${qualified}\` in the \`implements\` option of \`registerClass\`. Every slot is ` +
+        "optional, and one the class leaves out keeps whatever the interface installs by default. The " +
+        "methods, properties, and signals above come from GLib dispatch.");
+};
+const classImplementingIntro = (entry) => {
+    const qualified = qualifiedName(entry);
+    return ("A subclass declared with `registerClass` overrides these virtual methods to change what " +
+        `\`${qualified}\` does: define the slot as a method on the subclass and call \`super.<slot>(...)\` ` +
+        "to chain up to the inherited implementation. A slot the subclass leaves out keeps that " +
+        "implementation unchanged.");
+};
+const implementingIntro = (entry) => entry.kind === "interface" ? interfaceImplementingIntro(entry) : classImplementingIntro(entry);
+const implementingSection = (entry, library) => {
+    const context = docsSignatureContext(entry.namespace, library);
+    const entries = vfuncEntries(context, entry.namespace.name, entry.klass);
+    if (entries.length === 0) {
+        return [];
+    }
+    const blocks = sortStringsBy(entries, (item) => item.name).map((item) => signatureBlock(item.name, item.signature, [docMarkdown(item.doc)]));
+    return ["## Implementing", implementingIntro(entry), ...blocks];
+};
+const staticEntry = (options, callable) => {
+    const signature = renderStaticSignature(options.context, callable, {
+        returnTypeOverride: options.returnTypeOverride,
+        siblings: options.siblings,
+    });
+    if (signature === undefined) {
+        return undefined;
+    }
+    const finishFn = matchStaticFinishFunction(options.context, callable, options.siblings);
+    return {
+        name: signature.name,
+        signature: signature.signature,
+        doc: docMarkdown(callable.doc),
+        tags: callableSpec(options.context, callable, { finishFn }),
+    };
+};
 const staticSection = (options) => {
-    const rendered = [];
+    const entries = [];
     for (const callable of dedupeCallables(options.callables)) {
-        const signature = renderStaticSignature(options.context, callable, {
-            returnTypeOverride: options.returnTypeOverride,
-            siblings: options.siblings,
-        });
-        if (signature === undefined) {
-            continue;
+        const entry = staticEntry(options, callable);
+        if (entry !== undefined) {
+            entries.push(entry);
         }
-        rendered.push({
-            name: signature.name,
-            block: signatureBlock(signature.name, signature.signature, [docMarkdown(callable.doc)]),
-        });
     }
-    if (rendered.length === 0) {
+    if (entries.length === 0) {
         return [];
     }
-    return [options.title, options.intro, ...sortStringsBy(rendered, (item) => item.name).map((item) => item.block)];
+    const blocks = sortStringsBy(entries, (item) => item.name).map((item) => signatureEntryBlock(item));
+    return [options.title, options.intro, ...blocks];
 };
 const memberOwners = (entry, library) => [
     { klass: entry.klass, namespace: entry.namespace, origin: undefined },
@@ -99,7 +163,7 @@ const memberOwners = (entry, library) => [
 ];
 const interfaceMethodNames = (library, owner) => {
     const context = docsSignatureContext(owner.namespace, library);
-    const className = pascalCase(owner.klass.name);
+    const className = sanitizeTypeIdentifier(owner.klass.name);
     const methods = dedupeCallables(owner.klass.methods);
     const scope = instanceScope(className, {
         constructors: dedupeCallables(owner.klass.constructors),
@@ -127,26 +191,16 @@ const propertyAccessorSetup = (owner, library, isUseClassRenames) => {
         methodByName: indexMethodsByName(dedupeCallables(owner.klass.methods)),
     };
 };
-const propertyMeta = (property, accessor, origin) => {
-    const meta = [`\`${accessor.tsType}\``];
-    if (property.defaultValue !== undefined) {
-        meta.push(`default \`${docsDefaultValue(property.defaultValue)}\``);
-    }
-    if (property.constructOnly) {
-        meta.push("construct-only");
-    }
+const getAccessNotes = (accessor) => {
     if (!accessor.isWritable) {
-        meta.push("read-only");
-    }
-    else if (!accessor.hasGetter) {
-        meta.push("write-only");
+        return ["read-only"];
     }
-    if (origin !== undefined) {
-        meta.push(`from \`${origin}\``);
+    if (!accessor.hasGetter) {
+        return ["write-only"];
     }
-    return meta.join(" · ");
+    return accessor.readType === accessor.writeType ? [] : [`writes \`${accessor.writeType}\``];
 };
-const sortedMetaBlocks = (entries) => sortStringsBy(entries, (item) => item.name).map((item) => metaBlock(item.name, item.meta, item.doc));
+const documentedAccessorType = (accessor) => accessor.hasGetter ? accessor.readType : accessor.writeType;
 const ownerPropertyEntries = (owner, setup, seen) => {
     const entries = [];
     for (const property of owner.klass.properties) {
@@ -162,8 +216,14 @@ const ownerPropertyEntries = (owner, setup, seen) => {
         seen.add(accessor.jsName);
         entries.push({
             name: accessor.jsName,
-            meta: propertyMeta(property, accessor, owner.origin),
+            meta: propertyMetaLine({
+                type: documentedAccessorType(accessor),
+                property,
+                accessNotes: getAccessNotes(accessor),
+                origin: owner.origin,
+            }),
             doc: docMarkdown(property.doc),
+            tags: annotationSpec(property.annotations),
         });
     }
     return entries;
@@ -195,6 +255,7 @@ const ownerSignalEntries = (owner, library, seen) => {
             name: signal.name,
             signature: renderDocsSignalHandlerType(library, signal),
             doc: docMarkdown(signal.doc),
+            tags: signalTags(signal, false),
             origin: owner.origin,
         });
     }
@@ -243,6 +304,7 @@ const classPage = (entry, options) => {
         ...propertiesSection(entry, library),
         ...signalsSection(entry, library),
         ...classMethodsSection(entry, library),
+        ...implementingSection(entry, library),
     ]);
 };
 const renderSymbolPage = (entry, options) => {
@@ -278,7 +340,12 @@ const recordInstanceEntries = (context, record) => {
         if (rendered === undefined) {
             continue;
         }
-        entries.push({ name: rendered.name, signature: rendered.signature, doc: docMarkdown(callable.doc) });
+        entries.push({
+            name: rendered.name,
+            signature: rendered.signature,
+            doc: docMarkdown(callable.doc),
+            tags: callableSpec(context, callable, {}),
+        });
     }
     return sortStringsBy(entries, (item) => item.name);
 };
@@ -311,7 +378,11 @@ const recordPage = (entry, library) => {
         ...methodsSectionBlocks(methodEntries, "Methods are called on instances."),
     ]);
 };
-const fieldMeta = (field) => [`\`${field.tsType}\``, ...(field.isWritable ? [] : ["read-only"])].join(" · ");
+const fieldMeta = (field) => [
+    `\`${field.tsType}\``,
+    ...(field.isWritable ? [] : ["read-only"]),
+    ...deprecationMeta(field.annotations),
+].join(" · ");
 const fieldsSection = (record, context, claimedNames) => {
     const { slots } = computeRecordFieldSlots(context, record.fields, record.isUnion);
     const entries = [];
@@ -320,21 +391,30 @@ const fieldsSection = (record, context, claimedNames) => {
         if (field === undefined) {
             continue;
         }
-        entries.push({ name: field.jsName, meta: fieldMeta(field), doc: docMarkdown(field.doc) });
+        entries.push({
+            name: field.jsName,
+            meta: fieldMeta(field),
+            doc: docMarkdown(field.doc),
+            tags: annotationSpec(field.annotations),
+        });
     }
     if (entries.length === 0) {
         return [];
     }
     return ["## Fields", ...sortedMetaBlocks(entries)];
 };
+const memberDescription = (member) => {
+    const markers = deprecationMeta(member.annotations).map((note) => `**${upperFirst(note)}.**`);
+    return [...markers, plainText(member.doc)]
+        .filter((part) => part.length > 0)
+        .join(" ")
+        .replaceAll("|", String.raw `\|`);
+};
 const enumPage = (entry) => {
     const { enumeration } = entry;
     const kindLabel = enumeration.errorDomain === undefined ? enumeration.kind : "error domain";
     const qualified = qualifiedName(entry);
-    const rows = enumeration.members.map((member) => {
-        const description = firstSentence(member.doc).replaceAll("|", String.raw `\|`);
-        return `| \`${enumMemberKey(member.name)}\` | \`${member.value}\` | ${description} |`;
-    });
+    const rows = enumeration.members.map((member) => `| \`${enumMemberKey(member.name)}\` | \`${member.value}\` | ${memberDescription(member)} |`);
     const usage = enumeration.errorDomain === undefined
         ? `Members are accessed as \`${qualified}.<member>\`.`
         : `Members are error codes for the \`${enumeration.errorDomain}\` GError domain, ` +
@@ -347,7 +427,12 @@ const callbackPage = (entry, library) => {
     const fn = callbackAsFunction(entry.callback);
     const parameters = renderMethodSignature(docsContext, fn);
     const signature = `type ${entry.name} = (${parameters}) => ${renderMethodReturnType(docsContext, fn)}`;
-    return joinSections([...pageHeader(entry, "callback"), "## Signature", `\`\`\`ts\n${signature}\n\`\`\``]);
+    return joinSections([
+        ...pageHeader(entry, "callback"),
+        "## Signature",
+        `\`\`\`ts\n${signature}\n\`\`\``,
+        ...pageTagNotes(callableSpec(docsContext, fn, {})),
+    ]);
 };
 const aliasPage = (entry, library) => {
     const docsContext = docsSignatureContext(entry.namespace, library);
@@ -365,8 +450,11 @@ const functionSignature = (context, name, fn, siblings) => {
 };
 const functionPage = (entry, library) => {
     const docsContext = docsSignatureContext(entry.namespace, library);
-    const signature = functionSignature(docsContext, entry.name, entry.fn, entry.namespace.functions);
-    return joinSections([...pageHeader(entry, "function"), `\`\`\`ts\n${signature}\n\`\`\``]);
+    const siblings = entry.namespace.functions;
+    const signature = functionSignature(docsContext, entry.name, entry.fn, siblings);
+    const finishFn = matchStaticFinishFunction(docsContext, entry.fn, siblings);
+    const spec = callableSpec(docsContext, entry.fn, { finishFn });
+    return joinSections([...pageHeader(entry, "function"), `\`\`\`ts\n${signature}\n\`\`\``, ...pageTagNotes(spec)]);
 };
 const constantPage = (entry, library) => {
     const docsContext = docsSignatureContext(entry.namespace, library);