Automatic generation of documentation for unauthorized JavaScript
I have been provided with a JavaScript project for support. If it was C or C ++, I would run it through DoxyGen and get decent docs, even if there were no DoxyGen comments in the code. This helps give me an overview for the project before I dive into serious code analysis.
I can't get DoxyGen to generate anything for the JS and the links on the official webpage don't work.
How do I get DoxyGen to work with (uncommented) JS code?
source to share
ashamed of broken links. I found this one to help you, and fooobar.com/questions/286109 / ... question about it.
The js2dox perl script basically converts your js code (with comments) to pseudo C ++ code that is properly formatted for doxygen to work. You will need to add some special comment tags in js in order to include parameters, return codes and types correctly. These are special tags \ tparam, \ treturn and \ type - they are not valid doxygen tags, but will be converted to the correct parts of C ++ code.
The js2dox.pl script can be found in the jsunit assembly. I'm not sure why it is not part of the doxygen site!
source to share