Cannot reach signature.comment
#2886
Unanswered
tugcekucukoglu
asked this question in
Q&A
Replies: 1 comment
-
It's unclear what version you upgraded from.. Also the path you linked doesn't exist for your build script. Either way, I suggest rendering TypeDoc's output to JSON and looking at that. When you do that, you'll see that while the property has a comment, TypeDoc has placed the comment on the parameter, not on type declaration's signatures. "parameters": [
{
"id": 5,
"name": "scope",
"variant": "param",
"kind": 32768,
"flags": {},
"comment": {
"summary": [
{
"kind": "text",
"text": "content slot's params."
}
]
},
"type": {
"type": "reflection",
"declaration": {
"id": 6,
"name": "__type",
"variant": "declaration",
"kind": 65536,
"flags": {},
"children": [
{
"id": 9,
"name": "contentRef",
"variant": "declaration",
"kind": 1024,
"flags": {},
"comment": {
"summary": [
{
"kind": "text",
"text": "Referance of the content"
}
]
} |
Beta Was this translation helpful? Give feedback.
0 replies
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
-
We just upgraded to v0.27.9 and encounter some differences. For example; https://github.com/primefaces/primevue/blob/master/apps/showcase/scripts/build-apidoc.js#L393-L406
signatures[0]?.comment.summary[0]
returnsundefined
even if there is a comment line: https://github.com/primefaces/primevue/blob/master/packages/primevue/src/virtualscroller/VirtualScroller.d.ts#L378-L383.
Is it a bug or is there a workaround?
Beta Was this translation helpful? Give feedback.
All reactions