onury/docma

Markdown ignored in jsDoc?

warpdesign opened this issue · 0 comments

I have comments like this one:

    /**
     * Performs an animation on the object using one of the defined {FX} effects
     *
     * Effects change the object size/position using an interpolation function.
     *
     * Athena has the following effects:
     * - {Fade} performs a fade
     * - {Mosaic} performs a SNES-like mosaic effect
     * - {Rotate} performs a rotation on the object
     *
     * @param {String} fxName The name of the effect to use.
     * @param {Object} options The options of the effect.
     * @param {String} [options.easing="linear"] The easing functions to use, can be: 'linear', 'swing', 'easeInQuad', 'easeOutBounce'.
     *
     * @returns {Promise} a promise that will be fullfilled when the effect has been completed
     */

In Docma v1.x, this used to work correctly, and effects were displayed using an html list:

  • {Fade} performs a fade
  • {Mosaic} performs a SNES-like mosaic effect
  • {Rotate} performs a rotation on the object

In Docma v3.x, markdown isn't interpreted anymore and this is what's displayed instead:

- {Fade} performs a fade - {Mosaic} performs a SNES-like mosaic effect - {Rotate} performs a rotation on the object

Note: the text between curly brackets were also transformed into links but I guess this is expected since links have changed between v1 and v3.