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

global typedefs get module name prepended #182

Open
jochenonline opened this issue Feb 18, 2019 · 2 comments
Open

global typedefs get module name prepended #182

jochenonline opened this issue Feb 18, 2019 · 2 comments
Labels
template Requires a change to a dmd partial/helper

Comments

@jochenonline
Copy link

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 ?

@75lb
Copy link
Member

75lb commented Feb 18, 2019

how does it look when rendered using jsdoc directly?

@jochenonline
Copy link
Author

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...

@75lb 75lb added the template Requires a change to a dmd partial/helper label Aug 27, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
template Requires a change to a dmd partial/helper
Development

No branches or pull requests

2 participants