jsdoc – Page 6 – Tarik Billa

JSDoc: Return object structure

October 11, 2022 by Tarik

Define your structure separately using a @typdef: /** * @typedef {Object} Point * @property {number} x – The X Coordinate * @property {number} y – The Y Coordinate */ And use it as the return type: /** * Returns a coordinate from a given mouse or touch event * @param {TouchEvent|MouseEvent|jQuery.Event} e * A valid … Read more

How to describe “object” arguments in jsdoc?

September 18, 2022 by Tarik

From the @param wiki page: Parameters With Properties If a parameter is expected to have a particular property, you can document that immediately after the @param tag for that parameter, like so: /** * @param userInfo Information about the user. * @param userInfo.name The name of the user. * @param userInfo.email The email of the … Read more