[APIDocs] Table not showing properly when it includes code snippet

[dhmlau]

In https://loopback.io/doc/en/lb4/apidocs.rest.openapispecoptions.html, the table for the properties is not shown properly, see screen shot below:

Discovered this during a meeting with @raymondfeng and @bajtos, the issue might be because there's a code snippet inside a table in tsdocs.

Fix tip: Use the @remarks TSdoc notation

[jannyHou]

• @example and @remarks won't work, after parsing, code just disappears.

   * @example
   * ```
   * {
   *   '/openapi.json': {version: '3.0.0', format: 'json'},
   *   '/openapi.yaml': {version: '3.0.0', format: 'yaml'},
   * }
   * ```

   * @remarks
   * ```
   * {
   *   '/openapi.json': {version: '3.0.0', format: 'json'},
   *   '/openapi.yaml': {version: '3.0.0', format: 'yaml'},
   * }
   * ```

And adding empty line between the @remarks and code won't work either.

• other annotations in https://api-extractor.com/pages/tsdoc/doc_comment_syntax/ fail too

• suggestion in https://stackoverflow.com/questions/28508141/code-block-inside-table-row-in-markdown not working in this case.

• an issue probably related: RFC: Escaping doc comments inside doc comments microsoft/tsdoc#166, explains why this is not support in api-extractor.

[jannyHou]

Close as PR merged.