Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Question on type links

See original GitHub issue

I’m having a bit of trouble getting my @param, @return, etc tags to actually link to their respective types. Instead of a link, I get something that looks like [HexGrid](#HexGrid).

Should the linking work using es6 classes? I’m doing the following:

    /**
     * A grid of tiles serving as the main stage of the simulation
     * @type {HexGrid}
     */
    this.grid = grid;

Yet the link to HexGrid still appears as above. Does it matter that HexGrid has not been imported in this file?

Here is a link to some of the docs I’ve published for some more examples: http://cjsauer.github.io/genetic-sandbox/docs/#App

Issue Analytics

State:
Created 7 years ago
Comments:8 (4 by maintainers)

Top GitHub Comments

1reaction

cjsauercommented, Apr 26, 2016

Awesome. Looks as though I can use the markdown="1" attribute on the code tag to get kramdown rendering the links properly. I’ll give it a try this evening. Thanks for your help, as always!

Kramdown span tag reference: http://kramdown.gettalong.org/syntax.html#html-spans

1reaction

75lbcommented, Apr 26, 2016

https://github.com/jsdoc2md/dmd/blob/master/partials/shared/value/link.hbs