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

can't set summary/description for a module using exports #42

Open
wkeese opened this issue Jun 17, 2012 · 2 comments
Open

can't set summary/description for a module using exports #42

wkeese opened this issue Jun 17, 2012 · 2 comments

Comments

@wkeese
Copy link
Collaborator

wkeese commented Jun 17, 2012

It's near-impossible to setup a summary/description for modules using "exports". For example see dojo/dom-attr.js.

I tried to hack it with by adding this to the end of the file, but it didn't work:

/*=====
var ret = {
    // summary:
    //      This module defines the core dojo DOM attributes API.
};
lang.mixin(ret, exports);
return ret;
=====*/

See also http://bugs.dojotoolkit.org/ticket/13769#comment:40, it's not trivial to remove the use of exports.

@csnover
Copy link
Owner

csnover commented Jun 21, 2012

Do you have any thoughts on the way this should be handled? It seems impossible with dojodoc. jsdoc could handle it just fine but we have no processor for that yet.

@wkeese
Copy link
Collaborator Author

wkeese commented Jun 21, 2012

I had one suggestion above but it's kind of yucky because the module is both using exports and returning a value.

This seems like a similar problem to NodeList-fx.js etc., where we need a summary/description on the module itself, which overrides whatever summary/description is attached to the return value.

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