Vishesh 'ironeagle' Bangotra
12a2493c6c
Some checks reported errors
continuous-integration/drone/push Build was killed
121 lines
3.7 KiB
JSON
121 lines
3.7 KiB
JSON
{
|
|
"module": "models",
|
|
"content": {
|
|
"path": "models",
|
|
"docstring": "",
|
|
"objects": {
|
|
"DocModule": {
|
|
"name": "DocModule",
|
|
"kind": "interface",
|
|
"path": "models.DocModule",
|
|
"signature": "DocModule",
|
|
"docstring": "A single module (typically one source file or package).",
|
|
"members": {
|
|
"docstring": {
|
|
"name": "docstring",
|
|
"kind": "property",
|
|
"path": "models.DocModule.docstring",
|
|
"signature": "docstring: string",
|
|
"docstring": ""
|
|
},
|
|
"objects": {
|
|
"name": "objects",
|
|
"kind": "property",
|
|
"path": "models.DocModule.objects",
|
|
"signature": "objects: Record<string, DocObject>",
|
|
"docstring": ""
|
|
},
|
|
"path": {
|
|
"name": "path",
|
|
"kind": "property",
|
|
"path": "models.DocModule.path",
|
|
"signature": "path: string",
|
|
"docstring": ""
|
|
}
|
|
}
|
|
},
|
|
"DocObject": {
|
|
"name": "DocObject",
|
|
"kind": "interface",
|
|
"path": "models.DocObject",
|
|
"signature": "DocObject",
|
|
"docstring": "A documentation object with an optional tree of members.",
|
|
"members": {
|
|
"docstring": {
|
|
"name": "docstring",
|
|
"kind": "property",
|
|
"path": "models.DocObject.docstring",
|
|
"signature": "docstring: string",
|
|
"docstring": ""
|
|
},
|
|
"kind": {
|
|
"name": "kind",
|
|
"kind": "property",
|
|
"path": "models.DocObject.kind",
|
|
"signature": "kind: DocKind",
|
|
"docstring": ""
|
|
},
|
|
"members": {
|
|
"name": "members",
|
|
"kind": "property",
|
|
"path": "models.DocObject.members",
|
|
"signature": "members: Record<string, DocObject>",
|
|
"docstring": ""
|
|
},
|
|
"name": {
|
|
"name": "name",
|
|
"kind": "property",
|
|
"path": "models.DocObject.name",
|
|
"signature": "name: string",
|
|
"docstring": ""
|
|
},
|
|
"path": {
|
|
"name": "path",
|
|
"kind": "property",
|
|
"path": "models.DocObject.path",
|
|
"signature": "path: string",
|
|
"docstring": ""
|
|
},
|
|
"signature": {
|
|
"name": "signature",
|
|
"kind": "property",
|
|
"path": "models.DocObject.signature",
|
|
"signature": "signature: string",
|
|
"docstring": ""
|
|
}
|
|
}
|
|
},
|
|
"DocProject": {
|
|
"name": "DocProject",
|
|
"kind": "interface",
|
|
"path": "models.DocProject",
|
|
"signature": "DocProject",
|
|
"docstring": "The root semantic model produced by the loader.",
|
|
"members": {
|
|
"modules": {
|
|
"name": "modules",
|
|
"kind": "property",
|
|
"path": "models.DocProject.modules",
|
|
"signature": "modules: DocModule[]",
|
|
"docstring": ""
|
|
},
|
|
"name": {
|
|
"name": "name",
|
|
"kind": "property",
|
|
"path": "models.DocProject.name",
|
|
"signature": "name: string",
|
|
"docstring": ""
|
|
}
|
|
}
|
|
},
|
|
"DocKind": {
|
|
"name": "DocKind",
|
|
"kind": "type-alias",
|
|
"path": "models.DocKind",
|
|
"signature": "DocKind: \"module\" | \"namespace\" | \"class\" | \"interface\" | \"enum\" | \"enum-member\" | \"type-alias\" | \"variable\" | \"function\" | \"method\" | \"accessor\" | \"property\" | \"constructor\" | \"signature\" | \"parameter\" | \"component\" | \"hook\" | \"unknown\"",
|
|
"docstring": "The set of documentable symbol kinds recognized by doc-weaver."
|
|
}
|
|
}
|
|
}
|
|
}
|