search

wkeese / old-api-viewer

Old viewer for output of old js-doc-parse, replaced by https://github.com/dojo/dapi
22 stars 10 forks source link

kwargs return types not expanded #33

Closed wkeese closed 12 years ago

wkeese commented 12 years ago

See for example dojo/_base/declare. The return type is just listed as DeclareCreatedObject, rather than listing the properties inside of DeclareCreatedObject.

wkeese commented 12 years ago

The alternative to fixing this is to make all types (ex: __IOArgs) available as exports from a module, and then specifying them as a MID+property combo, ex: dojo/_base/xhr.__IOArgs. Then the API viewer can handle it, and doc-parse doesn't need to do anything.

I did that for declare() in http://bugs.dojotoolkit.org/changeset/29365/dojo.

Since that's at the least a workaround, I'll mark this for consideration for future. Should either fix it in the future, or just make a policy that all return types need to be specified via MID+property.

wkeese commented 12 years ago

OK, for now the policy is that all types need to be specified as full MID's.