Log In | Users | Register
Edit | Attach | New | Raw | Diff | Print | | Tools
You are here: Data » IDLDocumentation

Documenting IDL routines using standard headers.

IDL routines can be documented by standard documentation headers. These documentation headers of the .pro files in question must have the following format:

  • The first line of the documentation block contains only the characters ;+, starting in column 1.
  • The last line of the documentation block contains only the characters ;-, starting in column 1.
  • All other lines in the documentation block contain a ; in column 1.

The file template.pro in the examples (or examples/general) subdirectory of the IDL distribution contains a template for creating your own documentation headers.

Several IDL routines make use of the standard headers:

  • The MK_HTML_HELP procedure generates a HTML file in containing documentation for those routines that contain standard IDL documentation headers.
  • The DOC_LIBRARY procedure extracts documentation headers from one or more IDL routines. This command provides a standard interface to the operating-system specific DL_DOS and DL_UNIX procedures.
  • The MAN procedure (By David Bresch and Dominik Brunner) prints the syntax of the desired function. man.pro
Attach
man.pro
man.pro (7.62K)
MAN procedure for IDL: prints the syntax of the desired function.
version 1 uploaded by ThierryCorti on 28 Oct 2010 - 14:57
spacer
This site is managed by the Center for Climate Systems Modeling (C2SM).
This site is powered by FoswikiCopyright © by the contributing authors. All material on this collaboration platform is the property of the contributing authors. Ideas, requests, problems? Send feedback!