Silent problem while generating JsDoc

[rudyrigot]

When you go:

npm install jsdoc
./node_modules/.bin/jsdoc dist/prismic.io.js

the result in the out/ folder is all blank pages:

Next step is including it as a Grunt task, but that will be easy enough, once this issue is solved. So, if somebody who knows JsDoc better than I do can have a look at it, that will definitely save me a lot of time; otherwise, I can investigate further myself.

[geelen]

This problem is now affecting the link on the Readme: http://prismicio.github.io/javascript-kit/

Is that the only public list of the JS methods available?

[rudyrigot]

Hey Glen, I've short-term-solved the issue for you so you can use it for your project.

This is messy though, and the procedure to generate it is not optimal, so I'll need to get back on it to come with a better way to do it. If you wish to help out and look at it with me, any help is welcome.

For further reference:

• the generation issue comes from the fact it's all declared as inner variables of a function that is executed as the JS file is loaded; for now, I was able to generate the doc by deleting the first and last line of fragments.js and api.js just before generating the doc.
• it was initially even messier than this, but I took the time to set classes and functions apart for now; but this needs a better organization (fragments together, etc.)
• a solution for our generation issue may be in this StackOverflow thread. If it's not, I'm positive we're not the same JS library with the same issue, as this is a pretty common way to declare a JS library.

[rudyrigot]

So, I finally found a way to make it work for good! There is a workaround, since I couldn't figure out a way to group classes into a module with the syntax we're using; but the way I've done it is very readable, and no meaningful bit of code is undocumented now.

[geelen]

Success! Thanks for that.

[rudyrigot]

My pleasure! :)