CODEWITHSUNDEEP
javascriptjsdoc
polaris
polaris

Reputation: 339

how to use @param in jsdoc

I know this is a dumb question, but I just started working with jsdoc and I'm having issues trying to generate the doc file.

I've followed some examples I found online which all seem to be essentially the same, but for some reason I cannot generate the documentation for one of the variables I want to document.

this is my code. 

/**
 *@fileOverview mainController ' main controller file'
 *@param Controller here
 */
 function (jQuery, Controller, JSONModel, Filter){
  .....
  }

The first part @fileOverview works the @param doesn't, the index.html file doesn't show any information about it and I see no errors. I'm definitely doing something wrong here but I don't know what

Upvotes: 2

Views: 1627

Answers (1)

Jonathan.Brink
Jonathan.Brink

Reputation: 25373

Try this:

/**
 * @fileOverview mainController ' main controller file'
 * @param {object} Controller here
 */
function (jQuery, Controller, JSONModel, Filter){
.....
}

(note the spacing changes)

Upvotes: 2

Related Questions