Como posso informar o JSDoc sobre a estrutura de um objeto retornado. Eu encontrei a @return {{field1: type, field2: type, ...}} description
sintaxe e tentei:
/**
* Returns a coordinate from a given mouse or touch event
* @param {TouchEvent|MouseEvent|jQuery.Event} e
* A valid mouse or touch event or a jQuery event wrapping such an
* event.
* @param {string} [type="page"]
* A string representing the type of location that should be
* returned. Can be either "page", "client" or "screen".
* @return {{x: Number, y: Number}}
* The location of the event
*/
var getEventLocation = function(e, type) {
...
return {x: xLocation, y: yLocation};
}
Enquanto isso analisa com êxito, a documentação resultante simplesmente afirma:
Returns:
The location of an event
Type: Object
Estou desenvolvendo uma API e preciso que as pessoas saibam sobre o objeto que serão retornadas. Isso é possível no JSDoc? Estou usando JSDoc3.3.0-beta1.
@typedef
é uma solução / solução alternativa, mas parece estranho que isso não funcione com objetos literais. Se alguém se deparar com isso no futuro (como eu fiz), adicionei um problema no github.com/jsdoc/jsdoc/issues/1678 que poderia ter mais informações do que esta página.