Open kmiklas opened 11 years ago
I was just trying dox-template and got the exact same situation (with my own lib though). Original dox output seems correct but template comes up empty (only header line and search box).
Any ideas?
Just noticed this was already raised (and closed) on previous tickets. Check #1 for the solution that worked for me.
Quoting @olivernn :
The reason that you aren't seeing anything in the html is because dox template is fairly opinionated about the input it is expecting. It expects your code to be grouped into modules, which are defined with a custom tag of
@module
. An example, from Davis.js, is https://github.com/olivernn/davis.js/blob/master/lib/davis.logger.js. This is a module that is similar to your example in that it is really just a function.
Hi,
I ran Dox on dox.js, which generated the JSON object below.
I then applied dox-template. As I'm stuck in a Windows environment running PowerShell which does not support the "<" redirect, I had to modify the shell command a bit, as follows: cat ./dox.json | ./node_modules/.bin/dox-template -r 0.1.1 > dox.1.html
The resulting HTML file--also below--contains only a horizontal line, followed by the title of "Dox Template v0.1.1," and a search input. the rest of the page is blank.
In addition, why is there not a set of tags created in the resulting documentation page? In other words, why does the documentation begin with
?tyvm ~Keith :^)