I can't insert quote, in the example section in compodoc

Question

i'm documenting my project with 'compodoc' and i like this tool but i get a error visual when i try insert a quote.

i have this comment

/**
   * crea un arreglo de tamaño n
   *
   * @example
   * *ngFor="let item of 2 | numberToArray"
   *
   * @param length tamaño del nuevo arreglo
   *
   * @returns un arreglo de tamaño n
   */

i expect this

example:
1| *ngFor="let item of 2 | numberToArray"

but the actual output is

example:
1| *ngFor=&quot;let item of 2 | numberToArray&quot;

I have the same problem – Richard Aguirre Jun 23 '20 at 02:27 — Richard Aguirre, Jun 23 '20 at 02:27

score 0 · Answer 1 · answered Jun 17 '19 at 16:30

0

I'm a little confused since your expected output is the same as the actual output in your example. Try escaping the quotation marks \"Foo bar\"

answered Jun 17 '19 at 16:30

user1222324562

965
2
9
24

yes, & quot; and "they are the same, but they are not the same visually – renato cohaila Jun 19 '19 at 18:24

score 0 · Answer 2 · answered Jun 20 '23 at 14:14

You can remove the @example jsdoc tag and enclose the code in ```ts. See more about workaround https://github.com/compodoc/compodoc/issues/304

From

/**
 * crea un arreglo de tamaño n
 *
 * @example
 * *ngFor="let item of 2 | numberToArray"
 */

To

/**
 * crea un arreglo de tamaño n
 *
 * ```ts
 * *ngFor="let item of 2 | numberToArray"
 * ```
 */

I can't insert quote, in the example section in compodoc

2 Answers2