Open masteinhauser opened 12 years ago
I vote for this. And also dox
doesn't support html anymore??? Not sure, but at the same time, there's jsdoc
and it seems working well. What I did is:
find lib -name '*.js' -type f | xargs jsdoc
@beatak work!
Question: Would be possible to add the generated documentation directly to this repository?
Hello, where i can find the documentation about this library?
I also have the question: I just generate the file documentation.json
using the command jake doc && open documentation.html
. Why not add the documentation directly to this repository?
Oh please, give us the documentation like. The whole Jake project in Github gives 404 :p
dox doesn't support html anymore???
Apparently not... this is a bit of a problem. Not sure how to get documentation.json
in a human-readable way...
I have just tried out jsdoc-to-markdown with this repository and got something sensible.
To replicate:
npm i jsdoc-to-markdown
"scripts": { "doc": "jsdoc2md lib/deps/graph.js > doc.md" }
to the package.json
npm run doc
🤷 doc.md
file in something that can display markdown in a pretty way 😅 It's at least something 😉
How about removing dox
and using jsdoc-to-markdown
? A generated API.md
could be included in the repository.
I ended up using jsdoc and it's pretty usable (it also knows to pull in the readme.md for its index which is nice).
$ npm install -g jsdoc
$ jsdoc -r *
This might be just an issue I have come across, but it appears that
dox
no longer supports generating documentation from a list of files or directories but instead operates only overstdio
. I'm working on fixingJakefile.js
to use dox properly, but if you know why this doesn't build I would be greatly appreciative!