Skip to content
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

Examples are not displaying #52

Open
Glenn-Sharecare opened this issue Sep 29, 2022 · 1 comment
Open

Examples are not displaying #52

Glenn-Sharecare opened this issue Sep 29, 2022 · 1 comment

Comments

@Glenn-Sharecare
Copy link

Using this example:

/**
 * Call this method to return a string that contains one character from each of
 * the sets in the deck in a random order
 *
 * @param {Array} deck this is an array of the sets of characters
 * @returns randomized string with one character from each specified set
 * 
 * @example
 *     var prefix = dealFromDeck([uppercaseSet, lowercaseSet, numberSet, specialSet])
 */

I am getting this html. Note there was a lot of extra white space removed:

    <h4 class="name" id=".dealFromDeck"><span class="type-signature">(static) </span>dealFromDeck<span class="signature">(deck)</span><span class="type-signature"></span></h4>
<div class="description">
    Call this method to return a string that contains one character from  each of
the sets in the deck in a random order
</div>
    <h5>Parameters:</h5>
<table class="params">
    <thead>
    <tr>
        <th>Name</th>
        <th>Type</th>
        <th class="last">Description</th>
    </tr>
    </thead>
    <tbody>
        <tr>
                <td class="name"><code>deck</code></td>
            <td class="type">
<span class="param-type">Array</span>
            </td>
            <td class="description last">this is an array of the sets of characters</td>
        </tr>
    </tbody>
</table>
<dl class="details">
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="scripts_common_random.js.html">scripts/common/random.js</a>, <a href="scripts_common_random.js.html#line104">line 104</a>
    </li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
    randomized string with one character from each specified set
</div>
    <h5>Example</h5>
    <pre class="prettyprint"></pre>

As you can see, the example is completely excluded in the <pre> tag.

@ludorival
Copy link
Owner

Hi @Glenn-Sharecare, thank you to raise this. The extension use jsdoc to generate html. If there is an issue with the rendering, I will suggest you to check first if the issue occurs with jsdoc itself. Maybe jsdoc has fixed in more recent version. If it's the case so I might have to upgrade the version.

Current version used by the extension is

"jsdoc": "^3.5.5",

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants