Skip to content
This repository has been archived by the owner on Dec 31, 2017. It is now read-only.

inline expansion of union types with kwargs doesn't work #65

Open
wkeese opened this issue Jul 19, 2012 · 2 comments
Open

inline expansion of union types with kwargs doesn't work #65

wkeese opened this issue Jul 19, 2012 · 2 comments
Milestone

Comments

@wkeese
Copy link
Collaborator

wkeese commented Jul 19, 2012

See for example dijit/place.js, which does:

around: function(
    ...
    /*DomNode|place.__Rectangle*/ anchor,
    ...
){

anchor is either DomNode or a dijit/place.__Rectangle, and it should list the properties of __Rectangle in the API doc either as a nested table or a bullet list (js-doc-parse is in charge of the former).

I tried some defining a local variable called __Rectangle:

/*DomNode|__Rectangle*/ anchor,

but that didn't work either.

@wkeese
Copy link
Collaborator Author

wkeese commented Jul 22, 2012

The workaround is to specify the type as a MID+property, like this:

/*DomNode|dijit/place.__Rectangle*/ anchor,

Then it turns into a hyperlink to a separate page w/the definition for that type.

I did the workaround, so this isn't critical.

@neonstalwart
Copy link

e8d05e3 in #80 would fix this. #82 has an explanation.

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

No branches or pull requests

2 participants