[idldoc] IDLdoc 3.3
Michael Galloy
mgalloy at txcorp.com
Wed Oct 20 09:52:04 PDT 2010
I just released IDLdoc 3.3. See release notes below for new features, download from:
http://idldoc.idldev.com/wiki/Downloads
The biggest feature of this release may not be anything in the actual code of IDLdoc, but tutorial and reference manuals released in the docs/ directory of the distribution.
Mike
--
michaelgalloy.com
Release notes
-------------
* Created tutorial and reference manual documentation.
* Added embed directive to embed SVG or other graphics formats. For the
"latex" comment style, .svg will be replaced with .pdf.
* Directory overview comments can be picked up from a .idldoc file in each
directory. Tags include private and hidden to control the level of
visibility of the directory and its contents, as well as author, copyright,
and history.
* Added ROUTINE_LINE_CUTOFFS keyword to control level of warning for number of
lines in a routine (only used when STATISTICS is set). Set
ROUTINE_LINE_CUTOFFS to a two-element array indicating the number of lines
that needs to be exceeded before the routine has a warning or is flagged.
* McCabe complexity computed for each routine when STATISTICS set. Added
COMPLEXITY_CUTOFFS keyword to control level of warning for complexity. Set
COMPLEXITY_CUTOFFS to a two-element array indicating the complexity that
needs to be exceeded before the routine has a warning or is flagged.
* Added a link in each routine's details to its source code.
* Improved rst markup style. Headings can be created by underlining with "="
(for level 1 headings), "-" (level 2), or "~" (level 3). Links can be done
explicitly via `my website <michaelgalloy.com>` or looked up in the scope
of the comment's context, like `my_routine`. Added title directive so that
.idldoc files can have a separate title to be display (instead of just their
filename).
* Added a preformatted markup style which is nearly equivalent to verbatim,
but also makes HTML output respect line-breaks.
* Added author, copyright, history, and version tags to the overview file
* Allow properties of a class to be marked as hidden or private in rst format.
* Small changes to ensure compatible with IDL 8.0.
* Miscellaneous bug fixes.
More information about the idldoc
mailing list