railway-jsdoc-generator icon indicating copy to clipboard operation
railway-jsdoc-generator copied to clipboard

no class for my project??

Open tyt2y3 opened this issue 12 years ago • 1 comments

Classes: 0, packages: 0, methods: 0, lines: 0 no nothing, http://jsdoc.info/tyt2y3/F.core/ your help is appreciated!

tyt2y3 avatar Oct 13 '12 22:10 tyt2y3

Doc generator looks for code inside ./lib directory (and all nested). You can try it offline using 'makedoc' commandline tool:

$ makedoc lib/*.js

Currenly there's only way to get proper docs - properly structurize your app (put your code inside ./lib directory). But I think in future releases it makes sense to have some kind of configuration file in root dir of your project. Something like

.makedoc.yml:

title: My awesome project
pattern: ./*.js ./app/*/*.js

1602 avatar Oct 13 '12 22:10 1602