meteor-jsdoc icon indicating copy to clipboard operation
meteor-jsdoc copied to clipboard

Is the {@link Object} syntax supported?

Open mizzao opened this issue 8 years ago • 1 comments

I'm trying to use this in JSDoc comments, but it doesn't seem to be processed, e.g.:

@returns The new {@link Instance} that was created.

results in

image

Is this supported? If so, could you provide a small example?

mizzao avatar May 03 '16 22:05 mizzao

The build process strips out most of the tags that are not used in meteor-jsdoc. I don't think @link is supported, so it is removed at build time. I can take a look, and add support for it, it shouldn't be a problem.

I'm quite busy at the moment, if someone comes up with a pull request, I'd really appreciate it. Otherwise I'll see if I can do something about this this weekend!

fabienb4 avatar May 05 '16 23:05 fabienb4