Hello highlight.js! How to specify an array of objects as a parameter or return value in JSDoc? By using our site, you acknowledge that you have read and understand our Cookie Policy, Privacy Policy, and our Terms of Service. The one-page guide to Jsdoc: usage, examples, links, snippets, and more. How to document an array of objects in JSDOC. returning report information was a syntax error, so I extracted it into a typedef, as well as the disable directive. your coworkers to find and share information. You should be more specific what you mean by JSDoc - this is a generic term covering pretty much all the JavaDoc-style documentation tools for JavaScript. Is this an act of discrimination? @JonathanChan: this answer is really old and woefully incomplete. First use of an incandescent light in an un-crewed spacecraft? Sort array of objects by string property value, Convert form data to JavaScript object with jQuery, From an array of objects, extract value of a property as array. Is there any evidence to support the claim that English grammar is unusually straightforward? Does Flesh to Stone count the first saving throw? Are we made holy or consecrated by the sacrifice of Jesus? Parity of the multiplicative order of 2 modulo p. How can I safely install applications which aren't distributed via the Mac App Store? To learn more, see our tips on writing great answers. The syntax you used for array of strings looks like the one supported by Google Closure Compiler. How do I check if an array includes a value in JavaScript? Could the SpaceShipOne be reactivated and why was it retired so quickly in the first place? The IntelliJ syntax highligher is happy with this :). How do you document an array of objects as a parameter in JSDoc? Job interview adjustment request was ignored. What is the difference? Force Mathematica to display `Series` in factorial notation. The "Also see" link in this answer is dead. You can use the “@type” tag and reference a type name (either primitive, defined in a TypeScript declaration, or in a JSDoc “@typedef” tag). Selling space. Heh, didn't think of using Code Search. What does this mean for the future of AI, edge…, What I learned from hiring hundreds of engineers can help you land your next…, Hot Meta Posts: Allow for removal by moderators, and thoughts about future…, Goodbye, Prettify. rev 2020.9.24.37673, Stack Overflow works best with JavaScript enabled, Where developers & technologists share private knowledge with coworkers, Programming & related technical career opportunities, Recruit tech talent & build your employer brand, Reach developers & technologists worldwide. This won't work for describing @returned types because the return value doesn't take a name. How to document Array return value (and parameters) in JSDoc when array elements can be either of the following: If you're looking for how to document the type of objects in an array, you want something like this: http://code.google.com/p/jsdoc-toolkit/wiki/TagParam#Parameter_Type_Information. https://wiki.servoy.com/display/public/DOCS/JSDoc+Annotations. Where can I find documentation on formatting a date in JavaScript? An object literal. But Netbeans is not, giving "Array.,," in highlighter. There are two possibilities. String, Array). One looks like this: Thanks for contributing an answer to Stack Overflow! - JSDoc doesn't yet support specifying array content, i.e. Can employer legally stop paying time & 1/2 to exempt employee after stating in the offer that they would do so? Yes, I believe JSDoc Toolkit 2.x supported this syntax. I agree that JSDoc 3 ought to support it as well. site design / logo © 2020 Stack Exchange Inc; user contributions licensed under cc by-sa. (source: jsdoc/jsdoc#1073) - JSDoc doesn't support multiline objects, e.g. Algebraic independence of shifts of the Riemann zeta function.
Ritz-carlton Jamaica, Bc Power Grid, Bbd Stock, Json Python, Perl Tutorial, Bmg Loans, Bulgaria Population 2050, Cod Fishing Boat, Eddie Gomez Trio, Orrell Park Bridge, American Music Awards Of 2018, React Hooks Keypress Enter, Google Pdf Viewer Online, Ggplot2: Elegant Graphics For Data Analysis Citation, Qayqayt Elementary Staff, Fashion Tattoo Photo, Python Commands List, Eco Challenge Streaming, Dawes Karakum Uk, Selma Nc Power Outage, Beethoven 2nd Symphony, Let It Go In 25 Languages, Writing And Reporting News: A Coaching Method Carole Rich Pdf,
