This project will no longer be maintained by Intel. This project has been identified as having known security escapes. Intel has ceased development and contributions including, but not limited to, maintenance, bug fixes, new releases, or updates, to this project. Intel no longer accepts patches to this project.
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