A
A
Alexey Yarkov2017-06-22 16:00:43
JavaScript
Alexey Yarkov, 2017-06-22 16:00:43

How to use @ symbol in JSDoc?

I'm trying to write documentation for a Vue component. I write like this:

/**
   * <ComponentName value="name"
   *            :getter="objectName"
   *            mode="text"
   *            @active="(mode, name, val) => activeFlag = mode"
   *            @input="(name, val) => objectName[name] = v"
   *            @save="Save"/>
*/

After generation, everything below the line * mode="text"is missing.
How to escape the @ symbol?

Answer the question

In order to leave comments, you need to log in

1 answer(s)
A
Anton Anton, 2017-06-22
@yarkov

Use v-on and v-bind
Well, or add plugin https://www.npmjs.com/package/jsdoc-escape-at to jsdoc config plugins array and escape with backslash

Didn't find what you were looking for?

Ask your question

Ask a Question

731 491 924 answers to any question