Closed OmgImAlexis closed 4 years ago
Docma renders @typedef
tags.
But in your case, you don't have any description for @typedef
symbols.
You should either set jsdoc.undescribed
to true
in your docma.json
,
or add some description like below:
/**
* My typedef description...
* @typedef {Object} GameOptions
*/
// OR
/**
* @typedef {Object} GameOptions
* @description My typedef description...
*/
// OR
/**
* @typedef {Object} GameOptions - My typedef description...
*/
Is there a way to have docma render the typedefs as well?
I couldn't find
Resource
orGameOptions
in the docs output. They also weren't linked in theGame
section of the docs. Instead just shown asGameOptions
.