jaguarjs-jsdoc icon indicating copy to clipboard operation
jaguarjs-jsdoc copied to clipboard

@module tag does not appear in documentation

Open klyngbaek opened this issue 11 years ago • 5 comments

If I have a CommonJS style module exporting different methods, it does not appear in the compiled documentation if I use the @module tag along with @function tags for each method.

klyngbaek avatar Sep 16 '14 23:09 klyngbaek

The same here. It's worth noticing that the default template handle such case correctly.

malps13 avatar Oct 21 '14 18:10 malps13

Yup, noticed this too. @module tag handling is needed for creating CommonJS documentation.

jmullo avatar Oct 27 '14 15:10 jmullo

seems like the documents do get generated but they are not added in the menu on the left side.

DJWassink avatar Feb 03 '15 15:02 DJWassink

I have followed the instructions found here: http://usejsdoc.org/howto-commonjs-modules.html#values-assigned-to-module-exports- and module html was generated, but a link to it is not included in the index.html. Also, the search list on index.html does not include any of the exported symbols from the module.

xorcus avatar Aug 17 '15 20:08 xorcus

I'm also experiencing this. +1 for anybody who finds a fix!

sabrehagen avatar Oct 31 '15 00:10 sabrehagen