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

@param Support Anchors in Collection of @typedef Types #23

Open
mjhasbach opened this issue Aug 23, 2015 · 1 comment
Open

@param Support Anchors in Collection of @typedef Types #23

mjhasbach opened this issue Aug 23, 2015 · 1 comment

Comments

@mjhasbach
Copy link

Given a typedef:

/**
 * Playback position expressed in bars:quarters:sixteenths format (e.g. `"1:2:0"`)
 * @typedef {string} transportTime
 * @global
 */

When that type is used in a param:

@param {transportTime} [opt.time=0:0:0] - The [transportTime]{@link transportTime} at which playback will begin

dmd will create an anchor for the type:

| [opt.time] | <code>[transportTime](#transportTime)</code> | <code>0:0:0</code> | The [transportTime](#transportTime) at which playback will begin |

That nifty feature is not supported for collections:

@param {Array.<Array<transportTime, note, noteDuration>>} [opt.noteData=[]] - See the typedefs for [transportTime]{@link transportTime}, [note]{@link note}, and [noteDuration]{@link noteDuration}
| [opt.noteData] | <code>Array.&lt;Array.&lt;transportTime, note, noteDuration&gt;&gt;</code> | <code>[]</code> | See the typedefs for [transportTime](#transportTime), [note](#note), and [noteDuration](#noteDuration) |

Example

@75lb
Copy link
Member

75lb commented Dec 6, 2015

confirmed, thanks.. sorry i took so long..

@75lb 75lb added the bug label Dec 6, 2015
@75lb 75lb modified the milestone: v2.0.0 Dec 6, 2015
@75lb 75lb removed this from the v2.0.0 milestone Jan 9, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Development

No branches or pull requests

2 participants