wrong display of split module

[nenaraab]

Hi,

we have a module which loads another file. In both files we have objects we want to document. It should be documented as one module. So we set "@module mymodule" in both files. The generated documentation looks fine in general but is displays the

twice at one page. They only differ in the module source.

Tested with 3.3.0-dev and 3.2.1.

Thanks a lot for your support,
Nena & Christoph

[hegemonic]

This would be useful! Right now, though, it's not possible to split a module's documentation across two files. The best alternative is to document one of the files normally, then use the @name tag to create "virtual doclets" for the members that are defined in the other source file.

For example, if you have a module called my/module that's defined in both my/module.js and my/module_extras.js, you could document my/module.js like so:

/** @module my/module */

/** @class */
exports.MyClass = function() {};

// defined in my/module_extras.js
/**
 * @class
 * @name MyOtherClass
 * @memberof module:my/module
 */

I'll file a ticket for this feature request in the jsdoc3/jsdoc project, which is the right place for JSDoc bugs and feature requests. (This project is used for the documentation.)

[nenaraab]

Hi Jeff,
thanks a lot for your quick and great support!!!
Got it working with the help of your example.

Kind regards,
Nena
From: Jeff Williams [mailto:notifications@github.com]
Sent: Dienstag, 5. November 2013 17:15
To: jsdoc3/jsdoc3.github.com
Cc: Raab, Nena
Subject: Re: [jsdoc3.github.com] wrong display of split module (#44)
Importance: Low

This would be useful! Right now, though, it's not possible to split a module's documentation across two files. The best alternative is to document one of the files normally, then use the @name tag to create "virtual doclets" for the members that are defined in the other source file.

For example, if you have a module called my/module that's defined in both my/module.js and my/module_extras.js, you could document my/module.js like so:

/** @module my/module */

/** @Class */

exports.MyClass = function() {};

// defined in my/module_extras.js

/**

• @Class

• @name MyOtherClass

• @memberof module:my/module

  */

I'll file a ticket for this feature request in the jsdoc3/jsdoc project, which is the right place for JSDoc bugs and feature requests. (This project is used for the documentation.)

—
Reply to this email directly or view it on GitHubhttps://github.com//issues/44#issuecomment-27786513.