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

nested modules with angular-jsdoc

Open WillBDaniels opened this issue 8 years ago • 1 comments

I've been trying to figure out how I would go about creating nested modules with angular-jsdoc, but I'm coming up a bit dry. For example, a file structure like so:

app-module.js -- ###########| ###########|----app-submodule-module.js ###########|##############| ###########| ##############|--app-submodule-config.js ###########| ###########|---app-submodule2-module.js

(pardon the #'s, I'm not sure how to make a nice file tree in markdown comments) etc. etc. how would I represent such a hierarchy? I've tried having app.js have the following for docs: ` /**

  • @ngdoc module
  • @name app

**/ `

And then the submodules be: ` /**

  • @ngdoc module
  • @name app.submodule
  • @memberof app **/

but it creates a structure as you can see in the following image:

github_image

Any help would be hugely appreciated! And just to be extra clear, I'm curious if there is a way to do multiple-nested items (a la: a 'tree' structure for the documentation)

WillBDaniels avatar Jan 10 '17 23:01 WillBDaniels

+1 I am also looking for a way to do this for a project I am working on

RobAWarner avatar Feb 27 '17 11:02 RobAWarner