JSDoc: Zwróć obiekt struktury

Question

Jak mogę powiedzieć JSDoc o strukturze zwróconego obiektu. Znalazłem składnię @return {{field1: type, field2: type, ...}} description i próbowała go:

/** 
* 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}; 
} 

Chociaż analizuje powodzeniem otrzymaną dokumentację po prostu stwierdza:

Returns: 
    The location of an event 
    Type: Object 

Zajmuję API i trzeba, aby ludzie wiedzieli o obiekcie że zostanie zwrócony. Czy to możliwe w JSDoc? Używam JSDoc3.3.0-beta1.

Answer 1

zdefiniować oddzielnie:

/** 
* @typedef {Object} Point 
* @property {number} x The X Coordinate 
* @property {number} y The Y Coordinate 
*/ 

i zastosowanie:

/** 
* 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 {Point} 
*   The location of the event 
*/ 
var getEventLocation = function(e, type) { 
    ... 

    return {x: xLocation, y: yLocation}; 
} 

Answer 2

Czysty rozwiązaniem jest napisanie klasy i powrotu to.