Skip to content
This repository was archived by the owner on Jan 3, 2023. It is now read-only.

Doxgen to Javascript Documentation (not jsdoc). It's a documentation generation tool to support C codes that are auto-translated to JavaScript using SWIG.

License

MIT, MIT licenses found

Licenses found

MIT
LICENSE
MIT
COPYING
Notifications You must be signed in to change notification settings

intel-iot-devkit/doxygen2jsdoc

Repository files navigation

doxygen2jsdoc

Build Status

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). It's a documentation generation tool to support C codes that are auto-translated to JavaScript using SWIG.

Resources

License

MIT, MIT licenses found

Licenses found

MIT
LICENSE
MIT
COPYING

Security policy

Stars

Watchers

Forks

Packages

No packages published