Как я могу заставить jsdoc отмечать мой параметр как объект jquery?

Я пытаюсь полностью прокомментировать мой javascript, и я использую JSDoc. У меня есть функция, которая использует объект jquery, и я хотел бы отметить этот параметр как таковой.

В настоящее время у меня есть это:

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

Но JSDoc не распознает (или не форматирует) JQuery как тип переменной. Любая помощь?

Ответы

Ответ 1

Согласно http://code.google.com/p/jsdoc-toolkit/wiki/TagParam, он должен быть

Параметр типа до имени параметра.

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