JSDoc type for returned class instances. A basic JS Doc documentation is like. Maybe little bit late, but I have problem to find proper answer for your question event today. Stefan Musarra 1, 10 10 silver badges 15 15 bronze badges. You can achieve that, by doing this: I've just published a new version of better-docs template which supports category tag. 
| Uploader: | Mejind |
| Date Added: | 17 March 2015 |
| File Size: | 51.9 Mb |
| Operating Systems: | Windows NT/2000/XP/2003/2003/7/8/10 MacOS 10/X |
| Downloads: | 29796 |
| Price: | Free* [*Free Regsitration Required] |
Install to JSDoc3 — Oktavia
You no longer need to import the type which may break linters, for instance. Ahmed Mahmoud 1 1 gold badge 3 3 silver badges 12 12 bronze badges. Stefan Musarra 1, 10 10 silver badges 15 15 bronze badges. Stack Overflow works best with JavaScript enabled.
It's possible other flavors of JSDocs prefer Array. Sohail 2, 1 1 gold badge 20 20 silver badges 29 29 bronze badges. Therefore, according to the parser you have the following unrelated code afterwards: Bruno Brant 5, 4 4 gold badges 31 31 silver badges 69 69 bronze badges.
You have a new line after return, so according to the rules for Automatic Semicolon Insertion ASIit is treated as having ; in the end, so the return statement ends there. How to change theme in documentation. If you are using Closure Compiler, you can write: Enum as param jsxoc3 in JSDoc. VLAZ 8, 6 6 gold badges 25 25 silver badges 38 38 bronze badges. Nik 1, 1 1 gold badge 4 4 silver badges 11 11 bronze badges.
If you have a type inside a type separate your enum from car model and jsdov3 it there.
Install to JSDoc3
Only top voted, non community-wiki answers of a minimum length are eligible. HDM91 6 6 bronze badges. How do I document an object with JSDoc?
You can achieve that, by doing this: An alternative to the suggestions already posted, you can use this format: I had a similar but different problem with the Home Page. Matt Pengelly 1 1 gold badge 10 10 silver badges 21 21 bronze badges. Stack Overflow for Teams is a private, secure spot for jedoc3 and your coworkers to find and share information.
Graham P Heath 4, 3 3 gold badges 23 23 silver badges 41 41 bronze badges. I've just published a new version of better-docs template which supports category tag.
Tag Info users hot new synonyms. A basic JS Doc documentation is like.
Hot answers tagged jsdoc3 day week month year all. React Hooks - JSDoc with destructured array variables. The small in-house Sjdoc3 library that I wanted to generate JSDOC pages for was just a collection of global functions, and I didn't want to display the home page at all.
JSDoc type for returned class instances. Documenting the return of a javascript constructor with jsdoc.
Subscribe to RSS
By using our site, you acknowledge that you have read and understand our Cookie PolicyJzdoc3 Policyand our Terms of Service. As stage-2stage-3 or any other stage preset are removed in babel 7 or newer so you have to add plugin separately. I only want to display the global.
No comments:
Post a Comment