Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Markdown ignored in jsDoc? #77

Open
warpdesign opened this issue Mar 21, 2019 · 0 comments
Open

Markdown ignored in jsDoc? #77

warpdesign opened this issue Mar 21, 2019 · 0 comments

Comments

@warpdesign
Copy link
Contributor

warpdesign commented Mar 21, 2019

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants