apify icon indicating copy to clipboard operation
apify copied to clipboard

Add displaying of exports

Open redmunds opened this issue 10 years ago • 2 comments

The list of exports for modules don't seem to be part of the API format. Seems like this is prominent enough to have it's own section with a link in API bar at top (with "Dependencies", "Variables", "Functions", "Classes").

Actually, they are displayed in the "Code" section of the last function in the file. For example, in Menus.js go to "Functions" section, then registerContextMenu click on "Show Code" and you'll see the list of exports at the end of the code.

Maybe we need an @export syntax for this

redmunds avatar May 29 '14 15:05 redmunds

@redmunds, we are already gathering the exports inside RequireProcessor.js, and it's available to the template in the module.exports variable.

It would be just a matter of deciding where and how to show it... do you have anything in mind? Maybe @larz0 could help us here...

jbalsas avatar Jun 08 '14 15:06 jbalsas

Add an Exports section to end of document. It would be a simple list -- there aren't any inner tags like @type, right? Would be nice to have a link to function in document.

redmunds avatar Jun 08 '14 19:06 redmunds