Skip to content

arfoll/doxygen2jsdoc

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

5 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

C to JavaScript auto documentation generation tool to support C codes that are auto-translated to JavaScript using SWIG.

Parses the XML format of the original Doxygen C comments, along with some optional supporting metadata, to an intermediate JavaScript JSON format (documented at the top of xml2js.js), that is then used to generate various JavaScript metadata formats to feed into the corresponding JavaScript documentation generation tools. Currently generated JavaScript formats are dummy header files for YuiDoc, and JSON for TernJS (and dummy header files for JSDoc, but this is not well supported).

To use: node docgen <options>

To get a list of available options: node docgen -h

Currently used by MRAA and UPM.

About

Doxgen to Javascript Documentation (not jsdoc)

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Handlebars 41.7%
  • JavaScript 41.4%
  • CSS 16.9%