Skip to content

'@' in @example code block tries to render a custom tag #161

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

Closed
dbanksdesign opened this issue Apr 16, 2018 · 2 comments
Closed

'@' in @example code block tries to render a custom tag #161

dbanksdesign opened this issue Apr 16, 2018 · 2 comments

Comments

@dbanksdesign
Copy link

JSdoc comment:

  /**
   * Creates a LESS file with variable definitions based on the style dictionary
   *
   * @memberof Formats
   * @kind member
   * @example
   * ```
   * @color-background-base: #f0f0f0;
   * @color-background-alt: #eeeeee;
   * ```
   */

And the output markdown it generates (ignore the backslashes, that is just to not break in this comment):

<a name="Formats.less/variables"></a>

### Formats.less/variables
Creates a LESS file with variable definitions based on the style dictionary

**Kind**: static property of [<code>Formats</code>](#Formats)  
**Color-background-base:**: #f0f0f0;  
**Color-background-alt:**: #eeeeee;
\```  
**Example**  
\```
@75lb
Copy link
Member

75lb commented Apr 16, 2018

do you have the same issue using this input code directly with jsdoc?

@dbanksdesign
Copy link
Author

Good point, jsdoc doesn't handle this situation. I opened a ticket on their repo: jsdoc/jsdoc#1521

@75lb 75lb closed this as completed Apr 17, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

No branches or pull requests

2 participants