How to describe “object” arguments in jsdoc?

by

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 user.
  */
 function logIn(userInfo) {
        doLogIn(userInfo.name, userInfo.email);
 }

There used to be a @config tag which immediately followed the corresponding @param, but it appears to have been deprecated (example here).

More Related Contents:

  1. Correct way to document open-ended argument functions in JSDoc
  2. Document generic type parameters in JSDOC
  3. How to remove all duplicates from an array of objects?
  4. What is the significance of the Javascript constructor property?
  5. How does the paste image from clipboard functionality work in Gmail and Google Chrome 12+?
  6. Comet and jQuery [closed]
  7. How to make cross domain request [duplicate]
  8. When is the body of a Promise executed?
  9. What is the “hasClass” function with plain JavaScript?
  10. How can I clone a JavaScript object except for one key?
  11. How do I remove tinyMCE and then re-add it?
  12. Rotating image / marker image on Google map V3
  13. this.setState isn’t merging states as I would expect
  14. play .wav sound file encoded in base64 with javascript
  15. Twitter Bootstrap Modal stop Youtube video
  16. Chrome FileReader
  17. Best way to alphanumeric check in JavaScript
  18. What algorithm does Readability use for extracting text from URLs?
  19. What is the difference between `firstChild` and `firstElementChild`?
  20. Why is pop faster than shift?
  21. ng-repeat with ng-transclude inside a directive
  22. Pausing CSS animation with javascript and also jumping to a specific place in the animation
  23. How do I export multiple html tables to excel?
  24. Javascript – insert an array inside another array
  25. How to create “credential” object needed by Firebase web user.reauthenticateWithCredential() method?
  26. fadeOut() and slideUp() at the same time?
  27. ASYNC / AWAIT SyntaxError: await is only valid in async functions and the top level bodies of modules
  28. Disable brower’s auto scroll after a page refresh?
  29. Jquery change text between two elements
  30. Performance impact of using css / javascript source-maps in production?

Leave a Comment