Skip to content

pbitzer/idldoc

 
 

Repository files navigation

IDLdoc

IDLdoc generates nicely formatted API documentation directly from IDL source code. If the documentation is kept close to the code itself is much more likely to be kept up-to-date. As much as possible the documentation produced by IDLdoc is generated directly from the source code, making IDLdoc useful even if there are no specially formatted comments at all in the source code.

References

See the Reference guide and Tutorial in the docs/ directory.

See INSTALL.rst for more information about installing IDLdoc.

See RELEASE.rst for the release notes for this, and past, versions of IDLdoc.

For more information about converting a library from using IDLdoc 2.0 to IDLdoc 3.0, see ISSUES.rst.

About

Documenting IDL code

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 88.7%
  • IDL 10.5%
  • Other 0.8%