Documenting IDL code
JavaScript IDL HTML TeX Prolog CSS Other
Latest commit 19a93c8 Mar 9, 2016 @mgalloy Set TEMPLATE_PREFIX based on COMMENT_STYLE
If TEMPLATE_PREFIX is not explicitly set, then it is set to "latex-" or "docbook-" for COMMENT_STYLE of "latex" or "docbook". The empty prefix is for "html" output. "rst" and "plain" currently do not have templates, so their output is sent to HTML output.
Permalink
Failed to load latest commit information.
docs Fix comment style options in docs Mar 9, 2016
experiments Updated prompt hiding experiment, this is how it is implemented in ID… May 16, 2012
large_tests Removing extra idldoc/ directory level. Feb 26, 2010
lib @ 29dedf8 Create call graph in .dot file format Dec 9, 2015
project Removing todo's, they should be in Trac. Sep 14, 2011
regression_tests Changed name of gpufix.pro. Sep 11, 2014
src Set TEMPLATE_PREFIX based on COMMENT_STYLE Mar 9, 2016
unit_tests Removing extra idldoc/ directory level. Feb 26, 2010
.gitattributes Syntax. Jun 23, 2015
.gitignore Fixing ignores for IDL Workbench project files. Oct 25, 2012
.gitmodules Using SSH instead https. Jan 25, 2013
COPYING.rst Moving COPYING, INSTALL, etc. to .rst extensions. Fixing whitespace i… Oct 22, 2012
CREDITS.rst Adding credit to pbitzer for HTML directive. May 17, 2014
INSTALL.rst Typo. Jul 17, 2014
ISSUES.rst Moving COPYING, INSTALL, etc. to .rst extensions. Fixing whitespace i… Oct 22, 2012
Makefile Fix contributed by Dave Gellman for image directive with image file s… Dec 30, 2014
README.rst Typo. Jul 17, 2014
RELEASE.rst Fixed crash when invalid format/markup was specified on a docformat l… Mar 19, 2015
footer Removing extra idldoc/ directory level. Feb 26, 2010
idldoc_build.pro Fixing whitespace issues. Jan 21, 2013
idldoc_build_book.pro Fixing whitespace issues. Jan 21, 2013
idldoc_build_docs.pro Fixing whitespace issues. Jan 21, 2013
idldoc_build_updates_site.pro Fixing whitespace issues. Jan 21, 2013
idldoc_compile_all.pro Releasing 3.6.1 that fixes path issue for compiling mglib routines in… Jun 11, 2014
init.sh Adding initializing and pulling scripts. Sep 9, 2013
make_branch.sh Adding scripts to make tag/branches for release. Jun 10, 2014
make_tag.sh Adding scripts to make tag/branches for release. Jun 10, 2014
overview Using nicer PROFILER output routine. Sep 14, 2011
pull.sh Pulling from origin master. Sep 9, 2013

README.rst

What is 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.

Installing from an official release

The easiest way to get IDLdoc is to use an official release:

  1. Download the release from the Releases page of the wiki.
  1. Modify your !path to make sure the idldoc.sav file is found. There are various techniques to make this change, i.e., changing the IDL_PATH environment variable, changing the IDL_PATH preference, through the preferences in the IDL Workbench, etc.

Installing from GitHub

It is easy to install IDLdoc directly from the GitHub repo:

  1. Get the git repo and its submodules with:

    $ git clone --recursive git@github.com:mgalloy/idldoc.git
    
  2. Put the src and lib directories and their subdirectories into your IDL !path in your favorite manner.

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.