<<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 type: scalar string

the name of the file to display. FILENAME should be located in !path. ".pro" suffix will be appended if needed.

Keywords

_EXTRA       

Used to pass keywords to xdisplayfile

Examples

IDL> xhelp,'plt'

Version history

Version

$Id: xhelp.pro 242 2007-04-06 08:35:17Z pinsard $

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 8
McCabe essential 1
McCabe modular design 1
Produced by IDLdoc 2.0.