<<prev file | next file >>    view single page | view frames    summary: fields | routine    details: routine

Utilities/

xhelp.pro

Display an IDL procedure header using widgets and the widget manager.

topxhelp Widget

xhelp, filename, _extra=_extra

Parameters

filename        in required

A scalar string that contains the filename of the file to display. If FILENAME does not include a complete path specification, xhelp will search for the file in the current working directory and then each of the directories listed in !PATH environment variable. The ".pro" file suffix will be appended if it is not supplied.

Keywords

_extra       

used to pass your keywords

Examples

Open a file and create a widget to display its contents.

Version history

Version

$Id: xhelp.pro 157 2006-08-21 09:01:50Z navarro $

History

Written By Steve Richards, December 1990 Graceful error recovery, DMS, Feb, 1992. Modified to extract .pro documentation headers, PJR/ESRG mar94 Paul Ricchiazzi jun93 Institute for Computational Earth System Science University of California, Santa Barbara 7/1/99 : legeres mofification par Sebastien Masson : utilisation de xdisplayfile, de findfile et de _extra. 6/7/1999: compatibility mac and windows

Known issues

Restrictions

Triggers the XMANAGER if it is not already in use.

Statistics

McCabe cyclic 16
McCabe essential 1
McCabe modular design 1
Produced by IDLdoc 2.0.