jsdoc-to-markdown icon indicating copy to clipboard operation
jsdoc-to-markdown copied to clipboard

global typedefs get module name prepended

Open jochenonline opened this issue 6 years ago • 2 comments

I have a typedef which defines an object:

/**
 *
 * @typedef {Object} MyObject
 * @alias MyObject
 * @memberof module:mymodule
 * @property {String} prop1
 * @property {String} prop2
 */

This renders as follows:

<a name="MyObject"></a>

### mymoduleMyObject : <code>Object</code>
**Kind**: global typedef of [<code>mymodule</code>](#module_mymodule)  
**Properties**

- prop1 <code>String</code> 
- prop1 <code>String</code> 

How can I prevent the module name being prepended to the typedef? So I get MyObject instead of mymoduleMyObject ?

jochenonline avatar Feb 18 '19 12:02 jochenonline

how does it look when rendered using jsdoc directly?

75lb avatar Feb 18 '19 15:02 75lb

It looks like this:

<h4 class="name" id="MyObject">PgpKeys</h4>
<h5>Type:</h5>
<ul>
    <li>
        <span class="param-type">Object</span>
    </li>
</ul>
<h5 class="subsection-title">Properties:</h5>
<table class="props">
    <thead>
    <tr>
        <th>Name</th>
        <th>Type</th>
        <th class="last">Description</th>
    </tr>
    </thead>
    <tbody>
    <tr>
        <td class="name"><code>prop1</code></td>
        <td class="type">
            <span class="param-type">String</span>
        </td>
        <td class="description last"></td>
    </tr>
    <tr>
        <td class="name"><code>prop2</code></td>
        <td class="type">
            <span class="param-type">String</span>
        </td>
        <td class="description last"></td>
    </tr>
    </tbody>
</table>
<dl class="details">
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source">
        <ul class="dummy">
            <li>
                <a href="mymodule.js.html">mymodule.js</a>, <a href="mymodule.js.html#line53">line 53</a>
            </li>
        </ul>
    </dd>
</dl>

Looks correct to me...

jochenonline avatar Feb 18 '19 16:02 jochenonline