IDLdoc releases

IDL Workbench

IDLdoc can be installed and updated via the IDL Workbench.

Note: there are potential problems receiving IDLdoc updates or transitioning IDLdoc to a new version of IDL when using this method.

IDLdoc 3.2

  • Added ability to create LaTeX output. Use the TEMPLATE_PREFIX keyword to the IDLDOC command to specify that the LaTeX templates should be used and the COMMENT_STYLE keyword to specify that markup in comments in the source code should be converted to LaTeX in the output:

    idldoc, ..., template_prefix='latex-', comment_style='latex'

  • Added ability to create documentation for DLM files. IDLdoc will automatically find .dlm files in the ROOT subdirectories and create documentation for them. No special comments in the .dlm file are necessary (or used).

  • Added INDEX_LEVEL keyword to IDLDOC command to control the granularity of the index: 0 for no index; 1 for directories, classes, files, and routines; 2 for level 1 items plus parameters, keywords, fields, properties, and sav file variables

  • Adds links to names of routines and classes found in the Uses section for routines and files.

  • Added color output in the output log for errors and warnings if the COLOR_OUTPUTLOG keyword is set or if the MG_TERMISTTY routine is present and returns true.

  • Miscellaneous small bug fixes.

IDLdoc 3.1.1

IDLdoc 3.1.1 fixes a bug with losing the name of methods.

IDLdoc 3.1

IDLdoc 3.1 provides some rst markup features to provide compatibility with an upcoming IDL Workbench udpate.

  • Added ability to reference images in rst markup. IDLdoc will automatically copy referenced images into the output.
  • In rst markup, illegal characters like < and > are automatically converted to character entities.
  • Added :Description: tag for compatibility with IDL Workbench update.
  • Changed default markup parser to rst when format parser is rst.
  • Miscellaneous small bug fixes.

IDLdoc 3.0.2

IDLdoc 3.0.2 fixed some minor bugs.

IDLdoc 3.0.1

IDLdoc 3.0.1 was a minor update to IDLdoc to allow IDLdoc to be updated via the IDL Workbench.

  • Fixed a bug where a property tag in a file comment followed by a regular routine (not a method) caused a crash.
  • Fixed typos and made some additions to the help.

IDLdoc 3.0

There are many changes in IDLdoc 3.0.

  • IDLdoc 3.0 is completely rewritten from scratch. It is released under a BSD-style open source license (see COPYING file for legal details). Feel free to make modifications to the source code. If you add something cool that you think others would be interested, please send me a patch!

  • Comments inside ;+/;- that are not immediately before or after a routine header are considered file level comments. (The file_comments tag is still used, but is no longer needed.) There are also file-level tags now; any routine level tag that is reasonable on the file-level is allowed (i.e. most anything except params, keywords, and returns).

  • Routine comments can be immediately before or after the routine header.

  • Comments can now contain basic restructured text markup. Separating lines of text with a blank line will create separate paragraphs. Ending a line with two colons (::) and then indenting will format the indented section like a block of code.

  • It is now feasible to create your own library of templates for output. The TEMPLATE_PREFIX keyword specifies a prefix before the template names. The TEMPLATE_LOCATION keyword specifies a directory for the templates to use. The easiest way to get started with this is to copy the provided templates to a new location, specify that location with the TEMPLATE_LOCATION keyword, and start modifying those templates.

    Also the COMMENT_STYLE keyword specifies a classname of the class to handle outputting other types of comments besides HTML (i.e. LaTeX, rst, etc.).

  • The style of the documentation can be changed with the FORMAT_STYLE and MARKUP_STYLE keywords for an IDLdoc run. These styles can also be changed on a file-by-file basis with a docformat comment on the first line of the file like:

    ; docformat = 'rst'

    Available with IDLdoc 3.0 are the default IDLdoc style, the IDL standard template, and a new restructured text based style.

  • Uses "requires" tag on routines to find the highest version of IDL required by a project. Simply put the IDL version required as the first match to the regular expression:

    [[:digit].]+

    IDLdoc will automatically find it and compare it to other versions required. The warnings page will display the highest version required and list all the routines that require that version.

  • The source link is always available (in IDLdoc 2.0 it was only active if the OUTPUT keyword was not used). There is a NOSOURCE keyword to explicitly not show source code if that is required. Copying the source code or linking to it is controlled by the SOURCE_LINK keyword.

  • Ability to generate output for the IDL Assistant has not been reimplemented since IDL has a new help system in IDL 7.0. For now, only HTML designed for a normal browser is provided with IDLdoc (though with the TEMPLATE_* keywords, users could now do these customizations themselves).

  • IDLdoc 3.0 requires IDL 6.2. IDLdoc runs on all platforms supported by IDL.

Attachments