about docgen api when use @property
See original GitHub issueThanks for your git,it’s very helpful to me.
I write comment like this. the docgen api parse to this.
I would like to learn about this is youer design? or is not noticed thing?
I’m hesitant to format the result of docgen api.
/**
* Success event.
* @property {string} content content of the first prop passed to the event
* @property {string} content.text content of the first prop passed to the event
*/
this.$emit('success', content, {
demo: 'example'
})
{
"name":"on-click",
"description":"点击事件",
"type":{
"names":[
"undefined"
]
},
"properties":[
{
"type":{
"names":[
"object"
]
},
"name":"defaults",
"description":"The default values for parties."
},
{
"type":{
"names":[
"number"
]
},
"name":"defaults",
"description":".players - The default number of players."
},
{
"type":{
"names":[
"string"
]
},
"name":"defaults",
"description":".level - The default level for the party."
},
{
"type":{
"names":[
"object"
]
},
"name":"defaults",
"description":".treasure - The default treasure."
},
{
"type":{
"names":[
"number"
]
},
"name":"defaults",
"description":".treasure.gold - How much gold the party starts with."
}
]
}
Issue Analytics
- State:
- Created 3 years ago
- Comments:5 (2 by maintainers)
Top Results From Across the Web
vue-docgen-api - Vue Styleguidist
vue-docgen-api turns VueJs components into documentation objects. ... Prop, method and event tags are stored with the property they describe */ tags?
Read more >vue-docgen-api: Not parsing model property even in trivial cases
Current behavior An issue was already made and resolved and yet it still does not work. Parsing: ExplicitVModel.vue.
Read more >vue-docgen-api - npm
vue-docgen-api is a toolbox to help extracting information from Vue components, and generate documentation from it. Use @babel/parser to parse ...
Read more >DocumentService - Nintex help documentation
DocumentService.usePreview property. Gets or sets whether to run the DocumentService within the preview environment. Namespace: LOOP. Package: Nintex Drawloop ...
Read more >vue-docgen-api | Yarn - Package Manager
vue-docgen-api is a toolbox to help extracting information from Vue components, and generate documentation from it. Use @babel/parser to parse the code and ......
Read more >
Top Related Medium Post
No results found
Top Related StackOverflow Question
No results found
Troubleshoot Live Code
Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free
Top Related Reddit Thread
No results found
Top Related Hackernoon Post
No results found
Top Related Tweet
No results found
Top Related Dev.to Post
No results found
Top Related Hashnode Post
No results found

oh,sorry, I think it’s my mistake …
This issue has been automatically marked as stale because it has not had recent activity. It will be closed in 30 days if no further activity occurs. Thank you for your contributions.