javascript - tutorial - ¿Cómo puedo hacer que JSDoc marque mi parámetro como un objeto jQuery?

jsdoc return

Question

Estoy intentando comentar a fondo mi JavaScript y estoy usando JSDoc. Tengo una función que consume un objeto jQuery y me gustaría marcar el parámetro como tal.

Actualmente, tengo esto:

/**
* Initializes a login object.
* @param formEl {JQuery} The login form element on the page.
*/
var login = function(formEl){ ... }

Pero JSDoc no reconoce (o formatea adecuadamente) "JQuery" como un tipo de variable. ¿Alguna ayuda?

Answer 1

De acuerdo con http://code.google.com/p/jsdoc-toolkit/wiki/TagParam debería ser

Tipo de parámetro antes del nombre de parámetro.

/**
* Initializes a login object.
* @param {jQuery} formEl The login form element on the page.
*/
var login = function(formEl){ ... }