question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

[BUG] @example sections not formatted correctly

See original GitHub issue
Overview of the issue

@example code is incorrectly formatted. Html tags are displaying, " and other characters have been translated and output.

    /**
     * This method will display a dialog to the user to capture some arbitary text, you
     * supply the buttons that should be displayed with the callback that should be invoked
     * for each (if required).
     *
     * @param {string} title the title for the dialog
     * @param {string} message the messsage to be presented to the user
     * @param {*} buttonConfigs an array, containing a buttonName and callback, i.e.
     * @param {boolean} [enableBackdropDismiss=true]  optional parameter - allow user to dismiss the prompt by clicking
     *                                                on the backdrop (default to true)?
     *
     * @example
     * ```typescript
     * this.alertCtrl.showTextInputWithButtons(
     *  "Pin Verification",
     *  "You have been sent an email. Please check your email and then type the pin code that you have received below.",
     *  [
     *      { buttonName: "Cancel", callback: null },
     *      { buttonName: "Verify", callback: (value: string) => { this.sendPin(value); } }
     *  ]);
     * ```
     *
     * @memberOf IonicAlerterService
     */
    public abstract showTextInputWithButtons(
        title: string,
        message: string,
        buttonConfigs: any,
        enableBackdropDismiss?: boolean,
    ): void;

version: 1.0.1 screen shot 2017-09-08 at 16 43 29

Has changed post version 1.0.0-beta.13 example below is as expected

screen shot 2017-09-08 at 16 41 49

Operating System, Node.js, npm, compodoc version(s)
Node : v8.2.1
npm  : 5.3.0 
OS   : macOS Sierra

"@compodoc/compodoc": "1.0.1"
Angular configuration, a package.json file in the root folder
    "@angular/animations": "4.1.3",
    "@angular/common": "4.1.3",
    "@angular/compiler": "4.1.3",
    "@angular/compiler-cli": "4.1.3",
    "@angular/core": "4.1.3",
    "@angular/forms": "4.1.3",
    "@angular/http": "4.1.3",
    "@angular/platform-browser": "4.1.3",
    "@angular/platform-browser-dynamic": "4.1.3",
    "@angular/platform-server": "4.1.3",
    "@compodoc/compodoc": "1.0.1",
    "@types/jasmine": "2.5.41",
    "@types/node": "7.0.5",
    "codelyzer": "^3.1.2",
    "ionic-angular": "3.6.0",
    "ncp": "^2.0.0",
    "rexreplace": "^2.5.2",
    "rimraf": "^2.6.1",
    "rxjs": "5.4.0",
    "ts-node": "2.0.0",
    "tslint": "^5.6.0",
    "tslint-consistent-codestyle": "^1.6.0",
    "tslint-eslint-rules": "^4.1.1",
    "tslint-ionic-rules": "^0.0.11",
    "typescript": "2.3.4",
    "zone.js": "0.8.12"
Compodoc installed globally or locally ?

locally

Motivation for or Use Case

See diagrams

Reproduce the error

Example above

Related issues

There was some changes to @example between 1.0.0-beta.13 and 1.0.0-beta.14

Suggest a Fix

Issue Analytics

  • State:closed
  • Created 6 years ago
  • Reactions:6
  • Comments:14 (2 by maintainers)

github_iconTop GitHub Comments

4reactions
vogloblinskycommented, Nov 10, 2017

This issue is related to TypeScript parsing JSDoc comment and @NgModule decorator. Interference with @xxx JSDoc tags. I have to try this deeper with TypeScript sources and submit a PR.

1reaction
wmatteicommented, Jul 5, 2019

Any chance to solve the bug on the next release?

Read more comments on GitHub >

github_iconTop Results From Across the Web

Error in Word not keeping formatting - paragraph settings
Error in Word not keeping formatting - paragraph settings ... after spacing section and the document once again, is not formatted correctly.
Read more >
How to Write A Good Bug Report? Tips and Tricks
This is a simple Bug report format. It may vary depending upon the Bug report tool that you are using. If you are...
Read more >
6 Ways to Fix “The Format Did Not Complete Successfully” Error
Recover Data at First · Solution 1: Remove Virus · Solution 2: Check Bad Sectors · Solution 3: Use Diskpart to Complete Formatting...
Read more >
How to Write a Good Bug Report - Tips and Tricks - Orangesoft
We recommend using a bug report template approved by the team at the ... general statements such as The Undo Button does not...
Read more >
Fix Paperback and Hardcover Formatting Issues
See the Margins and gutter section for steps how to update your margins. Once you've selected the correct page size and margins for...
Read more >

github_iconTop Related Medium Post

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found