You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
/** * Assign the project to a list of employees. * @param {Object[]} employees - The employees who are responsible for the project. * @param {string} employees[].name - The name of an employee. */
This renders correctly in documentation.js, but if the array is not at the highest level, I am getting incorrect output.
Here, the payload object contains two arrays of objects with peak and rms properties:
/** * Update blocks of server meters. * * @param {Object} state - current state in store * @param {Object} payload - server meters object to update * @param {Object[]} [payload.input_meter_levels] - array of peak & RMS values * @param {Number} [payload.input_meter_levels[].peak] * @param {Number} [payload.input_meter_levels[].rms] * @param {Object[]} [payload.output_meter_levels] - array of peak & RMS values * @param {Number} [payload.output_meter_levels[].peak] * @param {Number} [payload.output_meter_levels[].rms] */
And here’s the output I get:
The text was updated successfully, but these errors were encountered:
The JSDoc documentation of
@param
outlines a method for documenting properties of objects in an array:This renders correctly in
documentation.js
, but if the array is not at the highest level, I am getting incorrect output.Here, the
payload
object contains two arrays of objects withpeak
andrms
properties:And here’s the output I get:
The text was updated successfully, but these errors were encountered: