JSDoc: как правильно указать необязательное возвращаемое значение

Question

Моя задача - документировать функцию с правильным JSDoc. Когда функция возвращает true, она вызывает что-то, в противном случае это не так. Но в любом случае возвращаемое значение должно быть типа boolean.

Мой вариант:

* @return {boolean=false} trigger for default event handler: 
* 
* Value | Description 
*-------|------------------------------- 
* true | disable default event handler 
* false | enable default event handler 

Помогите мне пожалуйста, чтобы выбрать правильное решение. Благодаря!

Answer 1

я добавил просто одну строку ниже возможных возвращаемых значений:

* @return {boolean} trigger for default event handler: 
* 
* Value | Description 
*-------|------------------------------- 
* true | disable default event handler 
* false | enable default event handler 
* 
* Return `false` or nothing if you want that default event handler stayed untouched. 

Я думаю, что это лучшее решение, потому что это ясно и действует.